v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

Documents v2

Get document state

Retrieve the document's published state. To read a draft's state, use Get draft state instead.

The response can be used as-is as the request body in a call to the Patch draft API.

Tiles in queryPresentations.data are keyed by a stable record key (e.g. "1", "2"); the server uses that key to identify existing tiles on a later patch, so you never need to track any other identifier. Control IDs and container instanceKey / referenceKey values also round-trip unchanged.

A workbook-only document (no dashboard layout yet) returns only the workbook-scoped fields (name, description, queryPresentations); the dashboard-scoped containers, controls, and settings are omitted until a layout exists.

get/v2/documents/{documentId}

Path parameters

documentIdstring required

The document's URL slug (e.g. abc123) or its canonical workbook UUID.

Query parameters

prettyboolean

Format response with 2-space indentation for readability. Accepts true, 1, or no value (e.g., ?pretty). Default is compact (single-line) JSON.

Response

Document state.

namestring required

Document name.

descriptionstring nullable required

Document description.

modelIdstring uuid

The SHARED or SHARED_EXTENSION model the workbook is built on.

workbookModelIdstring uuid

The workbook-layer model ID. Each document has its own workbook model for document-specific fields and calculations. For drafts, this returns the draft's workbook model ID, not the published document's.

containersobject[]

Container layout array (grid / stack / page / reference containers, recursively nested). On a patch, when present this fully replaces the existing layout. The server validates the full structure on apply; container instanceKey / referenceKey values round-trip unchanged. See the dashboard layout reference for the complete grammar.