Chart notes#
A site owner can mark a date, or a range of dates, with a short note such as a deploy, a launch, a blog post, or an outage.
The note is drawn on every time series that covers those days: the
visitor and pageview charts, and the compare charts. A single day is a
marker. A range is a band across the days it covers, with the same
marker text. Hover, focus, or tap shows the title, the note, and the
tags. A tag on the page, or tag on the timeseries request, limits
the notes and the markers. The visitor counts stay in place.
The weekly report lists the notes that overlap that Monday-through-Sunday week. The page, the print view, and the webhook JSON carry the title, the kind, the dates, the note text, and the tags. A scheduled report can include the same notes when its notes section is on. The live chart marks a note that falls on the site’s local today.
Add, edit, delete#
Open GET /annotations, choose the site, and add a title and a date.
Leave Through blank for one day, or set it to the last day of a range.
A range covers at most 366 days. Save changes the note. Delete removes
it. The note does not record who wrote it, and it is not tied to a
visitor.
POST /api/annotations accepts the same fields. ends_at is the
inclusive last day. tags is a list of short labels, stored lowercase.
kind is note, release, deploy, launch, post, or outage.
post is the blog post.
Suggested by an alert#
When an alert fires, the notes page suggests a note for that local day. The suggestion uses the alert’s count and label. Accept adds it to the charts. Dismiss leaves the charts unchanged. A suggestion is not drawn until it is accepted, and it is not sent again for a day that already has one.