Report
A Report is a pre-built export of group data over a date range. Reports are generated asynchronously: requestReport creates the record with a PENDING status, and you poll the report query until executionStatus is COMPLETED or FAILED. Completed reports expose a download link.
Implements: Node
Fields
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier |
group | ID! | ID of the group the report was raised for |
reportType | ReportType | The kind of report data |
level | ReportLevel | Grain of each exported row: DOCUMENT, RECIPIENT or FIELD |
format | ReportFormat | Output file format: CSV or JSONL |
executionStatus | ReportExecutionStatus | PENDING, RUNNING, COMPLETED or FAILED |
start | AWSDateTime | Start of the reporting period |
end | AWSDateTime | End of the reporting period |
location | String | Storage location of the generated file |
link | AWSURL | Download link for the generated file |
error | String | Error detail when executionStatus is FAILED |
requestedBy | String | Who requested the report |
recordCount | Int | Number of records in the exported file |
created | AWSDateTime | When the report was requested |
modified | AWSDateTime | When the report record was last updated |
Query
Reports for a group are available through Group.reports (newest first), or individually through the report query.
query GetGroupReports($groupId: ID!) {
group(id: $groupId) {
reports {
id
level
format
executionStatus
start
end
recordCount
link
}
}
}
Related
- requestReport — raise a new report
- report — fetch a single report
- deleteReport — remove a report and its file
- Group