Skip to main content
GET
/
v1
/
documents
/
{documentId}
Get dashboard document
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId} \
  --header 'Authorization: Bearer <token>'
{
  "name": "Sales Dashboard",
  "modelId": "abc123de-f456-7890-abcd-ef1234567890",
  "facetFilters": true,
  "refreshInterval": 300,
  "filterConfig": {
    "date_range": {
      "type": "date",
      "defaultValue": "last_7_days"
    }
  },
  "filterOrder": [
    "date_range",
    "region"
  ],
  "queryPresentations": [
    {
      "name": "Revenue by Region",
      "query": {
        "fields": [
          "order_items.total_revenue",
          "orders.region"
        ],
        "table": "order_items",
        "limit": 1000,
        "filters": {},
        "sorts": [],
        "modelId": "abc123de-f456-7890-abcd-ef1234567890"
      },
      "chartType": "bar",
      "prefersChart": true,
      "visualization": {
        "visType": "basic",
        "config": {
          "xAxis": "orders.region",
          "yAxis": "order_items.total_revenue"
        },
        "fields": [
          "order_items.total_revenue",
          "orders.region"
        ]
      },
      "id": "cd54494d-318f-4105-af1c-10af59e62b2e",
      "queryIdentifierMapKey": "1",
      "aiConfig": {},
      "resultConfig": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
required

The document identifier. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Response

Document retrieved successfully

​
name
string

The name of the document

​
modelId
string<uuid>

The ID of the model the document is built on

​
facetFilters
boolean

Whether facet filters are enabled for the document

​
refreshInterval
integer

Auto-refresh interval in seconds

​
filterConfig
object

Filter configuration for the document

​
filterOrder
string[]

Array of filter field names defining the order of filters

​
queryPresentations
object[]

Array of query presentation objects representing tabs in the document's workbook