API

API Overview

Use website API keys for public API routes. Dashboard routes require a signed-in user session.

Authentication

X-API-Key: YOUR_WEBSITE_API_KEY is also accepted for public API v1 routes.

http
Authorization: Bearer YOUR_WEBSITE_API_KEY

Public routes

MethodRoutePurpose
POST/api/trackTracker ingestion
POST/api/track-paymentHosted checkout fallback ingestion
POST/api/v1/goalsCreate server-side goals
DELETE/api/v1/goalsDelete matching goals
POST/api/v1/paymentsCreate server-side payments
DELETE/api/v1/paymentsDelete matching payments
GET/api/v1/analytics/*Query analytics metrics
GET/api/v1/visitors/{id}Query one visitor timeline

Common query filters

  • from/to filter by reporting date (YYYY-MM-DD).
  • startAt/endAt are accepted aliases for date or ISO 8601 date-time inputs.
  • timezone controls day boundaries.
  • country, region, city, referrer, ref, via, source, device_type, device, browser, os, utm_source, utm_medium, utm_campaign, utm_term, utm_content, page, entry_page, hostname, and goal_id filter analytics responses where supported.