---
title: Read Dashboard Widget Results
description: Read Dashboard Widget Results
product: general
token_estimate: 1634
---
# Read Dashboard Widget Results

> For AI agents: a documentation index is available at [/llms.txt](/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## Read Dashboard Widget Results

**GET** `/console/v1/dashboards/{id}/widgets/{widgetId}/results`

Full URL: `https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results`

Read Dashboard Widget Results

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| STATSIG-API-KEY | string | Yes | — | apiKey (header) |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| id (path) | string | Yes | — | dashboard id |
| widgetId (path) | string | Yes | — | widget id |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| sampling_enabled (query) | boolean | No | true | Whether funnel sampling should be enabled for this results query. Defaults to true. |

## Response (application/json)

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

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object | Yes | — | — |
| data.id | string | Yes | — | — |
| data.type | string | Yes | — | Allowed values: funnel |
| data.funnel | object | Yes | — | — |
| data.funnel.datasets | object[] | Yes | — | — |
| data.funnel.datasets.key | string | Yes | — | — |
| data.funnel.datasets.label | string | No | — | Constraints: nullable |
| data.funnel.datasets.group | string | No | — | Constraints: nullable |
| data.funnel.datasets.cohort | string | No | — | Constraints: nullable |
| data.funnel.datasets.excludes_optional_steps | boolean | No | — | — |
| data.funnel.datasets.steps | object[] | Yes | — | — |
| data.funnel.datasets.steps.rank | integer | Yes | — | Constraints: min: 0 |
| data.funnel.datasets.steps.name | string | Yes | — | — |
| data.funnel.datasets.steps.count | number | Yes | — | — |
| data.funnel.datasets.steps.conversion_rate | number | No | — | Constraints: nullable |
| data.funnel.datasets.steps.previous_step_conversion_rate | number | No | — | Constraints: nullable |
| data.funnel.datasets.steps.time_to_convert | number | No | — | Constraints: nullable |
| data.funnel.datasets.steps.cumulative_time_to_convert | number | No | — | Constraints: nullable |
| data.funnel.datasets.steps.total_prop_sum | number | No | — | Constraints: nullable |

```json
{
  "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
            }
          ]
        }
      ]
    }
  }
}
```

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

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 400 |
| message | string | Yes | — | — |

```json
{
  "status": 400,
  "message": "Invalid request. Please check the request input and try again."
}
```

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

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 404 |
| message | string | Yes | — | — |

```json
{
  "status": 404,
  "message": "Not Found. The requested resource could not be found."
}
```

## Code samples

### cURL

```bash
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"
```

### Python

```python
import requests

response = requests.get(
    "https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true",
    headers={
        "Content-Type": "application/json",
        "STATSIG-API-KEY": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "STATSIG-API-KEY": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "STATSIG-API-KEY: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("GET", "https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("STATSIG-API-KEY", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true"))
      .method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("STATSIG-API-KEY", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://statsigapi.net/console/v1/dashboards/{id}/widgets/{widgetId}/results?sampling_enabled=true")
request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["STATSIG-API-KEY"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```