Create a chart comment

Pins a comment to a point in time on a chart, the same comment you get by clicking the chart in the Better Stack interface. Use it to mark releases, deployments, and incidents on your charts from your own scripts.

{
  "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
    }
  }
}

Example request

curl --request POST \
  --url https://telemetry.betterstack.com/api/v2/dashboards/1234/charts/18718/comments \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "dt": "2026-08-17T12:34:56.789Z",
    "content": "Deployed v2.1.0",
    "user_email": "sarah@example.com"
  }'

Chart types that show comments

Comments are drawn on the time axis of a line chart. Pinning one to any other chart type returns 422 with a chart_type error, because the comment would never be visible.

Tag a team member

user_email has to belong to a member of the team the dashboard belongs to. The mention goes in front of your content, so the comment above shows as @Sarah Connor Deployed v2.1.0 on the chart, and Sarah is notified exactly as if somebody had tagged her by hand.

Send user_email on create only. A mention is part of the comment content, so to change one, send the whole content you want to Update a chart comment.

Who the comment is from

A comment created with an API token has no author. It shows as Comment added using API on the chart, its api_authored attribute is true, and it notifies only the team members it tags. Marking every deploy on a chart therefore stays quiet.

A comment created with an OAuth token is attributed to the team member that token belongs to, and notifies the whole team just like a comment written in the Better Stack interface.