Skip to main content
GET
Get KPIs (sessions, pageviews, bounce rate, session duration)
Returns the same KPI series that powers the Formo dashboard’s overview chart. Here sessions is the per-day session count (the overview’s Sessions card), while visitors (and visitors_current / visitors_previous) are unique anonymous visitors (the overview’s Visitors card), returned only when include_previous_period=true and no group_by is set. Use group_by to break results down by referrer, location, device, browser, os, or any UTM dimension. Set include_previous_period=true to also receive the equivalent prior window for week-over-week comparisons.

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.

group_by
enum<string>

Dimension to break down by

Available options:
referrer,
location,
device,
browser,
os,
utm_source,
utm_medium,
utm_campaign
limit
integer
include_previous_period
boolean

Return current and previous period for WoW comparison

Response

KPI time-series

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