Faurya CLI

Filters, Periods, and Pagination

Use Faurya CLI periods, date ranges, filters, limits, cursors, metrics, dimensions, and pagination controls.

Filters, Periods, and Pagination

Many analytics commands accept shared query controls. Command-specific help shows whether a command supports filters.

faurya analytics overview --help

Period shortcuts

Use --period with a shortcut period.

ValueMeaning
todayFrom the start of the current day to now.
yesterdayThe previous calendar day.
last24hThe last 24 hours.
lastNdThe last N days, such as last7d, last30d, or last90d.
faurya analytics overview <websiteId> --period last30d
faurya analytics timeseries <websiteId> --period last7d --granularity day

Explicit date ranges

Use --from and --to for an explicit ISO datetime range. You can also provide --timezone.

faurya analytics overview <websiteId> --from 2026-07-01T00:00:00.000Z --to 2026-07-19T00:00:00.000Z
faurya analytics goals <websiteId> --from 2026-07-01T00:00:00.000Z --to 2026-07-19T00:00:00.000Z --timezone UTC

Granularity

Supported --granularity values are hour, day, week, month, quarter, and year.

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

Repeatable filters

Use -F or --filter. You can repeat the flag to combine multiple filters.

faurya analytics visitors list <websiteId> --period last30d -F country=US -F device=desktop
faurya analytics events list <websiteId> --period last30d --filter event=signup

Filter syntax

The CLI accepts these forms:

SyntaxMeaning
field=valueEquality filter.
field:operator=valueFilter with an explicit operator.
field:in=a,b,cin filter with comma-separated values.
faurya analytics overview <websiteId> --period last30d -F country=US
faurya analytics revenue <websiteId> --period last30d -F revenue:gt=0
faurya analytics events list <websiteId> --period last30d -F event:in=signup,purchase

Supported filter fields

Short field names:

FieldCanonical focus
countryEvent country.
regionEvent region.
cityEvent city.
pathEvent page path.
hostnameEvent hostname.
browserEvent browser.
osEvent operating system.
deviceEvent device.
referrerEvent referrer.
sourceAcquisition source.
mediumAcquisition medium.
campaignAcquisition campaign.
revenueEvent or payment amount.
eventEvent name.
goalGoal event name.

Canonical field names are also accepted: event.country, event.region, event.city, event.path, event.hostname, event.browser, event.os, event.device, event.referrer, event.properties.source, event.properties.medium, event.properties.campaign, event.amount, and event.name.

Supported operators

OperatorMeaning
eq, equalsEqual to.
not, is_not, not_equalsNot equal to.
containsContains a substring.
inOne of multiple values.
gt, greater_thanGreater than.
gte, greater_than_or_equalGreater than or equal to.
lt, less_thanLess than.
lte, less_than_or_equalLess than or equal to.

in behavior

For command-line filters, in values are comma-separated. Do not include spaces unless the value itself requires quoting in your shell.

faurya analytics visitors list <websiteId> --period last30d -F country:in=US,CA,GB

Numeric revenue filters

Use numeric operators with revenue when filtering event or payment amount.

faurya analytics payments <websiteId> --period last30d -F revenue:gt=0
faurya analytics revenue <websiteId> --period last30d -F revenue:lte=1000000

Combining filters

Multiple -F or --filter flags are combined in the request.

faurya analytics overview <websiteId> --period last30d -F country=US -F browser=Chrome -F revenue:gt=0

For advanced nested filter objects, use Structured Input.

Limits and cursors

The CLI validates --limit as a positive integer up to 5000. Some commands apply a smaller command-specific maximum.

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

Use --cursor to continue pagination explicitly.

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

Pagination is not automatic. Continue each page yourself with the cursor returned by the previous command.

Metrics and dimensions

Use comma-separated values for --metrics and --dimensions.

faurya analytics overview <websiteId> --period last30d --metrics visitors,sessions,pageviews
faurya analytics breakdown <websiteId> country --period last30d --metrics visitors,sessions