v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Documents

Get document

Retrieves a document's configuration in a format compatible with PUT for round-trip editing. GET a document, modify the response, and PUT it back to update. Only dashboard documents are supported; analysis documents return 400.

get/api/v1/documents/{identifier}

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Response

Document details

descriptionstring nullable

Document description

{"stackTrail":"components:schemas:DocumentsGetResponse:properties:documentMetadata","oasType":"schema","type":"unknown","description":"Document metadata"}

facetFiltersboolean required

Whether facet filters are enabled

{"stackTrail":"components:schemas:DocumentsGetResponse:properties:filterConfig","oasType":"schema","type":"unknown","description":"Dashboard filter configuration"}

filterOrderstring[] required

Order of filters

modelIdstring required

Model ID

namestring required

Document name

refreshIntervalnumber nullable required

Auto-refresh interval in seconds