Skip to main content
GET
Get Sessions

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"]}].

page
integer

Example: 1.

limit
integer

Example: 10.

user_id
string

Example: User ID.

identified_only
enum<string>
Available options:
true,
false
min_pageviews
integer

Example: 0.

min_events
integer

Example: 0.

min_duration
integer

Min Duration (s). Example: 0.

Response

Success.