Skip to main content
GET
/
console
/
v1
/
dashboards
List Dashboards
curl --request GET \
  --url https://statsigapi.net/console/v1/dashboards \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "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"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

​
search
string

Filter dashboards by name using a partial match.

Minimum string length: 1
Example:

"growth"

Response

List dashboards response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

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