STstatsig
Dashboards

Read Dashboard Widget Results

Changed on

Read drilldown line, bar, pie, table, geo-map and number results, or funnel step, conversion-over-time and time-to-convert results. Results use dashboard date and granularity defaults. Dashboard global filters and variables are not applied. Hidden input series participate in formulas but their own datasets are omitted. Samples results require a separate loader and are unsupported.

get/console/v1/dashboards/{id}/widgets/{widgetId}/results

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results
  • Auth
    API key in header STATSIG-API-KEY

Path parameters

idstring required

dashboard id

widgetIdstring required

widget id

Query parameters

sampling_enabledboolean
Example:true

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

Response

Read dashboard results as funnel, timeseries, categorical, or single_value. Drilldown tables and geo-maps return categorical data. Funnel rates over time use percentages; time-to-convert histograms include counts, numeric bucket boundaries and their shared denominator. Results use the dashboard's date range and granularity, resolved in the company's timezone.

messagestring required

A simple string explaining the result of the operation.

Example 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
            }
          ]
        }
      ]
    }
  }
}

Changes

  • a7f43412fb6bRevision changes
    • breaking

      the response property // became optional for the status

    • warning

      added the new categorical enum value to the // response property for the response status

    • warning

      added the new single_value enum value to the // response property for the response status

    • warning

      added the new timeseries enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status