AQL Entities¶
AQL supports querying the following Aha.io entities.
Core Entities¶
features¶
Product features and their details.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Feature ID |
reference_num |
string | Yes | Reference number (e.g., FEAT-123) |
name |
string | Yes | Feature name |
description |
string | No | Feature description (HTML) |
status |
string | Yes | Workflow status name |
workflow_status_id |
string | Yes | Workflow status ID |
created_at |
datetime | Yes | Creation timestamp |
updated_at |
datetime | Yes | Last update timestamp |
start_date |
date | Yes | Start date |
due_date |
date | Yes | Due date |
release_id |
string | Yes | Release ID |
assigned_to_user |
string | Yes | Assigned user |
tags |
array | No | Tags list |
Example:
ideas¶
Customer ideas and feedback.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Idea ID |
reference_num |
string | Yes | Reference number (e.g., IDEA-456) |
name |
string | Yes | Idea name |
description |
string | No | Idea description (HTML) |
status |
string | Yes | Workflow status name |
votes_count |
integer | Yes | Number of votes |
created_at |
datetime | Yes | Creation timestamp |
updated_at |
datetime | Yes | Last update timestamp |
tags |
array | No | Tags list |
Example:
releases¶
Product releases and milestones.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Release ID |
reference_num |
string | Yes | Reference number (e.g., REL-1) |
name |
string | Yes | Release name |
release_date |
date | Yes | Target release date |
released_on |
date | Yes | Actual release date |
created_at |
datetime | Yes | Creation timestamp |
product_id |
string | Yes | Parent product ID |
Example:
epics¶
Feature epics for grouping related features.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Epic ID |
reference_num |
string | Yes | Reference number |
name |
string | Yes | Epic name |
description |
string | No | Epic description |
created_at |
datetime | Yes | Creation timestamp |
product_id |
string | Yes | Parent product ID |
Example:
initiatives¶
Strategic initiatives.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Initiative ID |
reference_num |
string | Yes | Reference number |
name |
string | Yes | Initiative name |
description |
string | No | Initiative description |
created_at |
datetime | Yes | Creation timestamp |
Example:
goals¶
Product goals and OKRs.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Goal ID |
reference_num |
string | Yes | Reference number |
name |
string | Yes | Goal name |
description |
string | No | Goal description |
created_at |
datetime | Yes | Creation timestamp |
Example:
Supporting Entities¶
users¶
Workspace users.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | User ID |
name |
string | Yes | Full name |
email |
string | Yes | Email address |
role |
string | Yes | User role |
created_at |
datetime | Yes | Creation timestamp |
Example:
products¶
Products/workspaces.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Product ID |
reference_prefix |
string | Yes | Reference prefix (e.g., PROD) |
name |
string | Yes | Product name |
created_at |
datetime | Yes | Creation timestamp |
Example:
comments¶
Comments on entities.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Comment ID |
body |
string | No | Comment body (HTML) |
user_id |
string | Yes | Author user ID |
created_at |
datetime | Yes | Creation timestamp |
requirements¶
Feature requirements.
| Field | Type | Sortable | Description |
|---|---|---|---|
id |
string | Yes | Requirement ID |
name |
string | Yes | Requirement name |
description |
string | No | Description |
feature_id |
string | Yes | Parent feature ID |
tags¶
Entity tags (derived entity).
| Field | Type | Sortable | Description |
|---|---|---|---|
name |
string | Yes | Tag name |
feature_count |
integer | Yes | Count on features |
epic_count |
integer | Yes | Count on epics |
Example:
Custom Fields¶
Custom fields are accessible with the cf_ prefix: