Chart notes and annotations

Annotate analytics charts with notes for launches, campaigns and incidents, and get automatic notes for deploys, downtime, imports and Web Vitals regressions.

# Chart notes and annotations

> Annotate analytics charts with notes for launches, campaigns and incidents, and get automatic notes for deploys, downtime, imports and Web Vitals regressions.

Notes appear as pins on every chart. Each note has:

- a date or a date range,
- a title and optional Markdown text,
- an optional link,
- a color,
- a scope: this site, or all sites in the workspace.

Add one from the chart (click a date, or press `N`), from **Site settings →
Notes**, or through the API (for example from your deploy pipeline).

## Automatic notes

- **Deploys**: post a note with `source: "deploy"` from your CI or deploy
  script. **Site settings → Notes** shows a ready-to-copy `curl` command
  (it needs an API token with `content.write`).
- **Incidents**: when an [uptime check](/docs/features/uptime) linked to the
  site goes down.
- **Imports**: when historical data is added, spanning the imported dates.
- **Web Vitals regressions**: when a Core Web Vital gets more than 20%
  worse week over week.

以 Markdown 檢視

Notes appear as pins on every chart. Each note has:

a date or a date range,
a title and optional Markdown text,
an optional link,
a color,
a scope: this site, or all sites in the workspace.

Add one from the chart (click a date, or press N), from Site settings → Notes, or through the API (for example from your deploy pipeline).

Automatic notes#

Deploys: post a note with source: "deploy" from your CI or deploy script. Site settings → Notes shows a ready-to-copy curl command (it needs an API token with content.write).
Incidents: when an uptime check linked to the site goes down.
Imports: when historical data is added, spanning the imported dates.
Web Vitals regressions: when a Core Web Vital gets more than 20% worse week over week.