v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBAnnotations
Get annotations for a page
Returns all annotations on a specific page for a given time window, grouped by widget. Unlike ListAnnotations, this endpoint returns a single structured object with annotations indexed by their ID and a widget-to-annotation mapping for easy UI rendering.
get/api/v2/annotation/page/{page_id}
Path parameters
page_idstring required
The ID of the page, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).
Query parameters
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.
Response
OK
Example response
{
"data": {
"attributes": {
"annotations": {
"00000000-0000-0000-0000-000000000000": {
"author_id": "00000000-0000-0000-0000-000000000001",
"color": "blue",
"created_at": 1704067200000,
"description": "Deployed v2.3.1 to production.",
"end_time": null,
"id": "00000000-0000-0000-0000-000000000000",
"modified_at": 1704067200000,
"page_id": "dashboard:abc-def-xyz",
"start_time": 1704067200000,
"type": "pointInTime",
"widget_ids": [
"1234567890"
]
}
},
"global_annotations": [
"00000000-0000-0000-0000-000000000001"
],
"widget_mapping": {
"1234567890": [
"00000000-0000-0000-0000-000000000000"
]
}
},
"id": "dashboard:abc-def-xyz",
"type": "page_annotations"
}
}