CLI command reference

Every command is generated from the same OpenAPI document that serves the API, so a command exists here only if the endpoint behind it exists. Commands are named after their path: GET /v1/stats/overview is traceten stats overview. Each command takes the flags listed below plus the global flags. A flag is the endpoint’s parameter with underscores replaced by dashes, so site_id is --site-id (aliased to --site). What each parameter means, and what comes back, is on the matching API reference page. A flag marked (JSON) takes a JSON literal, quoted for your shell: --steps '[{"kind":"pageview","match":"exact","value":"/pricing"}]'. A flag marked (flag) is a boolean and takes no value. Everything else is a plain string or number. Which permission a command needs is the endpoint’s permission. The maintained table is Which endpoints need which permission, and a 403 names the one you are missing in required_scope. Commands marked --yes refuse to run without it. They are the same operations the MCP server gates behind a confirmation, plus the ones the MCP does not expose at all.

account

Command	Calls	Required flags	Credential	`--yes`
`traceten account api-keys-create`	`POST /v1/account/api-keys`	none	an API key	yes
`traceten account api-keys-list`	`GET /v1/account/api-keys`	none	an API key	no
`traceten account api-keys-revoke`	`DELETE /v1/account/api-keys/{keyId}`	`--key-id`	an API key	yes
`traceten account api-keys-revoked`	`GET /v1/account/api-keys/revoked`	none	an API key	no
`traceten account bot-tokens-create`	`POST /v1/account/bot-tokens`	`--site-id`	an API key	yes
`traceten account bot-tokens-list`	`GET /v1/account/bot-tokens`	none	an API key	no
`traceten account bot-tokens-revoke`	`DELETE /v1/account/bot-tokens/{tokenId}`	`--token-id`	an API key	yes
`traceten account get`	`GET /v1/account`	none	an API key	no
`traceten account usage`	`GET /v1/account/usage`	none	an API key	no

ai-crawls

Command	Calls	Required flags	Credential	`--yes`
`traceten ai-crawls by-page`	`GET /v1/ai-crawls/by-page`	`--site-id`	an API key	no
`traceten ai-crawls recent`	`GET /v1/ai-crawls/recent`	`--site-id`	an API key	no
`traceten ai-crawls series`	`GET /v1/ai-crawls/series`	`--site-id`	an API key	no
`traceten ai-crawls summary`	`GET /v1/ai-crawls/summary`	`--site-id`	an API key	no
`traceten ai-crawls timeline`	`GET /v1/ai-crawls/timeline`	`--site-id`	an API key	no

annotations

Command	Calls	Required flags	Credential	`--yes`
`traceten annotations create`	`POST /v1/annotations`	`--site-id`, `--date`, `--note`	an API key	no
`traceten annotations delete`	`DELETE /v1/annotations/{id}`	`--id`, `--site-id`	an API key	yes
`traceten annotations get`	`GET /v1/annotations/{id}`	`--id`, `--site-id`	an API key	no
`traceten annotations list`	`GET /v1/annotations`	`--site-id`, `--from`, `--to`	an API key	no
`traceten annotations update`	`PATCH /v1/annotations/{id}`	`--id`, `--site-id`	an API key	with `--note`

breakdowns

