STstatsig
Dashboards

Read Dashboard

Changed on

Read dashboard widget definitions. Use view=editable for complete typed definitions and a revision, or view=references for bounded widget references. Pin reference pages and widget_id detail reads with revision. The default legacy view is unchanged. Send supported definitions back to create, add, replace, or edit widgets. Preserve unsupported widgets by ID. Include the read revision for replacement, edits and deletions.

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

Query parameters

view'legacy' | 'editable' | 'references'
widget_idstring
revisionstring
cursorstring
limitinteger

Response

Read dashboard response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Dashboard Read Successfully",
  "data": {
    "id": "dashboard_id",
    "name": "My Dashboard",
    "description": "desc",
    "defaults": {
      "date": {
        "value": 14,
        "unit": "day"
      },
      "granularity": "daily"
    },
    "widgets": [
      {
        "id": "widget_id",
        "type": "header",
        "title": "Overview",
        "width": 12,
        "height": 1
      }
    ]
  }
}

Changes

  • a7f43412fb6bRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter revision

    • info

      added the new optional query request parameter view

    • info

      added the new optional query request parameter widget_id

    • info

      added the non-success response with the status

    • info

      added to the / response property anyOf list for the response status