Skip to main content
GET
/
console
/
v1
/
dashboards
/
{id}
/
widgets
/
{widgetId}
/
results
Read Dashboard Widget Results
curl --request GET \
  --url https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "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
            }
          ]
        }
      ]
    }
  }
}

Authorizations

STATSIG-API-KEY
string
header
required

Path Parameters

id
string
required

dashboard id

widgetId
string
required

widget id

Query Parameters

sampling_enabled
boolean

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

Example:

true

Response

Read dashboard widget results response. Currently only supported for funnel widgets.

message
string
required

A simple string explaining the result of the operation.

data
object
required

A single result.