Annotations
Mark deploys, campaigns, email sends and content pushes on your charts, from the dashboard or the API.
Annotations are markers you place on the traffic chart, next to the markers Numative creates itself from detected changes and Google algorithm updates. When traffic moves, the chart already shows what happened around that moment: a deploy, a campaign, a newsletter send.
Adding annotations
Click Add annotation on the dashboard and set:
- Title: what happened, for example "v2.4.0" or "Product Hunt launch".
- Kind: note, deploy / release, campaign, email send, content push or other. The kind sets the marker's icon.
- When: date and time, prefilled with now.
- URL (optional): a link to the release, campaign or post, opened from the marker.
Annotating from CI or scripts
The same markers can be created over HTTP with a write-scoped API key, which is how you annotate every deploy automatically:
curl -X POST https://app.numative.com/api/v1/annotations \
-H "Authorization: Bearer YOUR_WRITE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain": "example.com", "title": "v2.4.0", "kind": "deploy", "url": "https://github.com/you/repo/releases/v2.4.0"}'The endpoint also supports listing and deleting annotations; see the Stats API reference.