Read Dashboard

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

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Response

application/json

200Read dashboard response

messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Show child attributes

namestringrequired

descriptionstring

defaultsobject

Show child attributes

dateobject

Show child attributes

valueintegerrequired

unitstringrequired

granularitystring

idstringrequired

widgetsoneOf[]

400Invalid request. Please check the request input and try again.

statusintegerrequired

messagestringrequired

404Not Found. The requested resource could not be found.

statusintegerrequired

messagestringrequired

Read Dashboard

curl -X GET "https://statsigapi.net/console/v1/dashboards/{id}" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

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
      }
    ]
  }
}

Was this helpful?