Query

Get event count time-series

get/v0/event_timeseries

Request

  • Base URL: https://api.formo.so
  • URL: https://api.formo.so/v0/event_timeseries
  • 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.

excludestring

Comma-separated list of event types to exclude from results (e.g. identify,detect).

group_by'channel_type' | 'device' | 'browser' | 'os' | 'location' | 'referrer' | 'ref' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_content' | 'utm_term' | 'builder_codes'

Optional breakdown dimension. When set, event_key carries the dimension's value (empty → Direct) instead of the event type/name, so the series splits by that dimension. Top 100 values + Others.

Response

Event time-series

dataobject[]
rowsinteger
rows_before_limit_at_leastinteger
statisticsobject

Changes

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