Command	Calls	Required flags	Credential	`--yes`
`traceten breakdowns ai-sources`	`GET /v1/breakdowns/ai-sources`	`--site-id`	an API key	no
`traceten breakdowns browsers`	`GET /v1/breakdowns/browsers`	`--site-id`	an API key	no
`traceten breakdowns campaigns`	`GET /v1/breakdowns/campaigns`	`--site-id`	an API key	no
`traceten breakdowns cities`	`GET /v1/breakdowns/cities`	`--site-id`	an API key	no
`traceten breakdowns countries`	`GET /v1/breakdowns/countries`	`--site-id`	an API key	no
`traceten breakdowns devices`	`GET /v1/breakdowns/devices`	`--site-id`	an API key	no
`traceten breakdowns exit-links`	`GET /v1/breakdowns/exit-links`	`--site-id`	an API key	no
`traceten breakdowns hostnames`	`GET /v1/breakdowns/hostnames`	`--site-id`	an API key	no
`traceten breakdowns operating-systems`	`GET /v1/breakdowns/operating-systems`	`--site-id`	an API key	no
`traceten breakdowns pages`	`GET /v1/breakdowns/pages`	`--site-id`	an API key	no
`traceten breakdowns referrers`	`GET /v1/breakdowns/referrers`	`--site-id`	an API key	no
`traceten breakdowns source-kinds`	`GET /v1/breakdowns/source-kinds`	`--site-id`	an API key	no

detection

Command	Calls	Required flags	Credential	`--yes`
`traceten detection coverage`	`GET /v1/detection/coverage`	`--site-id`	an API key	no
`traceten detection quality`	`GET /v1/detection/quality`	`--site-id`	an API key	no

events

Command	Calls	Required flags	Credential	`--yes`
`traceten events recent`	`GET /v1/events/recent`	`--site-id`	an API key	no

funnels

Command	Calls	Required flags	Credential	`--yes`
`traceten funnels create`	`POST /v1/funnels`	`--site-id`, `--name`, `--steps` (JSON)	an API key	no
`traceten funnels delete`	`DELETE /v1/funnels/{id}`	`--id`, `--site-id`	an API key	yes
`traceten funnels list`	`GET /v1/funnels`	`--site-id`	an API key	no
`traceten funnels results`	`GET /v1/funnels/{id}/results`	`--id`, `--site-id`	an API key	no
`traceten funnels steps-visitors`	`GET /v1/funnels/{id}/steps/{position}/visitors`	`--id`, `--position`, `--site-id`	an API key	no
`traceten funnels update`	`PATCH /v1/funnels/{id}`	`--id`, `--site-id`	an API key	no

goals

Command	Calls	Required flags	Credential	`--yes`
`traceten goals archive`	`DELETE /v1/goals/{id}`	`--id`, `--site-id`	an API key	yes
`traceten goals create`	`POST /v1/goals`	`--site-id`, `--name`	an API key	no
`traceten goals list`	`GET /v1/goals`	`--site-id`	an API key	no
`traceten goals properties`	`GET /v1/goals/{name}/properties`	`--name`, `--site-id`	an API key	no
`traceten goals timeseries`	`GET /v1/goals/timeseries`	`--site-id`	an API key	no
`traceten goals unarchive`	`POST /v1/goals/{id}/unarchive`	`--id`, `--site-id`	an API key	no
`traceten goals update`	`PATCH /v1/goals/{id}`	`--id`, `--site-id`	an API key	no
`traceten goals visitors`	`GET /v1/goals/{name}/visitors`	`--name`, `--site-id`	an API key	no

integrations

Command	Calls	Required flags	Credential	`--yes`
`traceten integrations list`	`GET /v1/integrations`	none	an API key	no

revenue

Command	Calls	Required flags	Credential	`--yes`
`traceten revenue breakdown`	`GET /v1/revenue/breakdown`	`--site-id`	an API key	no
`traceten revenue ltv`	`GET /v1/revenue/ltv`	`--site-id`	an API key	no
`traceten revenue sku-breakdown`	`GET /v1/revenue/sku-breakdown`	`--site-id`	an API key	no
`traceten revenue timeseries`	`GET /v1/revenue/timeseries`	`--site-id`	an API key	no

sessions

Command	Calls	Required flags	Credential	`--yes`
`traceten sessions detail`	`GET /v1/sessions/{id}/detail`	`--id`, `--site-id`	an API key	no
`traceten sessions journey`	`GET /v1/sessions/{id}/journey`	`--id`, `--site-id`	an API key	no
`traceten sessions list`	`GET /v1/sessions`	`--site-id`	an API key	no

