Report Status API
Overview
The Report Status API returns the status of all reports by default. If a ReportId is included in the query, the API returns the status of the specified report.
Endpoint URL
GET https://<Reporting endpoint Base URL>/odata/ReportStatus
Sample Request
-
To view status of all the Async reports, execute the following query:
GET https://<Reporting endpoint Base URL>/odata/ReportStatusBesides the ReportStatus parameter, this API supports all the OData query options (See Supported OData query options). See an example below.GET https://<Reporting endpoint Base URL>/odata/ReportStatus?$Count=true&$Skip=100&$Top=200 -
To view status of a specific Async report, execute the following query:
GET https://<Reporting endpoint Base URL>/odata/ReportStatus?ReportId=a337e782-aa81-40fd-a65c-589b1bb6da55
Sample response
Status code: 200 OK
For single report ID:
For multiple report IDs:
Report statuses and description
| Status | Description |
|---|---|
| Queued | The report is currently queued for generation. |
| Processing | The report generation is currently in progress. |
| Ready | The report is generated and available for review and utilization. |
| RetryQueued | The report generation failed and has been queued for retry. |
| Failed | The report generation has failed even after retrying. |