Create a single dashboard

POST /dashboards

cURL

cURL

curl -X POST https://api.growthbook.io/api/v1/dashboards -d '{ ... }' -u secret_abc123DEF456

200

{
  "dashboard": {
    "id": "<string>",
    "uid": "<string>",
    "organization": "<string>",
    "isDefault": true,
    "isDeleted": true,
    "userId": "<string>",
    "editLevel": "published",
    "shareLevel": "published",
    "enableAutoUpdates": true,
    "title": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "blocks": [
      {
        "organization": "<string>",
        "id": "<string>",
        "uid": "<string>",
        "type": "<string>",
        "title": "<string>",
        "description": "<string>",
        "factMetricId": "<string>",
        "visualizationType": "histogram",
        "valueType": "avg",
        "metricAnalysisId": "<string>",
        "analysisSettings": {
          "userIdType": "<string>",
          "lookbackDays": 123,
          "populationType": "metric",
          "populationId": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "additionalNumeratorFilters": [
            "<string>"
          ],
          "additionalDenominatorFilters": [
            "<string>"
          ]
        },
        "snapshotId": "<string>"
      }
    ],
    "experimentId": "<string>",
    "updateSchedule": {
      "type": "<string>",
      "hours": 123
    },
    "projects": [
      "<string>"
    ],
    "nextUpdate": "2023-11-07T05:31:56Z",
    "lastUpdated": "2023-11-07T05:31:56Z"
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Body

application/json

title · string · required

The display name of the Dashboard

editLevel · enum<string> · required

Dashboards that are "published" are editable by organization members with appropriate permissions

Available options: published, private

shareLevel · enum<string> · required

General Dashboards only. Dashboards that are "published" are viewable by organization members with appropriate permissions

Available options: published, private

enableAutoUpdates · boolean · required

If enabled for a General Dashboard, also requires an updateSchedule

blocks · object[] · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

updateSchedule · object

General Dashboards only. Experiment Dashboards update based on the parent experiment instead

Option 1

Option 2

Show child attributes

experimentId · string

The parent experiment for an Experiment Dashboard, or undefined for a general dashboard

projects · string[]

General Dashboards only, Experiment Dashboards use the experiment's projects

Response

200 - application/json

Success

dashboard · object · required

Show child attributes