Overview

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

GET/api/v1/stats/overview

Access: Workspace key or OAuth analytics:read · Permission details

Query parameters

Query parameters
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`	URL-encoded JSON array 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.

Request examples

Examples run from your server or terminal. Configure ATTRIBOO_TOKEN privately for authenticated requests. Replace example website IDs and values with your own. The examples make real requests when you run them.

cURL request

curl "https://www.attriboo.com/api/v1/stats/overview?site=site_example&from=2026-10-01&to=2026-10-07&compare=none" \
  -H "Authorization: Bearer $ATTRIBOO_TOKEN"

Response

Illustrative response. Fields below are inside the data object. Optional coverage, notes and continuation fields vary by report.

Response 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

JSON response

{
  "status": "success",
  "data": {
    "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)."
  }
}

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.

Errors and retries Pagination and completeness OpenAPI JSON