Skip to main content
GET
/
unstable
/
documents
/
{dashboardId}
/
export
Export dashboard
curl --request GET \
  --url https://{instance}.omniapp.co/api/unstable/documents/{dashboardId}/export \
  --header 'Authorization: Bearer <token>'
{
  "dashboard": {},
  "document": {},
  "exportVersion": "0.1",
  "workbookModel": {},
  "fileUploads": [
    {
      "fileUploadId": "<string>",
      "fileName": "<string>",
      "contentType": "<string>",
      "data": "<string>"
    }
  ]
}

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

Path Parameters

​
dashboardId
string
required

Dashboard identifier

Response

Dashboard export data

​
dashboard
object

Dashboard configuration

​
document
object

Document metadata

​
exportVersion
string
Example:

"0.1"

​
workbookModel
object

Workbook model data

​
fileUploads
object[]

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