Poll report generation status
Retrieves the status or generated report data for asynchronous report generation requests. Report generation sessions expire 30 minutes after creation.
**Polling behavior:**
After calling the report generation endpoint, poll this endpoint periodically (recommended interval: 5–10 seconds) until you receive a terminal response.
Status values returned by the downstream service are **case-sensitive**.
**Continue polling when:**
- `status: "IN_PROGRESS"` — The report is still being generated. Continue polling after a short delay.
**Stop polling when:**
- The response contains `data.report_data` and **no `status` field** — The report is ready. Use `data.report_data` and `data.report_currency`.
- `status: "STATUS_NOT_FOUND"` — The `request_id` is invalid or expired. This can happen if the session expired (30 minutes after creation) or the report data was already retrieved.
- HTTP `400` — The `request_id` is missing, or no active session was found for the `request_id`.
- HTTP `403` — Your API key does not have Report Builder access.
- HTTP `500` — An internal error occurred. You may retry a few times, but if it persists, stop polling.
Headers
X-API-Key
Request
This endpoint expects an object.
request_id
Request identifier returned by the report generation endpoint
Response
Report status retrieved successfully
Report is still being generated — continue polling
OR
Request ID is invalid or expired — stop polling
OR
Report is ready — stop polling. No status field is present.
Errors
403
Forbidden Error
500
Internal Server Error