Get a breakdown

A ranked list of the values of one dimension in the date range, each with its visitors and revenue: the data behind the Overview page's Breakdowns cards. The last part of the path picks the dimension:

• channels: how the visit arrived, such as Organic Search, Paid Social or Direct.
• sources: the referring source, such as Google or ChatGPT, or the referring site's host. Visits with none read Direct/None.
• referrers: the referring address, as host and path. Add source to list one source's addresses only.
• utm_sources, utm_mediums, utm_campaigns, utm_terms and utm_contents: the value of that UTM tag on the page the visit landed on.
• countries: two-letter country codes, such as US.
• regions and cities: names, each row with the countryCode it is in.
• browsers and operating-systems: names, such as Chrome or Windows.
• browser-versions and operating-system-versions: versions (major and minor, such as 120.0) of the one browser or system named in browser or os, which these two paths require.
• devices: Desktop, Mobile or Tablet.

A visitor is counted under every value their sessions in the range had, so uniqueVisitors can add up to more than the total. Sessions with no value for the dimension are left out, except on sources, where they form the Direct/None row.

Revenue means two different things here. On the acquisition lists (channels, sources, referrers and the five UTM lists) it is attributed: each payment in the range is credited to the buyer's non-direct visits in the lookback window before it, following model and window. Revenue no visit can take, such as payments from visitors who only ever came direct, goes on the Direct row of channels and the Direct/None row of sources, so those two lists add up to the revenue in the summary; the UTM and referrer lists add up only to the share that came through tagged visits. A row can show revenue with 0 visitors when the visit that earned it came before the range. On every other list, a row's revenue is everything the people behind its visitors paid in the range, net of refunds, counted again under each value they appear under, so those rows can add up to more than the total. A payment sent from a server with no visitor id still counts there when its email matches someone we know.

Rows are ranked by uniqueVisitors unless sortBy and sortDir say otherwise, and paged with page and pageSize.

Keys: an account key. Getting started explains both kinds.

Paths

Parameters

Response

Each item in content

curl 'https://app.spreelytics.com/api/v1/event/analytics/web-analytics/channels?contactListId=…&startDate=…&endDate=…&page=…&pageSize=…' \
  -H 'Authorization: Bearer YOUR_API_KEY'

const url = new URL('https://app.spreelytics.com/api/v1/event/analytics/web-analytics/channels');
url.searchParams.set('contactListId', '…');
url.searchParams.set('startDate', '…');
url.searchParams.set('endDate', '…');
url.searchParams.set('page', '…');
url.searchParams.set('pageSize', '…');

const res = await fetch(url, {
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
});
const data = await res.json();

import requests

res = requests.get(
    "https://app.spreelytics.com/api/v1/event/analytics/web-analytics/channels",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"contactListId": "…", "startDate": "…", "endDate": "…", "page": "…", "pageSize": "…"},
)
data = res.json()

{
  "content": [
    {
      "name": "string",
      "uniqueVisitors": 0,
      "revenue": 0,
      "topSources": [
        {
          "revenue": null,
          "uniqueVisitors": null,
          "name": null
        }
      ],
      "countryCode": "string"
    }
  ],
  "size": 0,
  "page": 0,
  "totalItems": 0,
  "totalPages": 0
}