Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. time series
  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 API
    3. Source groups API
    4. Metrics API
    5. Dashboards API
      1. List all dashboards GET
      2. Get a single dashboard GET
      3. Export a dashboard GET
      4. Import a dashboard POST
      5. Remove a dashboard DELETE
      6. List templates GET
    6. Connections API
    7. Query API ↗
  7. Alternative to
    1. Lightstep

Export a dashboard

Retrieves the full configuration of a dashboard or a public template as a JSON object. This is useful for backing up dashboards or creating new dashboards via the import endpoint.

This endpoint can be used to export both your own dashboards and dashboard templates.

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

URL parameters

id
required string

The unique identifier of the dashboard or template to export.

Headers

Authorization
required string

Bearer $TOKEN

200

The dashboard configuration in JSON format.

Response body

{
  "id": "12345",
  "name": "Better Stack Collector Dashboard",
  "data": {
    "refresh_interval": 30,
    "date_range_from": "now-3h",
    "date_range_to": "now",
    "source_eligibility_sql": null,
    "preset": {
      "id": 67890,
      "preset_type": "implicit",
      "preset_variables": [
        {
          "name": "service",
          "variable_type": "select_value",
          "values": [
            "web"
          ],
          "default_values": [
            "web",
            "api"
          ],
          "sql_definition": "SELECT DISTINCT service FROM logs"
        }
      ]
    },
    "charts": [
      {
        "chart_type": "line_chart",
        "name": "CPU Usage",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 4,
        "transform_with": "async (existingDataByQuery, newDataByQuery, lastRun) => { return newDataByQuery; }",
        "settings": {
          "unit": "percent",
          "y_axis_scale": "linear"
        },
        "chart_queries": [
          {
            "query_type": "sql_expression",
            "sql_query": "SELECT {{time}} as time, avg(cpu_usage) as value FROM metrics WHERE service = '{{service}}' GROUP BY time"
          }
        ],
        "chart_alerts": []
      }
    ],
    "sections": [
      {
        "name": "System Metrics",
        "y": 0,
        "collapsed": false
      }
    ]
  }
}
401

Invalid or missing authentication token.

404

Resource with the provided ID was not found.

Response body

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

Example cURL

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


Previous article

Get a single dashboard

Next article

Import a dashboard