sites

Command	Calls	Required flags	Credential	`--yes`
`traceten sites create`	`POST /v1/sites`	`--domain`	an API key	yes
`traceten sites delete`	`DELETE /v1/sites/{siteId}`	`--site-id`, `--confirm-domain`	an API key	yes
`traceten sites get`	`GET /v1/sites/{siteId}`	`--site-id`	an API key	no
`traceten sites list`	`GET /v1/sites`	none	an API key	no
`traceten sites restore`	`POST /v1/sites/{siteId}/restore`	`--site-id`	an API key	no
`traceten sites update`	`PATCH /v1/sites/{siteId}`	`--site-id`	an API key	with `--cookie-apex-domain`

sources

Command	Calls	Required flags	Credential	`--yes`
`traceten sources breakdown`	`GET /v1/sources/breakdown`	`--site-id`	an API key	no

stats

Command	Calls	Required flags	Credential	`--yes`
`traceten stats metadata`	`GET /v1/stats/metadata`	`--site-id`	an API key	no
`traceten stats overview`	`GET /v1/stats/overview`	`--site-id`	an API key	no
`traceten stats realtime`	`GET /v1/stats/realtime`	`--site-id`	an API key	no
`traceten stats timeseries`	`GET /v1/stats/timeseries`	`--site-id`	an API key	no

team

Command	Calls	Required flags	Credential	`--yes`
`traceten team list`	`GET /v1/team`	none	an API key	no

visibility

Command	Calls	Required flags	Credential	`--yes`
`traceten visibility brands-archive`	`DELETE /v1/visibility/brands/{id}`	`--id`, `--site-id`	an API key	yes
`traceten visibility brands-confirm`	`POST /v1/visibility/brands/{id}/confirm`	`--id`, `--site-id`	an API key	no
`traceten visibility brands-create`	`POST /v1/visibility/brands`	`--site-id`, `--name`, `--kind`	an API key	no
`traceten visibility brands-list`	`GET /v1/visibility/brands`	`--site-id`	an API key	no
`traceten visibility brands-update`	`PATCH /v1/visibility/brands/{id}`	`--id`, `--site-id`	an API key	no
`traceten visibility by-prompt`	`GET /v1/visibility/by-prompt`	`--site-id`	an API key	no
`traceten visibility citations`	`GET /v1/visibility/citations`	`--site-id`	an API key	no
`traceten visibility citations-by-page`	`GET /v1/visibility/citations/by-page`	`--site-id`	an API key	no
`traceten visibility competitors`	`GET /v1/visibility/competitors`	`--site-id`	an API key	no
`traceten visibility prompts-archive`	`DELETE /v1/visibility/prompts/{id}`	`--id`, `--site-id`	an API key	yes
`traceten visibility prompts-create`	`POST /v1/visibility/prompts`	`--site-id`, `--text`, `--intent`	an API key	no
`traceten visibility prompts-list`	`GET /v1/visibility/prompts`	`--site-id`	an API key	no
`traceten visibility prompts-replace`	`POST /v1/visibility/prompts/{id}/replace`	`--id`, `--site-id`	an API key	no
`traceten visibility prompts-suggest`	`POST /v1/visibility/prompts/suggest`	`--site-id`	an API key	no
`traceten visibility prompts-update`	`PATCH /v1/visibility/prompts/{id}`	`--id`, `--site-id`	an API key	no
`traceten visibility runs`	`GET /v1/visibility/runs`	`--site-id`	an API key	no
`traceten visibility summary`	`GET /v1/visibility/summary`	`--site-id`	an API key	no
`traceten visibility timeseries`	`GET /v1/visibility/timeseries`	`--site-id`	an API key	no

visitors

