Query

Get top events by frequency

Most frequent events in the project. By default returns all event categories (page / track / identify / decoded_log / etc.). Pass type=custom to filter to custom track events only.

get/v0/top_events

Request

  • Base URL: https://api.formo.so
  • URL: https://api.formo.so/v0/top_events
  • Auth: HTTP bearer

Query parameters

date_fromstring date

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

date_tostring date

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

filtersstring

Array of filter conditions, JSON-encoded in the query string. Entries use { field, op, value } and are combined with implicit AND. For example, filter traffic referred by Google with [{"field":"referrer","op":"contains","value":"google"}], or filter a page with [{"field":"page","op":"eq","value":"/pricing"}]. For in / nin, pass a non-empty array value such as ["chrome","firefox"] or a pipe-delimited string such as "chrome|firefox". Array string members cannot contain a literal |, which is reserved as the Tinybird membership separator. Optional one-level nested filters use the same canonical envelope and membership rule. On the user-aggregate endpoints (lifecycle, frequency) the same array also carries profile-family entries: profile metrics (net_worth_usd, volume, revenue, points), social identity fields, a lifecycle entry ({"field":"lifecycle","op":"in","value":"New|Power user"}), and resource entries using the stable fields chains.balance, apps.balance, tokens.balance, and labels.value with named qualifier properties (chain_id, app_id, token_address, scope, tag_id). The retired per-family parameters (socials, chain_filters, app_filters, token_filters, label_filters, profile_filters, lifecycle_filter) are rejected. Overview also accepts raw Data source filters with field set to channel, ops eq/neq/in/nin, and values web, mobile, api, import, server, onchain; this is distinct from acquisition Channel (channel_type) and the two can be combined.

page_scope'page' | 'session'

Controls how a page filter is interpreted. page (default) scopes metrics to activity on the filtered page. On /v0/kpis, pageviews counts only views of the filtered page, while bounce_rate and avg_session_sec are entry-page metrics for sessions that landed there. session preserves the legacy session scope: metrics include all relevant activity in any session that viewed the page. sessions and visitors are unchanged between scopes. This parameter only affects requests that include a page filter. It is distinct from /v0/top_pages mode, which selects the all, entry, or exit page-flow view.

limitinteger

Maximum results to return (default 50, max 1000)

offsetinteger

Number of results to skip for pagination (default 0)

type'custom'

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

Response

Top events

dataobject[]
rowsinteger
rows_before_limit_at_leastinteger
statisticsobject

Changes

No recorded changes to this operation across all 1 revision of this API.