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": {}
}

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": {}
}

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

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

dashboardId

string

required

Dashboard identifier

Dashboard export data

dashboard

object

Dashboard configuration

document

object

Document metadata

exportVersion

string

Example:

"0.1"

workbookModel

object

Workbook model data