Command	Calls	Required flags	Credential	`--yes`
`traceten visitors get`	`GET /v1/visitors/{handle}`	`--handle`, `--site-id`	an API key	no
`traceten visitors list`	`GET /v1/visitors`	`--site-id`	an API key	no
`traceten visitors timeline`	`GET /v1/visitors/{handle}/timeline`	`--handle`, `--site-id`	an API key	no

webhooks

Command	Calls	Required flags	Credential	`--yes`
`traceten webhooks create`	`POST /v1/sites/{siteId}/webhooks`	`--site-id`, `--url`	an API key	yes
`traceten webhooks delete`	`DELETE /v1/sites/{siteId}/webhooks/{webhookId}`	`--site-id`, `--webhook-id`	an API key	yes
`traceten webhooks deliveries`	`GET /v1/sites/{siteId}/webhooks/{webhookId}/deliveries`	`--site-id`, `--webhook-id`	an API key	no
`traceten webhooks list`	`GET /v1/sites/{siteId}/webhooks`	`--site-id`	an API key	no
`traceten webhooks rotate-secret`	`POST /v1/sites/{siteId}/webhooks/{webhookId}/rotate-secret`	`--site-id`, `--webhook-id`	an API key	yes
`traceten webhooks test`	`POST /v1/sites/{siteId}/webhooks/{webhookId}/test`	`--site-id`, `--webhook-id`	an API key	no
`traceten webhooks update`	`PATCH /v1/sites/{siteId}/webhooks/{webhookId}`	`--site-id`, `--webhook-id`	an API key	yes

Optional flags, by command

