REST API reference
56 endpoints across 13 resources. All paths are relative to https://analytics.appfor.you, and every request needs a bearer API key — see Authentication & scopes and Conventions first.
Each resource has its own page so a phone only ever parses the part of the reference you asked for.
| Resource | Endpoints | What it covers |
|---|---|---|
| Sites | 5 | Create, inspect, configure and delete the websites you track. Every other resource hangs off a site, so start here to obtain a siteId. |
| Core analytics | 4 | Headline traffic metrics: aggregate stats, live visitors, pageview series and custom events. |
| Acquisition | 1 | Where your traffic comes from, grouped into GA4-style marketing channels. |
| Revenue | 4 | E-commerce reporting built on the revenue events sent by the tracker. All monetary amounts are integers in the smallest currency unit (cents). |
| Behaviour & performance | 4 | Cohort retention, navigation paths and Core Web Vitals. |
| Visitor profiles | 2 | Per-visitor records with lifetime pageview, event and revenue totals, plus an activity timeline. |
| Goals | 5 | Conversion goals. A `pageview` goal converts when a visitor loads a pathname; an `event` goal converts when a named custom event fires. |
| Funnels | 6 | Ordered multi-step paths through the site, plus their computed drop-off statistics. |
| Segments | 5 | Saved audience filters. Segments are PERSONAL to the API key owner — a team member never sees the site owner’s segments, and vice versa. |
| Alerts | 5 | Email alerts on traffic and goal conditions. Alerts are per-user: a team member only ever sees and manages their own. |
| Webhooks | 5 | HTTP callbacks for pageview, goal and alert events. Webhooks are per-user. Signing secrets are shown in full exactly once. |
| Annotations | 5 | Notes pinned to the analytics timeline — releases, campaigns, incidents, milestones. SITE-LEVEL for reading: everyone with site access sees all annotations. AUTHOR-ONLY for writing. |
| Scheduled reports | 5 | Recurring email summaries. Report configs are per-user subscriptions. |