Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. OpenTelemetry
    3. Vector
    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. Grafana
    7. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
    3. Dashboards
      1. Dashboards API
      2. Charts API
      3. Chart comments API
        1. List all comments GET
        2. Get a single comment GET
        3. Create a comment POST
        4. Update a comment PATCH
        5. Remove a comment DELETE
      4. Dashboard sections API
      5. Dashboard alerts API
      6. Dashboard groups API
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
    8. Usage API ↗
  7. Alternative to
    1. Lightstep

List all comments on a chart

Returns a paginated list of the comments pinned to a chart, ordered by the point in time each one is pinned to, oldest first.

GET https://telemetry.betterstack.com/api/v2/dashboards/{dashboard_id}/charts/{chart_id}/comments

URL parameters

dashboard_id
required integer

The unique identifier of the dashboard.

chart_id
required integer

The unique identifier of the chart.

Query parameters

page
1 integer

Page number for pagination.

per_page
50 integer

Number of items per page (max 250).

Headers

Authorization
required string

Bearer $TOKEN

200

A paginated list of the comments pinned to the specified chart.

Response body

{
  "data": [
    {
      "id": "1441",
      "type": "chart_comment",
      "attributes": {
        "chart_id": 18718,
        "content": "Deployed v2.1.0",
        "created_at": "2026-08-17T12:52:21.837Z",
        "updated_at": "2026-08-17T12:52:21.837Z",
        "dt": "2026-08-17T12:34:56.789Z",
        "plaintext_content": "Deployed v2.1.0",
        "api_authored": true
      }
    },
    {
      "id": "1442",
      "type": "chart_comment",
      "attributes": {
        "chart_id": 18718,
        "content": "Latency back to normal after the rollout.",
        "created_at": "2026-08-17T13:41:02.114Z",
        "updated_at": "2026-08-17T13:41:02.114Z",
        "dt": "2026-08-17T13:30:00.000Z",
        "plaintext_content": "Latency back to normal after the rollout.",
        "user_email": "sarah@example.com",
        "api_authored": false
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v2/dashboards/1234/charts/18718/comments?page=1",
    "last": "https://telemetry.betterstack.com/api/v2/dashboards/1234/charts/18718/comments?page=1",
    "prev": null,
    "next": null
  }
}
404

A dashboard or chart with the specified ID was not found.

Example request

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


Comment attributes

  • dt - The point on the chart's time axis the comment is pinned to, in UTC with millisecond precision.
  • content - The comment as stored. A comment that tags a team member holds the mention as internal markup, so send this value back unchanged when you update the comment and want to keep the mention.
  • plaintext_content - The same comment as readable text, with any mention rendered as @Team member. Use this one to display a comment.
  • user_email - The team member who wrote the comment. Omitted for a comment created with an API token, which has no author.
  • api_authored - Whether the comment was created through this API. Only these can be updated and removed with an API token, so use it to tell your own comments apart from those written in the Better Stack interface and the incident comments synced onto the chart from Uptime.

Previous article

Remove a chart

Next article

Get a single chart comment