Read Dashboard

Reference for the GET /console/v1/dashboards/{id} endpoint of the Statsig API.

gethttps://statsigapi.net/console/v1/dashboards/{id}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Response

application/json
200· Read dashboard response
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
namestringrequired
Constraints:min length: 1max length: 200
descriptionstring
Constraints:max length: 10000
defaultsobject
dateobject
valueintegerrequired
Constraints:format: int64min: 0
unitstringrequired
Allowed values:dayweekmonth
granularitystring
Allowed values:autodailyweeklymonthly
idstringrequired
widgetsoneOf[]
typestringrequired
Allowed values:unsupported
titlestringrequired
contentstring
widthinteger
Constraints:min: 0max: 12
heightinteger
Constraints:min: 0
idstringrequired
colorstring
descriptionstring
queryobject
stepsobject[]required
event_namestringrequired
filtersobject[]
propertyobjectrequired
keystringrequired
columnunknownrequired
operatorunknownrequired
valuesstring[]
Default:[]
unit_typestring
conversion_windowobject
valueintegerrequired
Constraints:min: 0
unitstringrequired
Allowed values:secondminutehourday
chart_typestring
Allowed values:conversion-rateconversions
group_bysobject[]
keystringrequired
columnunknownrequired
cohortsobject[]
idstring
namestringrequired
reasonstring
400· Invalid request. Please check the request input and try again.
statusintegerrequired
Allowed values:400
messagestringrequired
404· Not Found. The requested resource could not be found.
statusintegerrequired
Allowed values:404
messagestringrequired

Was this helpful?