Get Job Status

Get status for a job.

This endpoint is used to get the status of any report with a job ID. The possible values of status are "pending", "in progress", "failed" and "complete". If the status is complete, then the payload parameter will return parsed data as a payload. This means that it would not necessarily be required to then hit the Retrieve Report Download endpoint to view the data if the job status is already "complete" when hitting the Get Job Status endpoint.

successbooleanResponse status
dataobjectJob status and payload link for downloadable data or
parsed data if the job is complete
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Click Try It! to start a request and see the response here!