OMomni
Dashboard downloads

Initiate dashboard or tile download

Changed on

Start an asynchronous download job for a published dashboard, a dashboard draft, 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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/dashboards/{dashboardId}/download
  • Auth
    HTTP bearer

Path parameters

dashboardIdstring required

The dashboard identifier (ID or document UUID). Accepts a published dashboard or one of its drafts.

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
XLSXYesYesFor tiles with subtotal or grand total rows, one dimension cell in each totals row is labeled Total
CSVYes (as ZIP)YesFor full dashboards, delivery will be a zip file containing one CSV per tile. For tiles with subtotal or grand total rows, one dimension cell in each totals row is labeled Total
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

containerPagesstring[]

Applicable to PDF, PNG, CSV, and XLSX formats, on dashboards using the advanced (multi-page) layout. The instanceKeys of the pages to render:

  • PDF renders the listed pages in storage order.
  • PNG accepts exactly one page.
  • CSV and XLSX keep only the tiles on the selected pages.

Not supported for json format, link_only, or together with queryIdentifierMapKey for a single-tile download. Defaults to the dashboard's first page for PDF and PNG, and to every tile for CSV and XLSX.

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.

expandAiSummariesboolean

Compatible with pdf and png formats. If true, AI summary tiles grow to show their full text, splitting across pages when paperFormat isn't fit_page.

With paperFormat: fit_page, the page grows instead, and the operation fails if the page would be taller than 60,000px.

expandTablesToShowAllRowsboolean

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

With paperFormat: fit_page, the page grows to fit the rows, and the download fails if the page would be taller than 60,000px.

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.

cache'Standard' | 'SkipRequery' | 'SkipCache'

Cache policy controlling how the download's queries use cached results. Must be one of:

  • Standard - Default. Standard caching behavior, including requerying cached result sets.
  • SkipRequery - Uses cached results if available, but does not requery cached result sets.
  • SkipCache - Bypasses the cache and always executes fresh queries.
useCacheboolean

Deprecated. Use cache: SkipCache for fresh data.

Response

Download initiated successfully

job_idstring uuid

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

messagestring

Success message

Changes

  • 43290040f88fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property