Check report status

See whether a report is still generating or ready. Poll this every few seconds after starting a report. Returns the status, and the report itself (result_summary) once it's complete. While a report is still running, a status call checks with the report generator at most once every 5 minutes, so the status can lag by up to 5 minutes if the completion callback was missed.

Prerequisites: a bearer token, the location's id (store_id) and the report's id (report_id): insight_report_id from Generate an insight report or Get the latest report.

Authentication: Partner or Account token. store_id must be inside your own account tree (a Partner token reaches any location under the partner, an Account token only its own), otherwise 422; and the report must belong to that location, otherwise 404.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3007

The location the report is for. Must exist and be inside your account tree.

integer
required
Defaults to 284

The report's id (insight_report_id). Must exist and belong to store_id.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json