Sign in

v4

OpenAPI 3.1.02026-08-01207318738.7 KB
Dashboards

Initiate dashboard download

post/api/v1/dashboards/{identifier}/download

Path parameters

identifierstring required

Dashboard identifier (short ID or UUID)

Example:12db1a0a

Dashboard identifier (short ID or UUID)

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Target user membership ID (for org-scoped API keys)

Request body

enableFormattingboolean

Compatible with csv, xlsx & json formats. If true, formatting will be enabled in the output. Note: If true for json format, a queryIdentifierMapKey is required.

expandTablesToShowAllRowsboolean

Compatible with pdf and png formats. If true, up to 1,000 rows in table visualizations will be included in the delivery. Note: This parameter cannot be used when paperFormat: fit_page.

{"stackTrail":"components:schemas:DashboardsDownloadBody:properties:filterConfig","oasType":"schema","type":"unknown","description":"An object specifying the filter conditions to apply to the task. The filter key specified must already exist in the dashboard.","example":{"status":["active","pending"]}}
format'pdf' | 'png' | 'csv' | 'xlsx' | 'json' required

Output format for the download: pdf, png, csv, xlsx, or json

hideHiddenFieldsboolean

Compatible with csv & xlsx formats. If true, fields marked as hidden won't be displayed in the output.

hideTitleboolean

Compatible with pdf & png formats. If true, the content's title will be hidden in the output.

maxRowLimitnumber

Compatible with csv, json, & xlsx formats. Used with overrideRowLimit. Specifies the maximum number of rows.

overrideRowLimitboolean

Compatible with csv, json, & xlsx formats. If true, the default row limit will be overridden. Note: If true for json and xlsx formats, a queryIdentifierMapKey is required.

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

Compatible with pdf formats. Defines the paper format (size) of the resulting PDF. Must be one of: a3, a4, letter, legal, fit_page, tabloid.

paperOrientation'portrait' | 'landscape'

Compatible with pdf formats. Defines the paper orientation of the resulting PDF. Must be one of: portrait, landscape.

queryIdentifierMapKeystring

Required for single tile tasks. The ID of the query to include in a single tile task. Must reference a valid query in the dashboard.

showContentLinkboolean

Compatible with all formats except link_only. If true, a link to the content will be shown in the output.

showFiltersboolean

Compatible with all formats except link_only & csv. If true, filters will be shown in the output.

singleColumnLayoutboolean

Compatible with pdf and png formats. If true, dashboard tiles will be arranged into a single vertical column.

useCacheboolean

If true, allow scheduled queries to use cached results instead of always running fresh queries.

filenamestring

Custom filename for the downloaded file (without extension)

Example request

{
  "filterConfig": {
    "status": [
      "active",
      "pending"
    ]
  },
  "format": "pdf",
  "maxRowLimit": 1000,
  "paperFormat": "letter",
  "paperOrientation": "landscape",
  "queryIdentifierMapKey": "Jmn2r3KV",
  "showContentLink": true,
  "showFilters": true,
  "filename": "monthly-report"
}

Response

Download job initiated successfully

job_idstring uuid required

ID of the download job. Use this to poll for download status.

messagestring required

Status message

Example response

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Download initiated successfully"
}