Check an async report
report_statusCheck an async report job by report_id (from report_request or report_list). Returns its status: PENDING or IN_PROGRESS (still generating — wait and check again), DONE, or FAILED.
When DONE, result_url is a download link for the result ZIP; hand it to the user. Links are time-limited — if one has expired, run report_status again for a fresh link. The server never downloads the file itself.
FAILED is terminal. Stop polling: it will never become DONE and there will be no result_url. Read the message field and relay it to the user — it is written for a person and explains the cause. Do not resubmit on your own: tell the user what failed and let them decide. If the message points at a parameter the user can correct, offer the corrected submission rather than making it silently.
A report going from IN_PROGRESS back to PENDING is an automatic retry, not a failure. Keep polling.
Failed reports are not charged, and polling is free — it never re-runs the report or deducts credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes | The report_id returned by report_request (or seen in report_list). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| message | Yes | ||
| report_id | Yes | ||
| created_at | Yes | ||
| result_url | Yes | ||
| updated_at | Yes | ||
| report_type | Yes |