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

Update a dashboard

Updates an existing dashboard by its ID. You only need to provide the fields you want to change.

When updating variables, the entire array of custom variables will be replaced with the one you provide. System variables (time, start_time, end_time, source) are preserved.

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

URL parameters

id
required integer

The unique identifier of the dashboard to update.

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

name
string

A new name for the dashboard.

dashboard_group_id
integer

A new dashboard group ID. Use 0 or null to remove from a group.

refresh_interval
integer

A new refresh interval in seconds.

date_range_from
string

A new start for the dashboard's date range.

date_range_to
string

A new end for the dashboard's date range.

source_eligibility_sql
string

A new SQL filter for source eligibility.

variables
array

An array of variable objects to replace the existing custom variables.

200

The dashboard was updated successfully.

Response body

{
  "data": {
    "id": "1234",
    "type": "dashboard",
    "attributes": {
      "name": "Updated API Dashboard",
      "refresh_interval": 120,
      "variables": [
        {
          "name": "environment",
          "variable_type": "string",
          "values": [
            "staging"
          ],
          "default_values": [
            "staging"
          ]
        }
      ]
    }
  }
}
404

A dashboard with the specified ID was not found.

Example Request

cURL
curl --request PATCH \
  --url https://telemetry.betterstack.com/api/v2/dashboards/1234 \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated API Dashboard",
    "refresh_interval": 120,
    "variables": [
      {
        "name": "environment",
        "variable_type": "string",
        "values": ["staging"],
        "default_values": ["staging"]
      }
    ]
  }'


Previous article

Create a dashboard

Next article

Remove a dashboard