Jump to: navigation, search

Query authenticated sessions by identity

Description

This method retrieves the authenticated sessions for a given identity.

Request

Method GET
URL /identities/${identityId}/sessions
Parameters
Name   Value Mandatory Description
${identityId} string yes Identity identifier
age integer no Sessions' maximum age in seconds. Older events will not be returned.
include_pages
  • true
  • false
no If true, the returned session contains the reference list of the associated pages.
include_pages_detail
  • true (if include_pages=true)
  • false
no If true, the returned session contains 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 session contains the reference list of associated events.
include_events_detail
  • true (if include_events=true)
  • false
no If true,  the returned session contains the associated events.
You can only use this parameter if include_events is set to true.

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 request can return.

HTTP code 200
HTTP Title OK
Body  JSON Array of Event resources.
This page was last edited on November 6, 2015, at 20:00.
Comments or questions about this documentation? Contact us for support!