Stats
Click and UTM analytics read endpoints.
GET /stats/{scope_id}/breakdown
Breakdown by one dimension
Distribution of a chosen metric by one `dimension`: top-N values and an optional `(other)` tail row. One request per dashboard chart.
Behaviour
Path parameters
Query parameters
Responses
GET /stats/{scope_id}/geo
Click geo map (countries / regions / hex)
Choropleth by country (`mode=countries`), regions (`mode=regions&country=RU`) or hex heatmap (`mode=hex`). Hex needs raw retention. Countries/regions work from agg (`clicks_by_country` / `clicks_by_region`). `items[].key` is an ISO code for map matching; `items[].label` is the full human-readable name from `Accept-Language` (`ru`/`en`/`de`/`fr`; not an abbreviation or IP).
Path parameters
Query parameters
Responses
GET /stats/{scope_id}/overview
Overview scope/folder/short
Click summary for a scope, folder or single link: KPIs, a short daily series, top-N breakdowns and (for scope/folder) top links. One request on screen open or manual refresh — **not** for polling.
Behaviour
Path parameters
Query parameters
Responses
GET /stats/{scope_id}/ranking
Top entities within entity
Ordered top table for the selected window: links, targets, UTM campaigns, referrers, countries, etc. Suited for dashboard tables and ~60s polling.
Behaviour
Path parameters
Query parameters
Responses
GET /stats/{scope_id}/series
Time series for polling
Time series of metrics `(t, metrics…)` at `hour` or `day` granularity. Built for dashboard **polling** (recommended interval — at most once per minute).
Behaviour
Path parameters
Query parameters
Responses
GET /stats/{scope_id}/shorts/{short_id}
Short-link card: lifetime + window
Detailed card for one link: **lifetime** metrics (always available, including after detailed clicks are purged) and window KPIs with optional daily series and breakdowns.
Behaviour
Path parameters
Query parameters