Skip to content

Document paid_source on the revenue analytics pipes #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yosriady merged 1 commit into from
Aug 4, 2026
Merged

Document paid_source on the revenue analytics pipes #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion SKILLS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ formo analytics top_wallets --date-from 2026-04-01 --date-to 2026-04-30 --params
formo analytics retention --filters '[{"field":"location","op":"eq","value":"US"}]'
```

Each pipe accepts pipe-specific params via `--params` (see each command's `--help`): e.g. `funnel` → `steps`, `window_seconds`, `funnel_type`, `group_by`, `limit`, `attribution`; `kpis` → `group_by`, `limit`; `top_*` → `limit`, `offset`.
Each pipe accepts pipe-specific params via `--params` (see each command's `--help`): e.g. `funnel` → `steps`, `window_seconds`, `funnel_type`, `group_by`, `limit`, `attribution`; `kpis` → `group_by`, `limit`; `revenue_overview` → `group_by`, `rank_by`, `limit`; `revenue_by_metric` / `volume_by_metric` → `metric_column`, `limit`, `offset`; `top_*` → `limit`, `offset`. The revenue pipes accept `paid_source` (acquiring ad network) for `group_by` / `metric_column`, alongside `channel_type` / `channel`.

On `kpis`, `top_*`, `revenue_*` and `volume_by_metric`, `--params '{"page_scope":"session"}'` widens a `page` filter from page-scoped metrics (the default) to the legacy session scope.

Expand Down
6 changes: 3 additions & 3 deletions src/commands/analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ const PIPES: Array<{ name: string; description: string }> = [
{ name: 'frequency', description: 'Engagement frequency distribution' },
{ name: 'lifecycle', description: 'User lifecycle stages (new, returning, power, resurrected, churned)' },
{ name: 'retention', description: 'Retention cohort analysis (params: id_type, event_type, event_name, min_users)' },
{ name: 'revenue_overview', description: 'Revenue overview with optional breakdown (params: group_by, rank_by)' },
{ name: 'revenue_by_metric', description: 'Revenue ranked by a metric column (params: metric_column, limit, offset)' },
{ name: 'revenue_overview', description: 'Revenue overview with optional breakdown (params: group_by — incl. channel_type and paid_source for ad network, rank_by)' },
{ name: 'revenue_by_metric', description: 'Revenue ranked by a metric column (params: metric_column — incl. channel and paid_source for ad network, limit, offset)' },
{ name: 'revenue_timeseries', description: 'Revenue over time (params: address)' },
{ name: 'volume_by_metric', description: 'Trading volume ranked by a metric column (params: metric_column, limit, offset)' },
{ name: 'volume_by_metric', description: 'Trading volume ranked by a metric column (params: metric_column — incl. channel and paid_source for ad network, limit, offset)' },
{ name: 'top_chains', description: 'Top chains by activity (params: limit, offset)' },
{ name: 'top_events', description: 'Top events by count (params: limit, offset, type)' },
{ name: 'top_locations', description: 'Top locations (params: limit, offset)' },
Expand Down