Skip to main content
GET
/
v1
/
dashboards
/
{dashboardId}
/
download
/
{jobId}
/
status
Check download status
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/dashboards/{dashboardId}/download/{jobId}/status \
  --header 'Authorization: Bearer <token>'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_progress",
  "format": "pdf",
  "created_at": "2024-01-15T10:30:00Z"
}
Retrieves the current status of a dashboard download job. Poll this endpoint to determine when the file is ready. The response will contain one of the following statuses:
StatusDescriptionNext Step
in_progressJob is still processingContinue polling
completeFile is readyCall the Download endpoint
errorJob failed - see error field for detailsReview error and retry if needed
We recommend the following when polling:
  • Use a reasonable polling interval (2-5 seconds)
  • Avoid polling more frequently than once per second

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
dashboardId
string
required

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

​
jobId
string<uuid>
required

The job ID returned from the Initiate dashboard download endpoint

Response

Job status retrieved successfully

​
job_id
string<uuid>

The job ID

​
status
enum<string>

Current status of the download job

Available options:
in_progress,
complete,
error
​
format
enum<string>

The requested output format

Available options:
pdf,
png,
csv,
xlsx,
json
​
created_at
string<date-time>

When the job was created

​
error
string

Error message. Only present when status is error.