Get Annotations | OnyxMetric

Returns the timeline annotations that apply to a site, including organization-wide ones.

GET /api/sites/:site/annotations

Returns the annotations pinned to the site's traffic chart, ordered by date. Organization-wide annotations (those with a null siteId) are included for every site in the organization.

Anonymous viewers of a public dashboard or a private link only receive annotations with isPublic: true.

Path Parameters

Prop

Type

Query Parameters

Prop

Type

Response

An array of annotation objects.

Prop

Type

Example

curl "https://app.onyxmetric.com/api/sites/123/annotations?start_date=2026-08-01&end_date=2026-08-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

[
  {
    "annotationId": 42,
    "siteId": 123,
    "organizationId": "org_abc",
    "userId": "user_xyz",
    "userName": "Bill",
    "title": "Product Hunt launch",
    "description": "Finished #2 Product of the Day.",
    "date": "2026-08-18T07:00:00.000Z",
    "endDate": null,
    "color": "amber",
    "icon": "🚀",
    "isPublic": true,
    "createdAt": "2026-08-18 07:05:12.1",
    "updatedAt": "2026-08-18 07:05:12.1"
  }
]