For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Update Dashboard

Update dashboard name, description, or defaults. Include the revision from an editable or references read. Omitted fields remain unchanged; an empty descript…

Update dashboard name, description, or defaults. Include the revision from an editable or references read. Omitted fields remain unchanged; an empty description clears it and defaults:null resets dashboard defaults. Read again after a revision conflict.

patchhttps://statsigapi.net/console/v1/dashboards/{id}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Body

application/json
revisionstringrequired

Include the revision returned by an editable or references read. Read the dashboard again after a revision conflict.

namestring
Constraints:min length: 1max length: 200
descriptionstring

Set an empty string to clear the dashboard description.

Constraints:max length: 10000
defaultsobject

Update only the supplied defaults. Set null to reset to 30 days and daily granularity.

Constraints:nullable
Show child attributes
dateoneOf
Constraints:objectobjectobjectobject
valueinteger or number
Constraints:min: 0
unitstring
Allowed values:dayweekmonthminutehour
modestring
Allowed values:chart_defaultsincerelative
since_msnumber
granularitystring
Allowed values:autodailyweeklymonthly

Response

application/json
200· Updated dashboard identity and revision.
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
idstringrequired
revisionstringrequired
400· Invalid request. Please check the request input and try again.
statusintegerrequired
Allowed values:400
messagestringrequired
404· Not Found. The requested resource could not be found.
statusintegerrequired
Allowed values:404
messagestringrequired

Was this helpful?