Skip to main content
GET
Get a dashboard-submitted report job

Authorizations

Authorization
string
header
required

Customer session token returned by /auth/login. This is distinct from an API key.

Path Parameters

id
string
required

Response

Job status.

job_id
string
required

Asynchronous report job id.

Pattern: ^job_[a-f0-9]{24}$
report_type
string
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
credits
integer
required
created_at
string<date-time> | null
result
object

Present only when succeeded. Signed URLs expire; request a new report rather than storing the URL.

error
string

Safe error message, only when failed.

error_code
string

Machine-readable error class, only when failed.