---
title: Read Dashboard
description: "Reference for the GET /console/v1/dashboards/{id} API endpoint."
product: general
token_estimate: 2100
---
# Read Dashboard

> 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

**GET** `/console/v1/dashboards/{id}`

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

Read Dashboard

## Authorizations

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

## Path parameters

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

## Response (application/json)

**200** — Read dashboard response

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object | Yes | — | — |
| data.name | string | Yes | — | Constraints: min length: 1, max length: 200 |
| data.description | string | No | — | Constraints: max length: 10000 |
| data.defaults | object | No | — | — |
| data.defaults.date | object | No | — | — |
| data.defaults.date.value | integer | Yes | — | Constraints: format: int64, min: 0 |
| data.defaults.date.unit | string | Yes | — | Allowed values: day, week, month |
| data.defaults.granularity | string | No | — | Allowed values: auto, daily, weekly, monthly |
| data.id | string | Yes | — | — |
| data.widgets | oneOf[] | No | — | — |
| data.widgets.type | string | Yes | — | Allowed values: text, header, timeseries, funnel, unsupported |
| data.widgets.title | string | Yes | — | — |
| data.widgets.content | string | No | — | — |
| data.widgets.width | integer | No | — | Constraints: min: 0, max: 12 |
| data.widgets.height | integer | No | — | Constraints: min: 0 |
| data.widgets.id | string | Yes | — | — |
| data.widgets.color | string | No | — | — |
| data.widgets.description | string | No | — | — |
| data.widgets.query | object | No | — | — |
| data.widgets.query.source | object | No | — | — |
| data.widgets.query.source.type | string | Yes | — | Allowed values: event |
| data.widgets.query.source.event_name | string | Yes | — | — |
| data.widgets.query.source.filters | object[] | No | — | — |
| data.widgets.query.source.filters.property | object | Yes | — | — |
| data.widgets.query.source.filters.property.key | string | Yes | — | — |
| data.widgets.query.source.filters.property.column | unknown | Yes | — | — |
| data.widgets.query.source.filters.operator | unknown | Yes | — | — |
| data.widgets.query.source.filters.values | string[] | No | [] | — |
| data.widgets.query.sources | object[] | No | — | — |
| data.widgets.query.sources.type | string | Yes | — | Allowed values: event |
| data.widgets.query.sources.event_name | string | Yes | — | — |
| data.widgets.query.sources.filters | object[] | No | — | — |
| data.widgets.query.sources.filters.property | object | Yes | — | — |
| data.widgets.query.sources.filters.property.key | string | Yes | — | — |
| data.widgets.query.sources.filters.property.column | unknown | Yes | — | — |
| data.widgets.query.sources.filters.operator | unknown | Yes | — | — |
| data.widgets.query.sources.filters.values | string[] | No | [] | — |
| data.widgets.query.aggregation | object | Yes | — | — |
| data.widgets.query.aggregation.type | unknown | Yes | — | — |
| data.widgets.query.aggregation.property | object | No | — | — |
| data.widgets.query.aggregation.property.key | string | Yes | — | — |
| data.widgets.query.aggregation.property.column | unknown | Yes | — | — |
| data.widgets.query.unit_type | string | No | — | — |
| data.widgets.query.group_bys | object[] | No | — | — |
| data.widgets.query.group_bys.key | string | Yes | — | — |
| data.widgets.query.group_bys.column | unknown | Yes | — | — |
| data.widgets.query.viz | object | No | — | — |
| data.widgets.query.viz.chart_type | unknown | Yes | — | — |
| data.widgets.query.steps | object[] | No | — | — |
| data.widgets.query.steps.event_name | string | Yes | — | — |
| data.widgets.query.steps.filters | object[] | No | — | — |
| data.widgets.query.steps.filters.property | object | Yes | — | — |
| data.widgets.query.steps.filters.property.key | string | Yes | — | — |
| data.widgets.query.steps.filters.property.column | unknown | Yes | — | — |
| data.widgets.query.steps.filters.operator | unknown | Yes | — | — |
| data.widgets.query.steps.filters.values | string[] | No | [] | — |
| data.widgets.query.conversion_window | object | No | — | — |
| data.widgets.query.conversion_window.value | integer | Yes | — | Constraints: min: 0 |
| data.widgets.query.conversion_window.unit | string | Yes | — | Allowed values: second, minute, hour, day |
| data.widgets.query.chart_type | string | No | — | Allowed values: conversion-rate, conversions |
| data.widgets.query.cohorts | object[] | No | — | — |
| data.widgets.query.cohorts.id | string | No | — | — |
| data.widgets.query.cohorts.name | string | Yes | — | — |
| data.widgets.reason | string | No | — | — |

```json
{
  "message": "Dashboard Read Successfully",
  "data": {
    "id": "dashboard_id",
    "name": "My Dashboard",
    "description": "desc",
    "defaults": {
      "date": {
        "value": 14,
        "unit": "day"
      },
      "granularity": "daily"
    },
    "widgets": [
      {
        "id": "widget_id",
        "type": "header",
        "title": "Overview",
        "width": 12,
        "height": 1
      }
    ]
  }
}
```

**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}" \
  -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}",
    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}", {
  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}");
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}", 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}"))
      .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}")
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
```