Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Dashboard downloads

Check download status

get/v1/dashboards/{dashboardId}/download/{jobId}/status

Path parameters

dashboardIdstring required

The dashboard identifier. This must match the ID of the original download request.

jobIdstring uuid required

The job ID returned from the Initiate dashboard download endpoint

Response

Job status retrieved successfully

job_idstring uuid

The job ID

status'in_progress' | 'complete' | 'error'

Current status of the download job

format'pdf' | 'png' | 'csv' | 'xlsx' | 'json'

The requested output format

created_atstring date-time

When the job was created

errorstring

Error message. Only present when status is error.