v2

OpenAPI 3.1.0raw.githubusercontent.com2025-03-23009.0 KB

Sessions

Get Sessions

title: List sessions group: [ENDPOINTS]

List of all sessions

get/sessions

Query parameters

pageinteger

The number of page to start with (default 0, max 10000).

sizeinteger

The number of page's size (default 25, max 100).

emailstring

The email address that you have associated with a session via identify.

visitor_idstring

The visitor ID.

tzstring

IANA timezone. Default Europe/London if RelativeDateString is applied.

string

OR

'TODAY' | 'YESTERDAY' | 'BEGINNING_OF_WEEK' | 'BEGINNING_OF_MONTH' | 'BEGINNING_OF_PREV_MONTH' | 'TODAY-7DAYS' | 'TODAY-30DAYS'

TODAY - Today since midnight
YESTERDAY - Yesterday since midnight
BEGINNING_OF_WEEK - Nearest monday since midnight
BEGINNING_OF_MONTH - 1st of the month since midnight
BEGINNING_OF_PREV_MONTH - Previous 1st of the month since midnight
TODAY-7DAYS - Exact 7 days ago since midnight
TODAY-30DAYS - Exact 30 days ago since midnight

ISO 8601 string or RelativeDateString. For RelativeDateString see table below for possible values.

string

OR

'TODAY' | 'YESTERDAY' | 'BEGINNING_OF_WEEK' | 'BEGINNING_OF_MONTH' | 'BEGINNING_OF_PREV_MONTH' | 'TODAY-7DAYS' | 'TODAY-30DAYS'

TODAY - Today since midnight
YESTERDAY - Yesterday since midnight
BEGINNING_OF_WEEK - Nearest monday since midnight
BEGINNING_OF_MONTH - 1st of the month since midnight
BEGINNING_OF_PREV_MONTH - Previous 1st of the month since midnight
TODAY-7DAYS - Exact 7 days ago since midnight
TODAY-30DAYS - Exact 30 days ago since midnight

ISO 8601 string or RelativeDateString. For RelativeDateString see table below for possible values.

Response

Successful response

totalinteger

All 1 operations