Faurya CLI

Analytics

Use Faurya CLI analytics commands for overview, realtime, timeseries, breakdowns, visitors, sessions, events, journeys, goals, paths, cohorts, payments, revenue, attribution, AI crawls, and changes.

Analytics

Analytics commands are read-only. They query one website at a time and support output flags. Many commands also support periods, filters, pagination, metrics, dimensions, and structured input.

Use the catalog before building advanced queries:

faurya analytics catalog <websiteId>

Shared analytics flags

Commands marked as supporting data flags accept these options:

FlagPurpose
--period <period>Shortcut period such as today, yesterday, last24h, or last30d.
--from <ISO>Start of an explicit ISO datetime range.
--to <ISO>End of an explicit ISO datetime range.
--timezone <timezone>Timezone for shortcut or explicit ranges.
--granularity <unit>One of hour, day, week, month, quarter, year.
-F, --filter <expr>Repeatable filter expression.
--metrics <a,b>Comma-separated metric names.
--dimensions <a,b>Comma-separated dimension names.
--limit <n>Page size or result limit where supported.
--cursor <cursor>Continue a paginated query explicitly.

See Filters, Periods, and Pagination for accepted filter fields and operators.

Context and catalog

faurya analytics context <websiteId>

Shows website analytics context, data coverage, configured goals, currency/timezone, capabilities, and warnings.

faurya analytics context <websiteId>

faurya analytics catalog <websiteId>

Lists supported analytics vocabulary such as metrics, dimensions, operators, events, goals, granularities, and attribution options.

faurya analytics catalog <websiteId>

faurya analytics dimensions <websiteId> <field>

Lists values for one public dimension. Supported dimension-value fields are country, region, city, browser, os, device, referrer, path, hostname, source, medium, campaign, term, content, referrer_host, event_name, and goal_name.

faurya analytics dimensions <websiteId> country --period last30d --limit 25
faurya analytics dimensions <websiteId> campaign --from 2026-07-01T00:00:00.000Z --to 2026-07-19T00:00:00.000Z

Overview, timeseries, and breakdowns

faurya analytics overview <websiteId>

Runs semantic analytics overview queries. Use it for high-level traffic, conversion, or revenue summaries.

faurya analytics overview <websiteId> --period last30d
faurya analytics overview <websiteId> --period last7d --metrics visitors,sessions,pageviews -F country=US

faurya analytics timeseries <websiteId>

Runs the overview query in timeseries mode. Use --granularity to control bucket size.

faurya analytics timeseries <websiteId> --period last30d --granularity day --metrics visitors,sessions

faurya analytics breakdown <websiteId> <dimension>

Breaks analytics down by one dimension.

faurya analytics breakdown <websiteId> browser --period last30d --metrics visitors,sessions

Public top-value aliases

These aliases run top-value analytics for common dimensions:

CommandDimension focus
faurya analytics pages <websiteId>Page path.
faurya analytics referrers <websiteId>Referrer.
faurya analytics countries <websiteId>Country.
faurya analytics regions <websiteId>Region.
faurya analytics cities <websiteId>City.
faurya analytics browsers <websiteId>Browser.
faurya analytics os <websiteId>Operating system.
faurya analytics devices <websiteId>Device.
faurya analytics campaigns <websiteId>Campaign.
faurya analytics hostnames <websiteId>Hostname.
faurya analytics pages <websiteId> --period last30d --limit 20
faurya analytics campaigns <websiteId> --period last30d -F source=google

Realtime

faurya analytics realtime <websiteId>

Shows a recent active visitor and event snapshot for the website.

faurya analytics realtime <websiteId>

Visitors

faurya analytics visitors list <websiteId>

Lists visitors with filters and explicit pagination.

faurya analytics visitors list <websiteId> --period last30d --limit 50
faurya analytics visitors list <websiteId> --period last30d -F country=US -F device=desktop

faurya analytics visitors get <websiteId> <visitorId>

Reads one visitor profile and activity summary.

faurya analytics visitors get <websiteId> <visitorId>

faurya analytics visitors trace <websiteId> <visitorId>

Reads a chronological visitor trace. Use --limit and --cursor when you need to continue a long trace.

faurya analytics visitors trace <websiteId> <visitorId> --limit 100

Sessions

faurya analytics sessions list <websiteId>

Lists sessions with filters and explicit pagination.

