Campaigns

Read campaign revenue, recorded costs and return on ad spend.

GET/api/v1/stats/campaigns

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.
`limit`	`integer`	Row limit for reports that support it. Default: `50`.
`cursor`	`string`	Opaque next_cursor from the previous page. Preserve the original website, report, dates, model and funnel selection. Never construct a cursor.

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/campaigns?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.
`rows`	`array`	Report records. See the fields below.
`next_cursor`	`string \| null`	When provided, pass this value to continue; null means the last page. Some small-site reports omit this field.
`coverage`	`object`	When provided, describes completeness, snapshot time and row coverage. Row limits apply to this page, not to headline totals.

`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.

`rows[]` fields

rows nested fields
Field	Type	Description
`campaign`	`string`	utm_campaign label.
`source`	`string`	utm_source label.
`visitors`	`integer`	Visitors.
`conversions`	`number`	Attributed conversion credit.
`revenue`	`integer`	Attributed revenue in cents.
`ad_spend`	`integer`	Recorded spend in cents.
`roas`	`number \| null`	Revenue divided by spend; null without spend.
`cost_per_acquisition`	`number \| null`	Cents per conversion; null without spend or conversions.
`net_profit`	`integer`	Revenue less ad spend, in cents.

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"
    },
    "report": "campaigns",
    "rows": [
      {
        "campaign": "autumn",
        "source": "google",
        "visitors": 100,
        "conversions": 4,
        "revenue": 20000,
        "ad_spend": 5000,
        "roas": 4,
        "cost_per_acquisition": 1250,
        "net_profit": 15000
      }
    ]
  }
}

Behavior and limits

Money is integer cents in site.currency. Percentages use a 0–100 scale.

A missing cost connection is not evidence that a campaign is free. No currency conversion is performed.

Errors and retries Pagination and completeness OpenAPI JSON