List Dashboards

gethttps://statsigapi.net/console/v1/dashboards

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

searchstring

Filter dashboards by name using a partial match.

Response

application/json

200List dashboards response

messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required

Show child attributes

id[]stringrequired

name[]stringrequired

description[]stringrequired

defaults[]object

Show child attributes

dateobject

Show child attributes

valueintegerrequired

unitstringrequired

granularitystring

created_time[]numberrequired

modified_time[]numberrequired

widget_count[]integerrequired

is_verified[]boolean

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

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

statusintegerrequired

messagestringrequired

List Dashboards

curl -X GET "https://statsigapi.net/console/v1/dashboards?limit=10&page=1&search=growth" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Response

{
  "message": "Dashboards Listed Successfully",
  "data": [
    {
      "id": "dashboard_id",
      "name": "My Dashboard",
      "description": "desc",
      "defaults": {
        "date": {
          "value": 14,
          "unit": "day"
        },
        "granularity": "daily"
      },
      "created_time": 1736208000,
      "modified_time": 1736294400,
      "widget_count": 1,
      "is_verified": true
    }
  ],
  "pagination": {
    "itemsPerPage": 20,
    "pageNumber": 1,
    "nextPage": null,
    "previousPage": null,
    "totalItems": 1,
    "all": "/console/v1/dashboards"
  }
}

Was this helpful?