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.

Response

application/json

200Read 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

funnelobjectrequired

Show child attributes

datasetsobject[]required

Show child attributes

key[]stringrequired

label[]string

group[]string

cohort[]string

excludes_optional_steps[]boolean

steps[]object[]required

Show child attributes

rank[]integerrequired

name[]stringrequired

count[]numberrequired

conversion_rate[]number

previous_step_conversion_rate[]number

time_to_convert[]number

cumulative_time_to_convert[]number

total_prop_sum[]number

400Invalid request. Please check the request input and try again.

statusintegerrequired

messagestringrequired

404Not Found. The requested resource could not be found.

statusintegerrequired

messagestringrequired

Read Dashboard Widget Results

curl -X GET "https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Response

{
  "message": "Dashboard Read Successfully",
  "data": {
    "id": "widget_id",
    "type": "funnel",
    "funnel": {
      "datasets": [
        {
          "key": "default",
          "steps": [
            {
              "rank": 0,
              "name": "signup",
              "count": 100,
              "conversion_rate": 1,
              "previous_step_conversion_rate": 1
            },
            {
              "rank": 1,
              "name": "purchase",
              "count": 42,
              "conversion_rate": 0.42,
              "previous_step_conversion_rate": 0.42
            }
          ]
        }
      ]
    }
  }
}

Was this helpful?