Skip to main content
GET
Get top traffic sources (referrers / utm)
Returns the top traffic sources for the project. Pass metric_column to switch between referrer, referrer_url, ref, origin, utm_source, utm_medium, utm_campaign, utm_term, utm_content, device, browser, os, and channel. Defaults to referrer. channel is a distinct option: instead of returning a raw dimension value, it classifies each session into a marketing acquisition channel (e.g. Organic Search, Paid Social, Direct, Referral) using Formo’s channel classifier, so you can see top-level channel performance without building the grouping logic yourself.

Authorizations

Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.

Query Parameters

date_from
string<date>

Inclusive start date (YYYY-MM-DD). Defaults to 7 days before date_to.

date_to
string<date>

Inclusive end date (YYYY-MM-DD). Defaults to today.

metric_column
enum<string>

Column to break down sources by. Use channel for the 12-channel acquisition classifier (see docs/channels.md).

Available options:
referrer,
referrer_url,
ref,
utm_source,
utm_medium,
utm_campaign,
utm_term,
utm_content,
origin,
device,
browser,
os,
channel
limit
integer
default:50

Maximum results to return (default 50, max 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of results to skip for pagination (default 0)

Required range: 0 <= x <= 100000

Response

Top sources

Analytics endpoint response. The data array contains the rows; the exact row shape depends on the endpoint. meta carries column type information for rendering, rows is the row count, and statistics holds query timing metadata.

data
object[]
meta
object[]
rows
integer
rows_before_limit_at_least
integer
statistics
object