CLI

CLI command reference

On this page

Account and websites
Analytics (read access)
Visitors (visitor details access)
Changes (write access)
Shell completion
Details

Run metricraven <command> --help for the options of any command. Dated reports accept the period and filter flags.

Account and websites

Command	Does
login / logout	Save the access token after checking it, or remove it.
whoami	The account, the token's access and the websites it can use.
websites list	Websites the token can use; * marks the default.
websites create --name --domain	Add a website (write access, token for all websites). Prints its ID, secret key (once) and tracking script.
use <website_id>	Save the default website.

Analytics (read access)

Command	Shows
analytics traffic	Totals with change vs the previous period, and the top channels, pages and countries.
analytics breakdown <dimension>	A full table for channel, referrer, page, entryPage, utmSource, utmCampaign, country, city, browser, device, outbound and more. Options --sort visitors\|pageviews\|revenue, --limit, --offset, --q.
analytics revenue	Payments, renewals, refunds, lifetime value and revenue by channel.
analytics conversions	Goals and funnel steps.
analytics goal <name>	One goal with its sources and properties.
analytics insights	What turns visitors into buyers and how long they take.
analytics search	Google Search Console queries (when connected).
analytics crawlers	AI crawlers and bots.
realtime	Visitors online now.
funnels list	Saved funnels and steps.
notes list	Chart notes in the period.

Visitors (visitor details access)

Command	Shows
visitors list	Visitors in the period. Options --q, --payment all\|paid\|unpaid, --sort latest\|earliest\|pageviews, --limit, --offset.
visitors get <visitor_id>	One visitor's summary and journey.

Changes (write access)

Command	Does
notes add --text [--date YYYY-MM-DD]	Adds a chart note, dated today by default.

Shell completion

terminal

# zsh: add to ~/.zshrc
eval "$(metricraven completion zsh)"
# bash: add to ~/.bashrc
eval "$(metricraven completion bash)"
# fish
metricraven completion fish > ~/.config/fish/completions/metricraven.fish

Details

Exit code 1 on any error, with a message that names missing access, e.g. when a token lacks visitor details.
--json prints the API response unchanged, the same shapes as the Reports API.