Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

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
updateSchedule
object

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

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

globalControls
object
comparison
object

Dashboard-wide compare-to-previous-period. Takes precedence over any per-block comparison.

owner
string

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. Optional when authenticating with a Personal Access Token (PAT): when omitted, the owner defaults to the PAT's user. Required when authenticating with an organization secret API key (which has no associated user): omitting it fails with a 400. A private dashboard created with an organization secret API key can only be retrieved or updated using its owner's Personal Access Token (PAT).

Minimum string length: 1

Response

200 - application/json

Resource created

dashboard
object
required