v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Annotations

Create an annotation

Creates a new annotation on a dashboard or notebook page. Valid color values: gray, blue, purple, green, yellow, red. Valid type values: pointInTime (marks a single moment) or timeRegion (spans a range and requires end_time).

post/api/v2/annotation

Request body

Example request

{
  "data": {
    "attributes": {
      "color": "blue",
      "description": "Deployed v2.3.1 to production.",
      "end_time": 1704070800000,
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "type": "annotation"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "author_id": "00000000-0000-0000-0000-000000000000",
      "color": "blue",
      "created_at": 1704067200000,
      "description": "Deployed v2.3.1 to production.",
      "end_time": 1704070800000,
      "modified_at": 1704067200000,
      "page_id": "dashboard:abc-def-xyz",
      "start_time": 1704067200000,
      "type": "pointInTime",
      "widget_ids": [
        "1234567890"
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "annotation"
  }
}