Skip to main content
GET
UTM campaigns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

site
string
required

The site: its domain as registered (example.com), or its site id.

Query Parameters

period
default:7d

The range: a calendar unit (day, week, month, year) positioned by date; a window ending now as a count and unit, m h d w mo (30m, 24h, 7d, 2w, 3mo); all; or custom, which reads from and to. Defaults to 7d.

Available options:
day,
week,
month,
year,
all,
custom
date
string

Which day/week/month/year a unit preset refers to, YYYY-MM-DD in the site's timezone. Omitted means the current one.

Pattern: ^\d{4}-\d{2}-\d{2}$
from
string

First day of a custom range, YYYY-MM-DD, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
to
string

Last day of a custom range, YYYY-MM-DD, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
filter
default:[]

Repeatable filter, written dimension[.key]:operator:value. Only the first two colons separate, so values may contain them. Dimensions: page_path, entry_page, exit_page, hostname, country, region, city, browser, os, device_type, referrer_source, referrer_domain, referrer_channel, utm_source, utm_medium, utm_campaign, utm_content, utm_term, event_name, goal, property (property and goal take a key). Operators: is, is_not, contains; country, region, goal take is and is_not only. A region takes the name the locations report gives it, an ISO 3166-2 code (region:is:DE-BY). Examples: filter=country:is:DE, filter=property.plan:is:pro. Repeat the parameter to combine filters; they all have to match.

Maximum string length: 1200
limit
integer
default:20

Page size, largest first. 1–500, default 20. Not a cap on the whole list.

Required range: 1 <= x <= 500
cursor
string

Opaque cursor from the previous page's nextCursor. Omit for the first page (largest rows). Reuse it only with the same site, range, filters and tab/dimension. The last page answers nextCursor: null.

Required string length: 1 - 8192
dimension
enum<string>
default:utm_campaign

Which utm_* dimension to break down by.

Available options:
utm_campaign,
utm_source,
utm_medium,
utm_content,
utm_term

Response

OK

data
object[]
required
nextCursor
string | null
required

Null on the last page.

meta
object
required
importedExcluded
boolean

True when the range holds days imported from another tool that these figures leave out: a filter or a breakdown the imported daily totals cannot answer.