OMomniapp
Dashboards

Initiate dashboard download

Changed on

The artifact includes cross-model tiles the download runs as (the target user when one is named, else the API key’s user); tiles on a model they cannot query are omitted, as are tiles with no layout entry (which the dashboard also does not display).

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/dashboards/{identifier}/download
  • Auth
    HTTP bearer

Path parameters

identifierstring required

A published dashboard's identifier, or one of its draft identifiers (short ID or UUID). A draft renders its unpublished content against the branch it was taken on.

Example:12db1a0a

Query parameters

userIdstring uuid

Target user ID (for org-scoped API keys)

Request body

containerPagesstring[]

Dashboard deliveries only. Compatible with pdf, png, csv & xlsx formats, on dashboards using the advanced layout. The instanceKeys of the pages to render, as returned in a page's "instanceKey". pdf renders each page in storage order; png accepts a single page; csv and xlsx include only the tiles on the selected pages. Defaults to the first page for pdf and png, and to every tile for csv and xlsx. Cannot be combined with queryIdentifierMapKey.

enableConditionalFormattingboolean

Compatible with xlsx format only. Defaults to true. When true, conditional formatting rules from the visualization are included in the Excel output — provided the organization has the 'excel-conditional-formatting' feature enabled.

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.

expandAiSummariesboolean

Compatible with pdf and png formats. If true, AI summary tiles grow to show their full text, splitting across pages when a paperFormat other than fit_page is set. With paperFormat: fit_page the page grows instead, and the render fails if the page would be taller than 60,000px.

expandTablesToShowAllRowsboolean

Compatible with pdf and png formats. If true, up to 1,000 rows in table visualizations will be included in the delivery. With paperFormat: fit_page the page grows to fit the rows, and the render fails if the page would be taller than 60,000px.

filterConfigunknown
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 and for workbook deliveries. The ID of the query to deliver. Must reference a valid query in the document.

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

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

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

Cache policy for the queries run by the download. Must be one of: Standard (standard caching behavior; default), SkipRequery (uses cached results if available, but does not requery), SkipCache (bypasses the cache and always executes fresh queries).

filenamestring

Custom filename for the downloaded file (without extension)

useCacheboolean

Deprecated and has no effect. Use cache instead.

Example request

{
  "containerPages": [
    "page_abc123"
  ],
  "enableConditionalFormatting": true,
  "filterConfig": {
    "status": [
      "active",
      "pending"
    ]
  },
  "format": "pdf",
  "maxRowLimit": 1000,
  "paperFormat": "letter",
  "paperOrientation": "landscape",
  "queryIdentifierMapKey": "Jmn2r3KV",
  "showContentLink": true,
  "showFilters": true,
  "cache": "SkipCache",
  "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"
}

Changes