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

Get a single dashboard

Retrieves detailed information for a single dashboard by its ID, including its charts, sections, and variables.

GET https://telemetry.betterstack.com/api/v2/dashboards/{id}

URL parameters

id
required string

The unique identifier of the dashboard.

Headers

Authorization
required string

Bearer $TOKEN

200

The details of the specified dashboard.

Response body

{
  "data": {
    "id": "1234",
    "type": "dashboard",
    "attributes": {
      "team_id": 123456,
      "team_name": "example-team",
      "name": "Sample Dashboard",
      "dashboard_group_id": 789,
      "refresh_interval": 30,
      "date_range_from": "now-3h",
      "date_range_to": "now",
      "created_at": "2025-01-20T15:00:00.000Z",
      "updated_at": "2025-01-21T10:00:00.000Z",
      "source_eligibility_sql": null,
      "variables": [
        {
          "name": "source",
          "variable_type": "source",
          "values": [
            "123"
          ],
          "default_values": []
        },
        {
          "name": "environment",
          "variable_type": "string",
          "values": [
            "production"
          ],
          "default_values": [
            "production"
          ]
        }
      ],
      "charts": [
        {
          "id": 567,
          "chart_type": "line_chart",
          "name": "CPU Usage",
          "x": 0,
          "y": 0,
          "w": 6,
          "h": 4
        }
      ],
      "sections": [
        {
          "id": 890,
          "name": "Key Metrics",
          "y": 0,
          "collapsed": false
        }
      ],
      "has_overlaps": false
    }
  }
}
401

Invalid or missing authentication token.

404

Resource with the provided ID was not found.

Response body

{
  "errors": "Resource with the provided ID was not found"
}

Example cURL

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


Previous article

List all dashboards

Next article

Create a dashboard