Skip to main content
GET
Get the status of a dashboard export
Progress of a submitted render. Poll until status is completed (then download it) or failed (then read error); pending and processing both mean keep waiting. Returns 404 once the job has expired, and for a job submitted by a different user — a job is only ever visible to whoever started it.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Numeric id of the deployment that owns the dashboard.

jobId
string
required

Job id returned when the export was submitted.

Response

200 - application/json
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed
contentType
string | null

MIME type of the rendered file. Present once status is completed.

error
string | null

Why the render failed. Present only when status is failed.

progress
number | null

Rendering progress, 0-100, when the renderer reports one.