Async job status

Retrieves the status and result of an analytics job created when any supported analytics endpoint is called with async=true. Poll this endpoint until the job reaches a terminal state (DONE or FAILED).

The job status moves through the following states: PENDING while the job is running, DONE when the result is ready, and FAILED if the job could not be completed. Poll every few seconds until a terminal state is reached. Large Books may take longer to process.

When the status is DONE, the response includes a result_url, a temporary pre-signed download link to retrieve the analytics payload, which is identical in shape to the corresponding synchronous endpoint's response. The job and its result_url are valid for 24 hours from the time the job was created.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The job ID returned in the 202 response when the async request was submitted.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json