Skip to main content
GET
Get top events by frequency
Returns the most frequently fired events in the project, by total event count. Pass type=custom to restrict results to custom events (events tracked via formo.track(...)). This replaces the previous top_custom_events endpoint.

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.

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
type
enum<string>

Pass 'custom' to filter to custom track events only (events with type='track' and a non-empty event name). Omit for all events.

Available options:
custom

Response

Top events

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