Skip to main content
GET
Get Breakdown

Authorizations

Authorization
string
header
required

An API key created in your account settings, sent as Authorization: Bearer <key>.

Path Parameters

site
integer
required

Site ID.

Query Parameters

start_date
string<date>

Start of the range, as YYYY-MM-DD.

end_date
string<date>

End of the range, as YYYY-MM-DD.

time_zone
string

IANA time zone used to bucket the range, e.g. America/New_York.

Example:

"America/New_York"

filters
string

JSON-encoded array of filter objects, each { dimension, op, value } where value is an array. Example: [{"dimension":"country","op":"equals","value":["US"]}].

dimension
enum<string>
required
Available options:
pathname,
country,
region,
browser,
operating_system,
device_type
limit
integer

Example: 10.

page
integer

Example: 1.

compare
enum<string>
Available options:
previous,
year

Response

Success.