v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Dashboards

Read Dashboard Widget Results

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

Path parameters

idstring required

dashboard id

widgetIdstring required

widget id

Query parameters

sampling_enabledboolean
Example:true

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

Response

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

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