Import dashboard
Import dashboard to Omni instance.
Color palettes
If the export references custom color palettes, Omni resolves each referenced palette against the destination organization by exact (trimmed) name and type:- Identical colors — The existing palette is reused.
- Different colors, or more than one palette sharing that name with none matching by color — The import fails with
400before anything is written. The error message names the palette. - No matching palette — Omni creates one. Creating a palette during import requires the caller to have Editor or Manager permissions; otherwise, the import fails with
403before anything is written.
colorPalettes field lists which referenced palettes were created versus reused.
If a UUID doesn’t resolve to an existing palette in the destination organization, it’s dropped and the chart falls back to the organization’s default palette.
Presentation settings
document also carries any metadata.presentation object from the export (dashboard-level presentation settings, including the control bar’s collapsible / defaultExpanded / fixed state), which Omni writes onto the new workbook. Feature flags and generated descriptions from the source instance are not imported.Authorizations
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
Body
Base model ID for the imported document
Document metadata from export. Also accepts a metadata.presentation object (dashboard presentation settings such as the control bar) to restore onto the new workbook.
Export format version (must be 0.1)
0.1 Query model definitions from export
Custom color palettes referenced by visualization configurations, keyed by export-local key. Include the colorPalettes field from the export response to carry custom palettes to the destination organization.
Dashboard configuration from export
Spreadsheet file data to restore during import. Include the fileUploads field from the export response to restore spreadsheet tiles in the imported dashboard.
Destination folder path
Custom identifier for the imported document
Workbook model from export

