STstatsig
Dashboards

Replace Widgets on Dashboard

Changed on

Reconcile the complete widget list by ID. Read view=editable or view=references first and include its revision. Preserve widgets with {id}; list exactly the omitted widget IDs in delete_widget_ids to confirm deletion. A revision conflict requires a fresh read and reapplication of the intended edit.

put/console/v1/dashboards/{id}/widgets

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/dashboards/{id}/widgets
  • 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.

delete_widget_idsstring[]

List exactly the existing widget IDs omitted from widgets. Omission alone never confirms deletion.

max_colsinteger

Response

Replace dashboard widgets response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Dashboard Widgets Replaced Successfully",
  "data": {
    "ids": [
      "widget_id"
    ],
    "revision": "d1.revision",
    "deleted_ids": []
  }
}

Changes

  • a7f43412fb6bRevision changes
    • breaking

      added the new required request property

    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the / request property oneOf list

    • breaking

      the / request property type changed from object to no type

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      removed discriminator from / request property

    • info

      added subschema #3 to the / request property oneOf list

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the / request property oneOf list

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status