Get Job Status

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 a URL to download and view the data. This means that it would not necessarily be required to then hit the Retrieve Report Download endpoint to view the data.

attribute

type

description

success

boolean

Response status

data

object

Job status and payload link for downloadable data if job complete

errors

array

Contains list of error objects which consists of:
message: Error message
code: Error code as described in Error codes

Language
Authentication
Header
Click Try It! to start a request and see the response here!