Skip to main content
GET
Read a report definition as editable JSON text
Returns the report’s definition as canonical JSON text (content) and its SHA-256 (hash): name plus the definition fields of meta (sqlQuery, chartCategory, chart specs, pivotItems, …). vegaSpec appears as a JSON object. Placements and run state are left out. Use it with PATCH /reports/{reportId}/file to change part of a report without resending it.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required
reportId
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.