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
      2. Charts API
      3. Dashboard sections API
        1. List all sections GET
        2. Get a single section GET
        3. Create a section POST
        4. Update a section PATCH
        5. Remove a section DELETE
      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 section

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

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

URL parameters

dashboard_id
required integer

The unique identifier of the dashboard.

id
required integer

The unique identifier of the section to update.

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

name
string

A new name for the section.

y
integer

A new vertical position for the section.

collapsed
boolean

A new collapsed state for the section.

200

The section was updated successfully.

Response body

{
  "data": {
    "id": "890",
    "type": "section",
    "attributes": {
      "name": "Updated Section Name",
      "y": 12,
      "collapsed": true
    }
  }
}
404

The specified dashboard or section was not found.

Example Request

cURL
curl --request PATCH \
  --url https://telemetry.betterstack.com/api/v2/dashboards/1234/sections/890 \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Section Name",
    "y": 12,
    "collapsed": true
  }'


Previous article

Create a dashboard section

Next article

Remove a dashboard section