Get user lifecycle stages (New / Returning / Power user / At Risk / Churned / Resurrected)
Counts wallet users by lifecycle stage based on activity within the date range. The reference date is date_to.
Default stage thresholds can be overridden per-request with the lifecycle threshold query params (new_window_days, churn_window_days, power_user_min_active_days, power_user_window_days, resurrected_gap_days, at_risk_min_days_inactive, at_risk_prior_active_days_threshold); each is an optional integer 1 to 90. When omitted, the project's saved Settings → Lifecycle values apply, then the platform defaults.
Request
- Base URL: https://api.formo.so
- URL: https://api.formo.so/v0/lifecycle
- Auth: HTTP bearer
Query parameters
Inclusive start date (YYYY-MM-DD). Defaults to 7 days before date_to.
Inclusive end date (YYYY-MM-DD). Defaults to today.
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.
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.
JSON array filtering users by event-based behavior with counts and either an absolute date range or a window relative to the user's first event. Each entry is { event, op, times, date_from?, date_to?, event_type?, relative_to?, window? }. When relative_to: "first_seen" is set, the matching events must occur within window.value window.unit (hour | day) after the user's first event; date_from/date_to are ignored. event_type narrows matching to a specific event-type column (page, connect, disconnect, chain, signature, transaction, track, decoded_log, detect, identify); for track and decoded_log the event field is the named identifier; for other types only the type column is matched.
JSON array filtering users by raw event source. Entries use the canonical envelope and field must be source; accepted values are web, mobile, api, import, server, and onchain. Distinct from channel_filter, which matches the classified acquisition channel. Overview endpoints carry the same raw event source through the general filters parameter as field: "channel".
JSON array filtering users by classified acquisition channel. Entries use the canonical envelope and field must be channel_type. Distinct from source_filter, which matches the raw event source.
Override: a wallet is New if first seen within this many days of the reference date (default 30). Caller value wins over the project's saved setting.
Override: a wallet is Churned once last seen this many days before the reference date (default 30).
Override: distinct active days within the power-user window required to qualify as Power user (default 5).
Override: trailing window in which active days are counted for Power user qualification (default 30).
Override: minimum inactivity gap that marks a re-engaging wallet as Resurrected (default 30).
Override: minimum days since last activity for an established, still-active wallet to be At Risk (default 14; must be < churn_window_days).
Override: minimum active days a wallet had in the window before the recent quiet stretch to qualify as At Risk (default 1).
Response
Lifecycle counts
Changes
No recorded changes to this operation across all 1 revision of this API.