attriboo reports overview

Read headline revenue, traffic, conversion and advertising metrics with comparison changes.

Access: OAuth analytics:read or workspace key

Options

attriboo reports overview options
Field	Type	Description
`--site`	`string`	Website ID or domain. Required when the workspace has more than one website.
`--period`	`string`	UTC date selection. from and to override period. Values: realtime, today, yesterday, 7d, 30d, 90d, 12m, wtd, mtd, qtd, ytd, all. Default: `30d`.
`--from`	`string`	Inclusive start date. Supply to as well.
`--to`	`string`	Inclusive end date. Supply from as well.
`--compare`	`string`	Comparison range. Values: previous_period, mom, qoq, yoy, none. Default: `previous_period`.
`--model`	`string`	How recorded sources share revenue credit. Values: first_touch, last_touch, linear, time_decay. Default: `first_touch`.
`--filters`	`string`	JSON array string of up to twenty visitor filters, for example [{"dim":"country","op":"is","value":"US"}]. Dimensions: source, channel, campaign, entry_page, page, hostname, country, device, browser, os, goal. Operators: is, is_not. Values are exact strings up to 500 characters. All filters must match the visitor across available history; report dates then select activity for that cohort. Unmatched payments are excluded. Crawler counts remain website-wide; spend requires every filter to be source/channel/campaign. Preserve filters when paging.
`--json`	`boolean`	Compact JSON instead of formatted JSON.
`--csv`	`boolean`	CSV for the main row collection; nested values remain JSON cells. Cannot be combined with --json.

Read overview

Replace example websites, dates and cursor values with your own. Running these commands makes real requests or changes the local session.

Terminal command

attriboo reports overview --site shop.example.com --from 2026-10-01 --to 2026-10-07 --compare none --json

Example output

Illustrative stdout

{"site":{"id":"site_example","domain":"shop.example.com","currency":"USD"},"period":{"from":"2026-10-01T00:00:00.000Z","to":"2026-10-08T00:00:00.000Z","label":"Custom","compare":"none","attribution_model":"first_touch"},"metrics":{"visitors":100,"sessions":120,"pageviews":240,"revenue":20000,"orders":4,"buyers":4,"conversion_rate":4,"revenue_per_visitor":200,"average_order_value":5000,"avg_session_seconds":60,"bounce_rate":40,"live_visitors":0,"ad_spend":5000,"net_profit":15000,"roas":4,"ai_revenue":5000},"changes_pct":{"revenue":null,"visitors":null,"orders":null,"conversion_rate":null,"revenue_per_visitor":null,"avg_session":null,"bounce_rate":null},"notes":"Money is in integer cents. changes_pct is the percent change versus the comparison period (null when that period has no data)."}

Output fields

attriboo reports overview output fields
Field	Type	Description
`site`	`object`	Website ID, domain and currency.
`period`	`object`	Resolved UTC boundaries; to is the exclusive timestamp after the selected end date.
`metrics`	`object`	Headline metrics. Revenue, revenue_per_visitor, average_order_value, ad_spend, net_profit and ai_revenue are cents; roas is a ratio or null without spend.
`changes_pct`	`object`	Percent changes for revenue, visitors, orders, conversion_rate, revenue_per_visitor, avg_session and bounce_rate. Null when no comparison is available.
`notes`	`string`	Calculation and completeness notes.

`site` fields

site nested fields
Field	Type	Description
`id`	`string`	Website ID.
`domain`	`string`	Website domain.
`currency`	`string`	Three-letter currency.

`period` fields

period nested fields
Field	Type	Description
`from`	`string`	Inclusive UTC start.
`to`	`string`	Exclusive UTC end.
`label`	`string`	Human-readable date selection.
`compare`	`string`	Comparison selection.
`attribution_model`	`string`	Revenue-credit model.

`metrics` fields

metrics nested fields
Field	Type	Description
`visitors`	`number`	visitors
`sessions`	`number`	sessions
`pageviews`	`number`	pageviews
`revenue`	`number`	revenue
`orders`	`number`	orders
`buyers`	`number`	buyers
`conversion_rate`	`number`	conversion rate
`revenue_per_visitor`	`number`	revenue per visitor
`average_order_value`	`number`	average order value
`avg_session_seconds`	`number`	avg session seconds
`bounce_rate`	`number`	bounce rate
`live_visitors`	`number`	live visitors
`ad_spend`	`number`	ad spend
`net_profit`	`number`	net profit
`roas`	`number \| null`	roas
`ai_revenue`	`number`	ai revenue

The data follows the overview API contract. CLI JSON omits the REST envelope.

Behavior and limits

net_profit is recorded revenue less ad spend; it is not accounting profit after every business expense.

Report history covers available records in the last 365 days; collection allowances and reporting capacity are separate.

CLI JSON output is the API data object directly, without the REST status/data envelope. Default output is formatted JSON; --json is compact JSON.

CSV contains only the returned page's main row collection. Continue using returned next_cursor values rather than assuming a single CSV is a complete export.

Exit codes and troubleshooting Environment and credentials Pagination and completeness