Skip to main content
GET
Get visit-frequency distribution
Returns how many users visited 1, 2, 3+ times in the selected window - the data behind the dashboard’s frequency histogram.

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.

lifecycle_filter
enum<string>

Restrict results to a single lifecycle stage.

Available options:
New,
Returning,
Power user,
Resurrected,
At Risk,
Churned
include_previous_period
boolean

When true, returns both current and previous period metrics for week-over-week comparison. The previous period is non-overlapping and equal in length to the current range.

Response

Visit frequency distribution

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