Skip to main content
GET
Download a completed dashboard export
Stream the rendered file as an attachment, named dashboard.png / dashboard.pdf unless ?filename= supplies a different stem (the extension always follows the rendered format). Returns 409 while the job is still rendering — poll GET /dashboard-exports/{jobId} first — 422 if the render failed (terminal: submit a new export rather than retrying this one), and 404 once the job has expired or if it belongs to a different user.

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.

Query Parameters

filename
string

Filename stem for the attachment, without extension. Defaults to dashboard.

Response

The rendered dashboard.

The response is of type file.