Create Annotation

Add an annotation to a site's analytics timeline.

Create Annotation

Creates a new annotation on the site's analytics timeline. Useful for marking deployments, campaigns, or other notable events.

Endpoint

POST /api/v1/organizations/:orgId/sites/:siteId/annotations

Request Body

Field	Type	Required	Description
`label`	`string`	Yes	Annotation label
`occurred_at`	`string`	Yes	Annotation date (ISO 8601)
`description`	`string`	No	Optional longer description
`color`	`string`	No	Optional color for the marker

curl -X POST \ 'https://api.engagetrack.net/api/v1/organizations/{orgId}/sites/{siteId}/annotations' \ -H 'Authorization: Bearer <token>' \ -H 'Content-Type: application/json' \ -d '{ "label": "New pricing page launched", "occurred_at": "2024-03-01T00:00:00Z", "description": "Redesigned pricing page with annual plans", "color": "#4f46e5" }'

{ "success": true, "data": { "id": "ann_ghi789", "label": "New pricing page launched", "occurred_at": "2024-03-01T00:00:00Z", "description": "Redesigned pricing page with annual plans", "color": "#4f46e5", "created_by": { "id": "user_123", "name": "Jane Smith", "email": "[email protected]" }, "created_at": "2024-03-01T10:00:00Z" } }