Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Dashboard downloads

Initiate dashboard or tile download

Start an asynchronous download job for a dashboard or single tile with support for multiple output formats. After starting a job, poll Check download status for completion, then retrieve the file from Download file.

<Note> Only one download per dashboard per user is allowed at a time. If a download is already in progress for the specified dashboard, the request will return a `409 Conflict` response with the existing job ID. </Note>
post/v1/dashboards/{dashboardId}/download

Path parameters

dashboardIdstring required

The dashboard identifier (ID or document UUID)

Query parameters

userIdstring

The user ID to run the download as. Only valid when authenticating with an organization API key. Use the List users or List embed users endpoints to retrieve user IDs.

Request body

format'pdf' | 'png' | 'csv' | 'xlsx' | 'json' 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.
filenamestring

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

queryIdentifierMapKeystring

Tile identifier to download a single tile instead of the full dashboard. Required for XLSX and JSON formats if overrideRowLimit=true.

filterConfigobject

Dashboard filter values to apply before rendering

paperFormat'fit_page' | 'letter' | 'legal' | 'tabloid' | 'a3' | 'a4'

Applicable to PDF and PNG formats. Page size.

paperOrientation'portrait' | 'landscape'

Applicable to PDF and PNG formats. Page orientation.

hideTitleboolean

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

showFiltersboolean

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

expandTablesToShowAllRowsboolean

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

singleColumnLayoutboolean

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

enableFormattingboolean

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

hideHiddenFieldsboolean

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

overrideRowLimitboolean

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

If true for XLSX and JSON formats, a queryIdentifierMapKey is required.

maxRowLimitinteger

Applicable to CSV, XLSX, and JSON formats. Maximum number of rows to export. Can be used with overrideRowLimit to export more rows than the default row limit.

Response

Download initiated successfully

job_idstring uuid

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

messagestring

Success message