Skip to main content
GET
Export dashboard
This API is in beta and may have future breaking changes.

Color palettes

Custom color palette references in the dashboard spec (_scheme, markColorScheme, and raw Vega scheme fields) are rewritten from organization-specific palette UUIDs to portable, export-local keys (for example, export-palette-0). The colorPalettes field in the response gives the name, type, and colors for each key, so the destination organization can match or recreate the palette on import. References to palettes that have since been deleted are not included in the export.

Authorizations

Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

dashboardId
string
required

Dashboard identifier (miniUuid or full UUID)

Response

Dashboard export data

colorPalettes
object
required

Custom color palettes referenced by the dashboard's visualization configuration, keyed by export-local key (for example, export-palette-0). References to deleted palettes are omitted.

document
object
required

Document metadata

exportVersion
string
required

Export format version

Example:

"0.1"

queryModels
object
required

Query model definitions referenced by the dashboard

dashboard
any

Dashboard configuration and layout

fileUploads
object

Spreadsheet file data included in the export. Each item contains the file content and metadata needed to restore spreadsheet tiles during import.

workbookModel
any

Workbook model data