faurya analytics sessions list <websiteId> --period last7d --limit 50

faurya analytics sessions get <websiteId> <sessionId>

Reads one reconstructed session timeline.

faurya analytics sessions get <websiteId> <sessionId>

Events

faurya analytics events list <websiteId>

Lists visible events with filters and explicit pagination.

faurya analytics events list <websiteId> --period last24h --limit 100
faurya analytics events list <websiteId> --period last30d -F event=signup

faurya analytics journeys find <websiteId>

Finds visitor or session journeys matching ordered behavior steps. It requires structured input with steps.

Accepted step fields:

FieldDetails
stepsArray with 1 to 10 ordered steps.
steps[].typeOptional page, event, or goal.
steps[].valuePage path, event name, or goal name.
scopeOptional visitor or session; default is session.
matchOptional strict or loose; default is loose.
limitOptional positive integer up to 200.
faurya analytics journeys find <websiteId> --input '{"steps":[{"type":"page","value":"/pricing"}]}'
faurya analytics journeys find <websiteId> --input '{"steps":[{"type":"page","value":"/"},{"type":"goal","value":"signup"}],"scope":"session","match":"loose","limit":50}'

Goals

faurya analytics goals <websiteId>

Analyzes goal completions, unique converters, conversion rates, and related breakdowns.

faurya analytics goals <websiteId> --period last30d
faurya analytics goals <websiteId> --period last30d --dimensions country,device

Paths

faurya analytics paths <websiteId>

Analyzes top visible paths. Use structured input for starting pages, ending pages, ending goals, and maximum depth.

FieldDetails
startingPageOptional page path to start from.
endingPageOptional page path to end at.
endingGoalOptional goal name to end at.
maximumDepthOptional positive integer up to 5.
faurya analytics paths <websiteId> --period last30d
faurya analytics paths <websiteId> --input '{"startingPage":"/","maximumDepth":4}'

Cohorts

faurya analytics cohorts <websiteId>

Analyzes first-seen, session, and acquisition cohorts with retention-related metrics.

faurya analytics cohorts <websiteId> --period last90d --granularity week

Payments and revenue

faurya analytics payments <websiteId>

Searches payment events with pagination. It accepts data flags, filters, and optional structured fields failed and transactionId.

faurya analytics payments <websiteId> --period last30d --limit 50
faurya analytics payments <websiteId> --period last30d -F revenue:gt=0
faurya analytics payments <websiteId> --input '{"failed":false,"transactionId":"transaction_id"}'

faurya analytics revenue <websiteId>

Analyzes tracked revenue, payments, paying visitors, and revenue metrics.

faurya analytics revenue <websiteId> --period last30d
faurya analytics revenue <websiteId> --period last30d --granularity day --metrics revenue,payments

Attribution

faurya analytics attribution <websiteId>

Analyzes attribution models and dimensions. Optional structured fields include model and dimension.

Supported attribution models are first_touch, last_touch, linear, position_based, time_decay, and session_source.

Supported attribution dimensions are referrer, campaign, source, medium, landing_page, country, and device.

faurya analytics attribution <websiteId> --period last30d
faurya analytics attribution <websiteId> --input '{"model":"last_touch","dimension":"campaign"}'

AI crawler analytics

faurya analytics ai-crawls <websiteId>

Queries AI crawler analytics. Optional structured fields include provider, agent, category, path, source, and limit.

faurya analytics ai-crawls <websiteId> --period last30d
faurya analytics ai-crawls <websiteId> --input '{"provider":"openai","limit":50}'

Change analysis

faurya analytics changes <websiteId>

Compares periods or segments for increases, decreases, and contributing dimensions. It accepts structured fields period, baselinePeriod, comparisonPeriod, metrics, and dimensions.

faurya analytics changes <websiteId> --input '{"baselinePeriod":{"start":"2026-06-01T00:00:00.000Z","end":"2026-06-30T23:59:59.999Z"},"comparisonPeriod":{"start":"2026-07-01T00:00:00.000Z","end":"2026-07-19T00:00:00.000Z"},"metrics":["visitors"],"dimensions":["country"]}'

Pagination behavior

The CLI does not automatically retrieve every page for paginated commands. If a command returns a cursor, continue explicitly with --cursor.

faurya analytics events list <websiteId> --period last30d --limit 100 --cursor <cursor>