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

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 400 before 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 403 before anything is written.
The response’s 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

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

Body

application/json
baseModelId
string<uuid>
required

Base model ID for the imported document

document
object
required

Document metadata from export. Also accepts a metadata.presentation object (dashboard presentation settings such as the control bar) to restore onto the new workbook.

exportVersion
enum<string>
required

Export format version (must be 0.1)

Available options:
0.1
queryModels
object
required

Query model definitions from export

colorPalettes
object

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
any

Dashboard configuration from export

fileUploads
object

Spreadsheet file data to restore during import. Include the fileUploads field from the export response to restore spreadsheet tiles in the imported dashboard.

folderPath
string

Destination folder path

identifier
string

Custom identifier for the imported document

workbookModel
any

Workbook model from export

Response

Document imported successfully

documentId
string<uuid>
required

ID of the imported document

identifier
string
required

Document identifier (miniUuid)

colorPalettes
object

Custom palettes the import created in this organization or matched by name and type