Sign in
Web Analytics

Get an annotation

Retrieves a single annotation by ID. Requires the web_analytics read permission.

get/api/annotations.get

Query parameters

workspace_idstring required

The ID of the workspace

idstring required

The ID of the annotation

Response

The annotation

Example response

{
  "annotation": {
    "id": "3f2504e04f8911d39a0c0305e82c3301",
    "annotated_at": "2026-08-15T09:00:00Z",
    "timezone": "Asia/Tokyo",
    "title": "Pricing page redesign",
    "description": "Rolled out to all visitors after the A/B test.",
    "color": "#3b82f6",
    "source": "manual",
    "source_id": "bcast_1234567890"
  }
}

Changes