Skip to main content
GET
Get revenue grouped by a chosen column
Returns total revenue broken down by metric_column. The required metric_column query parameter selects the dimension to group by - for example pathname, referrer, utm_source, or location.

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>
required

Column to group revenue by. Use channel for the 12-channel acquisition classifier (see docs/channels.md). Unknown values return zero rows.

Available options:
pathname,
origin,
channel,
referrer,
referrer_url,
ref,
utm_source,
utm_medium,
utm_campaign,
utm_content,
utm_term,
builder_codes,
location,
device,
browser,
os,
rdns,
provider_name,
chain_id,
event
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

Revenue by metric

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