Skip to main content
GET
Get Time Series by Dimension

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"]}]. A user-trait filter uses the templated dimension trait:<key>[{"dimension":"trait:plan","op":"equals","value":["pro"]}] — and matches identified users only, by the trait's current value. Trait ops: equals, not_equals, contains, not_contains, starts_with, ends_with, is_null ("is not set"), is_not_null ("is set"); regex is not available. Trait filters require a member session or a users:read key, max 4 per query, and a filter matching more than 10,000 identified users fails with TRAIT_FILTER_TOO_BROAD.

dimension
enum<string>
required

The session dimension to split sessions by.

Available options:
hostname,
referrer,
channel,
country,
region,
city,
language,
browser,
operating_system,
device_type,
ai_assistant,
utm_source,
utm_medium,
utm_campaign,
utm_term,
utm_content
bucket
enum<string>
Available options:
minute,
five_minutes,
ten_minutes,
fifteen_minutes,
hour,
day,
week,
month,
year
limit
integer

How many top values (by total sessions) to return as series. Default 100, max 1000.

Response

Success.