Annotations
Create Annotation
Pins a note to a date or date range on the site's traffic chart.
POST /api/sites/:site/annotationsCreates an annotation. Any member with access to the site can create site annotations; organization-wide annotations (scope: "organization") require an admin or owner role.
Path Parameters
Prop
Type
Request Body
Prop
Type
Response
Prop
Type
Example
curl -X POST "https://app.onyxmetric.com/api/sites/123/annotations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Deployed v2.3.0",
"date": "2026-08-24T14:10:00Z",
"color": "sky",
"scope": "organization"
}'{ "success": true, "annotationId": 43 }