STstatsig
Dashboards

Update Dashboard

Changed on

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.

patch/console/v1/dashboards/{id}

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/dashboards/{id}
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required

id

Request body

revisionstring required

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

namestring
descriptionstring

Set an empty string to clear the dashboard description.

Response

Updated dashboard identity and revision.

messagestring required

A simple string explaining the result of the operation.

Changes