Skip to main content
POST
/
v1
/
dashboards
/
{dashboardId}
/
download
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/dashboards/{dashboardId}/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "pdf",
  "paperFormat": "letter",
  "paperOrientation": "landscape"
}
'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Download initiated successfully"
}
Starts an asynchronous download job for a dashboard or single tile. This API supports multiple output formats and provides an asynchronous workflow: initiate a download, poll for completion, then retrieve the file.

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 (ID or document UUID)

Body

application/json
​
format
enum<string>
required

Output format:

FormatFull dashboardSingle tileNotes
PDFYesYes
PNGYesYes
XLSXYesYes
CSVYes (as ZIP)YesFor full dashboards, delivery will be a zip file containing one CSV per tile
JSONNoYesOnly single tile is supported. Requires queryIdentifierMapKey to be specified
Available options:
pdf,
png,
csv,
xlsx,
json
​
filename
string

Custom filename for the downloaded file. Defaults to the dashboard name.

Maximum string length: 255
​
queryIdentifierMapKey
string

Tile identifier to download a single tile instead of the full dashboard

​
filterConfig
object

Dashboard filter values to apply before rendering

​
paperFormat
enum<string>
default:fit_page

Applicable to PDF and PNG formats. Page size.

Available options:
fit_page,
letter,
legal,
tabloid,
a3,
a4
​
paperOrientation
enum<string>

Applicable to PDF and PNG formats. Page orientation.

Available options:
portrait,
landscape
​
hideTitle
boolean
default:false

Applicable to PDF and PNG formats. If true, hide the dashboard title in the output.

​
showFilters
boolean
default:true

Applicable to PDF and PNG formats. If true, display applied filter values in the output.

​
expandTablesToShowAllRows
boolean

Applicable to PDF and PNG formats. If true, expand table tiles to display all rows.

​
singleColumnLayout
boolean

Applicable to PDF and PNG formats. If true, render tiles in a single column layout.

​
enableFormatting
boolean
default:false

Applicable to CSV, XLSX, and JSON formats. If true, apply number and date formatting to values.

​
hideHiddenFields
boolean
default:false

Applicable to CSV, XLSX, and JSON formats. If true, exclude hidden fields from the output.

​
overrideRowLimit
boolean
default:false

Applicable to CSV, XLSX, and JSON formats. If true, remove the default row limit.

​
maxRowLimit
integer

Applicable to CSV, XLSX, and JSON formats. Maximum number of rows to export.

Required range: 1 <= x <= 1000000

Response

Download initiated successfully

​
job_id
string<uuid>

The job ID to use for checking status and downloading the file

​
message
string

Success message