Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. Vector
    3. OpenTelemetry
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. AI SRE ↗
    2. MCP server ↗
    3. Transforming ingested data
    4. Querying data
    5. Tracing
    6. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
    3. Dashboards
      1. Dashboards API
        1. List all dashboards GET
        2. Get a single dashboard GET
        3. Create a dashboard POST
        4. Update a dashboard PATCH
        5. Remove a dashboard DELETE
        6. Export a dashboard GET
        7. Import a dashboard POST
        8. List templates GET
      2. Charts API
      3. Dashboard sections API
      4. Dashboard alerts API
      5. Dashboard groups API
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
  7. Alternative to
    1. Lightstep

List all dashboards

Returns a paginated list of your team's dashboards.

The list endpoint returns a summarized view of each dashboard. For the full dashboard configuration including variables, charts, and sections, use the Get a dashboard endpoint.

GET https://telemetry.betterstack.com/api/v2/dashboards

Query parameters

page
1 integer

Page number for pagination.

per_page
50 integer

Number of items per page (max 250).

query
string

Search for dashboards by name.

dashboard_group_id
integer

Filter dashboards by the ID of a dashboard group.

Headers

Authorization
required string

Bearer $TOKEN

200

A paginated list of dashboards.

Response body

{
  "data": [
    {
      "id": "1234",
      "type": "dashboard",
      "attributes": {
        "team_id": 123456,
        "team_name": "example-team",
        "name": "Sample Dashboard",
        "dashboard_group_id": 789,
        "refresh_interval": 60,
        "date_range_from": "now-3h",
        "date_range_to": "now",
        "created_at": "2025-01-20T15:00:00.000Z",
        "updated_at": "2025-01-20T15:00:00.000Z"
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v2/dashboards?page=1&per_page=2",
    "last": "https://telemetry.betterstack.com/api/v2/dashboards?page=16&per_page=2",
    "prev": null,
    "next": "https://telemetry.betterstack.com/api/v2/dashboards?page=2&per_page=2"
  }
}
401

Invalid or missing authentication token.

Example request

Example
curl --request GET \
     --url "https://telemetry.betterstack.com/api/v2/dashboards" \
     --header "Authorization: Bearer $TOKEN"


Previous article

Remove a source group

Next article

Get a single dashboard