> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Export dashboard

> Export dashboard for migration between Omni instances.




## OpenAPI

````yaml /api/openapi.yaml get /unstable/documents/{dashboardId}/export
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /unstable/documents/{dashboardId}/export:
    get:
      tags:
        - Content migration
      summary: Export dashboard
      description: |
        Export dashboard for migration between Omni instances.
      operationId: exportDashboard
      parameters:
        - name: dashboardId
          in: path
          required: true
          schema:
            type: string
          description: Dashboard identifier (miniUuid or full UUID)
          example: abc123
      responses:
        '200':
          description: Dashboard export data
          content:
            application/json:
              schema:
                type: object
                required:
                  - colorPalettes
                  - document
                  - exportVersion
                  - queryModels
                properties:
                  colorPalettes:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/ColorPaletteExport'
                    description: >-
                      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.
                  dashboard:
                    description: Dashboard configuration and layout
                  document:
                    type: object
                    description: Document metadata
                    properties:
                      ephemeral:
                        type: string
                      name:
                        type: string
                    required:
                      - name
                  exportVersion:
                    type: string
                    description: Export format version
                    example: '0.1'
                  fileUploads:
                    type: object
                    additionalProperties: {}
                    description: >-
                      Spreadsheet file data included in the export. Each item
                      contains the file content and metadata needed to restore
                      spreadsheet tiles during import.
                  queryModels:
                    type: object
                    additionalProperties: {}
                    description: Query model definitions referenced by the dashboard
                  workbookModel:
                    description: Workbook model data
              example:
                document:
                  name: Q3 revenue dashboard
                exportVersion: '0.1'
                dashboard: {}
                queryModels: {}
                colorPalettes:
                  export-palette-0:
                    name: Brand colors
                    type: discrete
                    colors:
                      - '#1f77b4'
                      - '#ff7f0e'
                      - '#2ca02c'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - orgApiKey: []
components:
  schemas:
    ColorPaletteExport:
      type: object
      properties:
        colors:
          type: array
          items:
            type: string
          description: Ordered colors as stored, usually hex
        name:
          type: string
          maxLength: 256
          description: Palette name
        type:
          type: string
          enum:
            - discrete
            - continuous
          description: |
            `discrete` or `continuous`
      required:
        - colors
        - name
        - type
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    NotFound:
      description: Not Found - Resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.