VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Get started
Introduction
Quickstart
How Voidhash works
Glossary
Versions and releases
Concepts
Teams, projects and environments
API keys
Products and perks
Offers
Subscription lifecycle
People and identity
Events
Features
Paywalls in your app
Feature flags and A/B tests
Paywall components
Push notifications
Ad attribution in your app
Client SDKs
React Native
Swift
Kotlin
Web
Your backend
Node.js
PHP
Go
Rust
Other languages
Payment sources
Forward store notifications
Developer tools
CLI
MCP server
Query analytics with VoidQL
CLI
CLI reference
Commands
Sign-in and projects
People and access
Catalog and payments
Paywalls and components
Flags and experiments
Analytics and ads
Webhooks and push
Team and settings
Types, API and config

Analytics and ads

CLI commands for events, metrics, charts, alerts, ad accounts and ad reports.

These commands read events and business metrics, run the charts Studio shows, manage alerts, and connect and report on Meta ad accounts.

Events

CommandWhat it doesKey flags
events listThe latest events, newest first.--name, --person, --limit (default 25)
events tailShows events as they arrive, until Ctrl+C.--name, --person, --interval (default 2 seconds), --count
events policy viewWhich built-in events are stored and which custom events are blocked.
events policy enable [event]Starts storing a built-in event, such as $pageview.
events policy disable [event]Stops storing a built-in event. Asks first.
events policy block [event]Stops storing a custom event. Asks first.
events policy unblock [event]Stores a blocked custom event again.

See Events for built-in and custom events.

Metrics and charts

Reports take a period of complete days: --last 30d (also 7d, 4w, 3m, 1y) ends yesterday, and --from 2026-09-01 --to 2026-09-30 names the days. Where a report takes --environment, it reads production purchases by default, or sandbox or test ones; see environments.

CommandWhat it doesKey flags
insights listThe built-in metrics insights run takes.
insights run [insight…]Runs metrics such as mrr or "trial conversion rate" over a period.--last, --by hour|day|week|month|quarter|year, --product, --environment (also all), --compare
analytics chartsThe charts Studio shows, by what they answer.--section
analytics chart <chart>Runs one chart, such as retention or paywall conversion.--last, --by, --dimension, --metric, --timezone
analytics acquisitionWho each network, campaign, ad set, ad or surface brought in, and what they paid.--by network|campaign|adset|ad|surface, --network, --campaign, --attribution-window-days, --key-conversion signup|trial|payer, --currency, --environment
analytics cohortsRevenue of weekly acquisition cohorts by day 0, 7, 30, 90, 180 and 365.--by surface|network|campaign|adset, --currency, --environment
analytics healthWeb page views by host, app SDKs and versions, and web-to-app handoffs.

analytics charts --section takes overview, revenue, subscribers, trials, churn, audience, paywalls, acquisition, web, app, locations, push or health.

analytics acquisition, analytics cohorts and analytics chart cut days in UTC unless --timezone says otherwise. The first two report money in USD unless --currency says otherwise.

Alerts

CommandWhat it doesKey flags
analytics alerts listAlerts and how each stood at its latest hourly check.
analytics alerts createAdds an alert.--name, --kind event_count|failure_share|volume_drop, --event, --success-event, --window-hours 1|6|24|168, --threshold, --min-people (default 2)
analytics alerts enable <alert>Turns an alert back on.
analytics alerts disable <alert>Turns an alert off without deleting it.
analytics alerts delete <alert>Deletes an alert. Asks first.

--threshold is a count of at least 1 for event_count, and a share between 0 and 1 for failure_share and volume_drop, such as 0.2 for 20%; Studio asks for a percentage. --success-event is for failure_share only, and --min-people for event_count only; use 1 when one person matters. enable, disable and delete take an alert's ID or exact name. To change what an alert watches, use Studio, the API or the update_analytics_alert MCP tool. Reading alerts needs project:analytics:read; changing them needs project:analytics:write.

voidhash analytics alerts create --name "Purchases failing" --kind failure_share \
  --event purchase_failed --success-event purchase_succeeded --window-hours 24 --threshold 0.2

Ads

CommandWhat it doesKey flags
ads accountsConnected ad accounts and their sync health.
ads connect [account]Connects a Meta ad account with a system user token, asked for hidden or piped in.--token-stdin, --backfill-days (default 90, at most 1,095)
ads disconnect [account]Disconnects an account and deletes what was synced from it. Asks first.
ads campaigns [campaign]Synced campaigns, or one campaign's ad groups and ads.--account, --status, --delivery, --destination, --search
ads report performanceWhat each campaign, ad group or ad spent and earned.--level campaign|ad-group|ad, --breakdown, --sort, --limit (default 50)
ads report creativesCreatives by spend, with fatigue signs.--format image|video|carousel, --search, --limit (default 25)
ads report cohortsPayback by acquisition cohort.--by platform|surface|campaign|ad-group, --unit week|month, --metric roas|revenue-per-payer|payers
ads issuesFailing syncs, rejected or held ads, and ads missing tracking parameters.
ads settings viewThe landing pages that mark website ads as web-to-app.
ads settings web-to-app [prefix…]Sets exactly those landing page prefixes.--clear
ads measurement viewWhether purchases reach Meta's Conversions API, and the install referrer key's state.
ads measurement editSets up the Conversions API and install referrer key. Enabling asks first.--enable, --disable, --dataset, --token, --token-stdin, --test-event-code, --install-referrer-key

Ads reports default to your ad accounts' time zone and currency. Tokens and keys are never passed as a flag's value. See Ad attribution in your app and Ad measurement.

Example

voidhash insights run mrr churn-rate --last 90d --by week --compare
voidhash events tail --name '$paywall_viewed'

Next steps

  • Metric definitions: how each metric is computed.
  • Alerts: alert kinds and thresholds.
  • Ad measurement: connect Meta and read ad reports.

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousFlags and experimentsNextWebhooks and push

On this page

EventsMetrics and chartsAlertsAdsExampleNext steps