Query sessions by visit

GET /visits/${visitId}/sessions

Description

Retrieves the sessions for a given visit.

Operation

Method	GET
URL	/visits/${visitId}/sessions
Name	Value	Mandatory	Description
URI Parameters
${visitId}	string	yes	visit identifier.
identityId	string	no	ID of the identity associated with the returned sessions.
age	integer	no	Sessions' maximum age in seconds. Older sessions will not be returned.
include_pages	true false	no	If true, the returned sessions contain the reference list of the associated pages.
include_pages_detail	true(if include_pages=true) false	no	If true, the returned sessions contain the associated pages. You can only use this parameter if include_pages is set to true.
include_events	true false	no	If true, the returned sessions contain the reference list of associated events.
include_events_detail	true (if include_events=true) false	no	If true,  the returned sessions contain the associated events. You can only use this parameter if include_events is set to true.

<references />

Response

The History REST API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.

HTTP code	200
HTTP Title	OK
Body	JSON Array of Session resources.