Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Annotations

List annotations

Returns a flat list of annotations matching the given page, time window, and optional widget filter.

get/api/v2/annotation

Query parameters

page_idstring required

ID of the page to list annotations for, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

start_timeinteger required

Start of the time window in milliseconds since the Unix epoch.

end_timeinteger required

End of the time window in milliseconds since the Unix epoch.

widget_idstring

Optional widget ID to restrict results to annotations on a specific widget.

Response

OK

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