Documentation menu

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.

ResourceEndpointsWhat it covers
Sites5Create, inspect, configure and delete the websites you track. Every other resource hangs off a site, so start here to obtain a siteId.
Core analytics4Headline traffic metrics: aggregate stats, live visitors, pageview series and custom events.
Acquisition1Where your traffic comes from, grouped into GA4-style marketing channels.
Revenue4E-commerce reporting built on the revenue events sent by the tracker. All monetary amounts are integers in the smallest currency unit (cents).
Behaviour & performance4Cohort retention, navigation paths and Core Web Vitals.
Visitor profiles2Per-visitor records with lifetime pageview, event and revenue totals, plus an activity timeline.
Goals5Conversion goals. A `pageview` goal converts when a visitor loads a pathname; an `event` goal converts when a named custom event fires.
Funnels6Ordered multi-step paths through the site, plus their computed drop-off statistics.
Segments5Saved audience filters. Segments are PERSONAL to the API key owner — a team member never sees the site owner’s segments, and vice versa.
Alerts5Email alerts on traffic and goal conditions. Alerts are per-user: a team member only ever sees and manages their own.
Webhooks5HTTP callbacks for pageview, goal and alert events. Webhooks are per-user. Signing secrets are shown in full exactly once.
Annotations5Notes 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 reports5Recurring email summaries. Report configs are per-user subscriptions.