Command	Optional flags
`traceten account api-keys-create`	`--name`, `--scopes` (JSON), `--site-id`, `--expires-at`
`traceten account bot-tokens-create`	`--name`
`traceten account bot-tokens-list`	`--site-id`
`traceten ai-crawls by-page`	`--from`, `--to`, `--limit`, `--verification`, `--category`, `--provider`, `--path`
`traceten ai-crawls recent`	`--from`, `--to`, `--limit`
`traceten ai-crawls series`	`--from`, `--to`, `--dimension`, `--measure`, `--category`, `--path`, `--provider`, `--limit`
`traceten ai-crawls summary`	`--from`, `--to`
`traceten ai-crawls timeline`	`--from`, `--to`, `--by`, `--category`, `--provider`, `--limit`
`traceten annotations list`	`--limit`, `--offset`
`traceten annotations update`	`--date`, `--note`
`traceten breakdowns ai-sources`	`--from`, `--to`, `--limit`
`traceten breakdowns browsers`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns campaigns`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns cities`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns countries`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns devices`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns exit-links`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`, `--dimension`, `--value`
`traceten breakdowns hostnames`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`, `--dimension`, `--value`
`traceten breakdowns operating-systems`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns pages`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns referrers`	`--from`, `--to`, `--timezone`, `--limit`, `--offset`, `--fields`
`traceten breakdowns source-kinds`	`--from`, `--to`, `--limit`
`traceten detection coverage`	`--from`, `--to`
`traceten detection quality`	`--from`, `--to`
`traceten events recent`	`--limit`, `--days`
`traceten funnels create`	`--slug`, `--is-active` (flag), `--window-seconds`
`traceten funnels results`	`--from`, `--to`, `--filters`
`traceten funnels steps-visitors`	`--from`, `--to`, `--outcome`, `--page`, `--page-size`, `--filters`
`traceten funnels update`	`--name`, `--slug`, `--is-active` (flag), `--window-seconds`, `--steps` (JSON)
`traceten goals create`	`--display-name`, `--emoji`, `--sort-order`
`traceten goals list`	`--include-archived`
`traceten goals properties`	`--from`, `--to`
`traceten goals timeseries`	`--from`, `--to`
`traceten goals update`	`--display-name`, `--emoji`, `--sort-order`
`traceten goals visitors`	`--from`, `--to`, `--page`, `--page-size`
`traceten integrations list`	`--site-id`
`traceten revenue breakdown`	`--from`, `--to`, `--days`, `--attribution-model`, `--source-kind`
`traceten revenue ltv`	`--page`, `--page-size`
`traceten revenue sku-breakdown`	`--from`, `--to`, `--days`, `--ai-source`
`traceten revenue timeseries`	`--from`, `--to`, `--days`, `--attribution-model`, `--source-kind`, `--interval`
`traceten sessions list`	`--from`, `--to`, `--page`, `--page-size`, `--source`, `--method`, `--min-confidence`, `--converted`, `--q`, `--campaign`, `--sort`, `--dir`
`traceten sites create`	`--name`, `--region`, `--cookie-apex-domain`
`traceten sites list`	`--include-deleted`
`traceten sites update`	`--name`, `--attribution-model`, `--cookie-apex-domain`, `--currency`
`traceten sources breakdown`	`--from`, `--to`, `--days`
`traceten stats overview`	`--from`, `--to`, `--timezone`, `--fields`
`traceten stats realtime`	`--minutes`
`traceten stats timeseries`	`--from`, `--to`, `--timezone`, `--fields`, `--granularity`
`traceten visibility brands-create`	`--aliases` (JSON), `--domains` (JSON)
`traceten visibility brands-list`	`--include-archived`
`traceten visibility brands-update`	`--name`, `--kind`, `--aliases` (JSON), `--domains` (JSON)
`traceten visibility by-prompt`	`--from`, `--to`, `--engine`, `--brand-id`, `--limit`, `--offset`
`traceten visibility citations`	`--from`, `--to`, `--is-owned`, `--limit`
`traceten visibility citations-by-page`	`--from`, `--to`, `--limit`
`traceten visibility competitors`	`--from`, `--to`, `--prompt-id`, `--engine`
`traceten visibility prompts-create`	`--origin`, `--topic`, `--locale`, `--status`
`traceten visibility prompts-list`	`--status`
`traceten visibility prompts-replace`	`--text`, `--locale`, `--topic`, `--intent`
`traceten visibility prompts-update`	`--topic`, `--intent`, `--status`
`traceten visibility runs`	`--from`, `--to`, `--prompt-id`, `--engine`, `--brand-id`, `--present`, `--limit`, `--offset`
`traceten visibility summary`	`--from`, `--to`, `--prompt-id`, `--engine`, `--brand-id`
`traceten visibility timeseries`	`--from`, `--to`, `--prompt-id`, `--engine`, `--brand-id`
`traceten visitors get`	`--from`, `--to`, `--tz`
`traceten visitors list`	`--from`, `--to`, `--page`, `--page-size`, `--sort`, `--dir`, `--filter-device`, `--filter-os`, `--filter-browser`, `--filter-country`, `--filter-city`, `--filter-channel`, `--filter-source`, `--filter-campaign`, `--filter-ref`, `--filter-page`, `--filter-ai-source`
`traceten visitors timeline`	`--from`, `--to`, `--page`, `--page-size`
`traceten webhooks create`	`--event-types` (JSON)
`traceten webhooks deliveries`	`--limit`, `--status`, `--before`
`traceten webhooks update`	`--url`, `--event-types` (JSON), `--enabled` (flag)

CLI overview for install, login and output.
API keys and permissions for what each permission grants.

Command line

CLI command reference

account

ai-crawls

annotations

breakdowns

detection

events

funnels

goals

integrations

revenue

sessions

sites

sources

stats

team

visibility

visitors

webhooks

Optional flags, by command

Next

​account

​ai-crawls

​annotations

​breakdowns

​detection

​events

​funnels

​goals

​integrations

​revenue

​sessions

​sites

​sources

​stats

​team

​visibility

​visitors

​webhooks

​Optional flags, by command

​Next

account

ai-crawls

annotations

breakdowns

detection

events

funnels

goals

integrations

revenue

sessions

sites

sources

stats

team

visibility

visitors

webhooks

Optional flags, by command

Next