Leum gu prìomh susbaint

requestReport

API KeyOAuth

Request a new, asynchronously generated report for a group. Returns the created Report with its initial PENDING execution status. Poll the report query until executionStatus is COMPLETED, then download the file from link.

Input​

RequestReportInput!

Return Type​

Report

Example​

mutation RequestReport($groupId: ID!) {
requestReport(input: {
groupId: $groupId
level: DOCUMENT
format: CSV
start: "2026-10-01T00:00:00Z"
end: "2026-10-31T23:59:59Z"
}) {
id
executionStatus
}
}

Export This Article

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