Create Dashboard

POST /console/v1/dashboards

Create Dashboard

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/dashboards \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "defaults": {
    "granularity": "auto"
  },
  "widgets": [
    {
      "type": "text",
      "title": "<string>",
      "content": "<string>",
      "width": 6,
      "height": 1
    }
  ]
}
'

200

{
  "message": "Dashboard Created Successfully",
  "data": {
    "id": "dashboard_id",
    "dashboard_url": "https://console.statsig.com/company_id/dashboards/dashboard_id"
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Body

application/json

name · string · required

Required string length: 1 - 200

description · string

Maximum string length: 10000

defaults · object

Show child attributes

widgets · object[]

Option 1

Option 2

Option 3

Option 4

Show child attributes

Response

200 - application/json

Create dashboard response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes