Skip to main content
POST
/
unstable
/
documents
/
import
Import dashboard
curl --request POST \
  --url https://{instance}.omniapp.co/api/unstable/documents/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dashboard": {},
  "document": {},
  "workbookModel": {},
  "exportVersion": "0.1",
  "identifier": "<string>",
  "folderPath": "<string>",
  "fileUploads": [
    {
      "fileUploadId": "<string>",
      "fileName": "<string>",
      "contentType": "<string>",
      "data": "<string>"
    }
  ]
}
'
{
  "dashboard": {
    "dashboardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "miniUuidMap": {},
  "workbook": {}
}

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.

This API is in beta and may have future breaking changes.

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

Target model ID

​
dashboard
object
required

Dashboard configuration from export

​
document
object
required

Document metadata from export

​
workbookModel
object
required

Workbook model from export

​
exportVersion
enum<string>
required

Export format version (must be "0.1")

Available options:
0.1
​
identifier
string

Custom identifier for the imported dashboard

​
folderPath
string

Destination folder path

​
fileUploads
object[]

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

Response

Dashboard imported successfully

​
dashboard
object
​
miniUuidMap
object
​
workbook
object