Query sessions by identity
GET /identities/${identityId}/sessions
|
Description
Retrieves the sessions for a given identity.
Operation
Method | GET | |||
---|---|---|---|---|
URL | /identities/${identityId}/sessions | |||
Name | Value | Mandatory | Description | |
URI Parameters | ||||
${identityId} | string | yes | Identity identifier. | |
age | integer | no | Sessions' maximum age in seconds. Older sessions will not be returned. | |
include_pages |
|
no | If true , the returned sessions contain the reference list of the associated pages.
| |
include_pages_detail |
|
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 |
|
no | If true , the returned sessions contain the reference list of associated events.
| |
include_events_detail |
|
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. |
This page was last edited on February 15, 2013, at 16:01.
Comments or questions about this documentation? Contact us for support!