Skip to main content

Analytics

Requires the analytics:read scope. Most endpoints are Pro+.

GET /api/links/{id}/analytics    # trend + by country/device/referrer/browser + totals
GET /api/links/{id}/heatmap      # clicks by weekday × hour
GET /api/links/{id}/events.csv   # raw events export (CSV)
GET /api/links/{id}/feed         # Server-Sent Events: live clicks

The feed endpoint is an SSE stream — connect with an EventSource and read data: JSON messages (country, device, referrer, variant, ts).

Account-wide​

GET /api/stats/overview      # totals + breakdowns across all your links
GET /api/stats/analytics?days=30
GET /api/stats/activity?limit=20
GET /api/stats/insights?days=7   # movers

days is capped at 90; the analytics window available depends on your plan (Free 30 · Pro 90 · Growth/Enterprise 365).

Public shared stats​

GET /api/public/s/{token}

Unauthenticated, read-only analytics for a link whose owner enabled public stats. Returns only non-sensitive fields (no owner data).