Read Dashboard Widget Results

Read Dashboard Widget Results

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

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

dashboard id

widgetIdstringrequired

widget id

Query parameters

sampling_enabledboolean

Whether funnel sampling should be enabled for this results query. Defaults to true.

Example:true

Response

application/json
200· Read dashboard widget results response. Currently only supported for funnel widgets.
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
Show child attributes
idstringrequired
typestringrequired
Allowed values:funnel
funnelobjectrequired
datasetsobject[]required
keystringrequired
labelstring
Constraints:nullable
groupstring
Constraints:nullable
cohortstring
Constraints:nullable
excludes_optional_stepsboolean
stepsobject[]required
rankintegerrequired
Constraints:min: 0
namestringrequired
countnumberrequired
conversion_ratenumber
Constraints:nullable
previous_step_conversion_ratenumber
Constraints:nullable
time_to_convertnumber
Constraints:nullable
cumulative_time_to_convertnumber
Constraints:nullable
total_prop_sumnumber
Constraints:nullable
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?