Session Resource

Description

The session resource contains the session information relative to a visitor's visit after a SignIn event was received. The session resource is created when the visitor authenticates on the website. Then, all the events and pages involved in the visitor's browsing activity are associated with the session until the session ends (the user signs out). For further information about events, see Event Resource.

Resource Details

Field	Type	Mandatory	Description
sessionID	string	yes	The unique ID of the session.
identityId	string	yes	The ID of the associated Identity resource.
startDate	long	yes	The date at which the session started (when the visitor signed in).
endDate	long	no	The date at which the session ended (when the visitor signed out). 0 means that the session is not terminated.
duration	int	no	The session duration, in seconds.
eventIds	string[]	no	Array of event IDs; all the events which occurred during the session.
events	event[]	no	Array of the associated events.
pageIds	string[]	no	Array of page IDs; all the pages visited during the current session.
pages	page[]	no	Array of the pages visited during this session.

<references />

Related Requests

• Query events by session
• Query pages by session
• Query session
• Query sessions by visit
• Query visits by identity

Example

The following request retrieves a session resource with its session ID. See Query session for further information.

Request

GET http://198.51.100.12:9081/backend/data/sessions/461d54d0-3fa4-11e2-aee5-00505625a04f

Response

 HTTP/1.1 200 OK
Date: Wed, 12 Dec 2012 16:20:11 GMT
Content-Type: application/json; charset=UTF-8
Date: Wed, 12 Dec 2012 16:20:11 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
Content-Length: 208
{"eventIds":null,"events":null,"pageIds":null,"pages":null,
"sessionId":"461d54d0-3fa4-11e2-aee5-00505625a04f",
"startDate":1354798555805,"endDate":1354798556259,
"duration":0,"identityId":"user@genesyslab.com"}