Zum Hauptinhalt springen

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​

FieldTypeDescription
idID!Unique identifier
groupID!ID of the group the report was raised for
reportTypeReportTypeThe kind of report data
levelReportLevelGrain of each exported row: DOCUMENT, RECIPIENT or FIELD
formatReportFormatOutput file format: CSV or JSONL
executionStatusReportExecutionStatusPENDING, RUNNING, COMPLETED or FAILED
startAWSDateTimeStart of the reporting period
endAWSDateTimeEnd of the reporting period
locationStringStorage location of the generated file
linkAWSURLDownload link for the generated file
errorStringError detail when executionStatus is FAILED
requestedByStringWho requested the report
recordCountIntNumber of records in the exported file
createdAWSDateTimeWhen the report was requested
modifiedAWSDateTimeWhen 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
}
}
}

Export This Article

Save a copy of this page as PDF or plain text.