STstatsig
Dashboards

Add Widgets to Dashboard

Changed on

Append typed widget definitions. Supported definitions from an editable read can be copied; supplied widget IDs do not retain existing widgets. Include a revision to reject an append after concurrent dashboard changes.

post/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

Reject the append if this revision no longer matches the dashboard.

max_colsinteger

Response

Add dashboard widgets response

messagestring required

A simple string explaining the result of the operation.

Example response

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

Changes

  • a7f43412fb6bRevision changes
    • 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

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

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 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 required property // to the response with the status