Skip to main content
PUT
Update a report
Update a report. All fields are optional; only the fields you send are changed. publicId is write-once: you may assign one to a report that does not have one yet — which is how a report created before stable ids is adopted into as-code management, so PUT /reports/by-public-id/{publicId} can key on it — but a report’s existing publicId cannot be changed, since clients may already have stored it. Attempting to change it returns 400; a publicId already used by another report returns 409. The id you assign must be one you chose (any distinct 12-character [0-9A-Za-z] id). The auto-generated placeholder id shown for a report that has no stable id yet cannot be assigned — it is not unique — and is rejected with 400. Requires edit access to the report.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
string
required
reportId
number
required

Body

application/json

UpdateReportInput

endResultCell
string | null
externalWorkbookId
string | null
folderId
integer | null
jsonQuery
string | null
meta
object | null
name
string | null
pivotItems
object | null
publicId
string | null
Required string length: 12
Pattern: ^[0-9A-Za-z]+$
resultLocation
string | null
sqlQuery
string | null
title
string | null
workbookId
integer | null

Response

200 - application/json
createdAt
required
deploymentId
integer
required
id
integer
required
name
string
required
publicId
string
required
Required string length: 12
Pattern: ^[0-9A-Za-z]+$
refreshedByUser
object
required
type
enum<string>
required
Available options:
FOLDER,
WORKBOOK,
REPORT
updatedAt
required
user
object
required
userId
integer
required
canEdit
boolean | null
canManage
boolean | null
createdBy
integer
description
string | null
endResultCell
string | null
externalWorkbookId
string | null
externalWorkbookPlacements
object[] | null
folderId
integer | null
folderPath
object[]
jsonQuery
string | null
meta
object | null
pivotItems
object | null
refreshedBy
integer | null
resultLocation
string | null
rolesWithAccess
object[] | null
source
enum<string> | null
Available options:
GOOGLE_SHEETS,
EXCEL,
PLAYGROUND,
D3
sqlQuery
string | null
title
string | null
version
integer | null
workbookId
integer | null