Skip to main content
GET
Read the dashboard draft as editable JSON text
Returns the workbook’s classic dashboard draft as canonical JSON text (content) and its SHA-256 (hash). Use it with PATCH /workbooks/{workbookId}/dashboard/file to change part of the dashboard without resending the whole configuration. Returns 400 for a workbook whose dashboard is a Dashboard App.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
workbookId
number
required

Response

200 - application/json
content
string
required

The configuration as canonical JSON text: keys sorted, 2-space indentation, trailing newline. oldText in a replacement must match this text exactly.

hash
string
required

SHA-256 of content. Send it back as expectedHash to reject the write if the configuration changed since you read it.