Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Query sessions by visit


This method retrieves the sessions for a given visit.


Method GET
URL /visits/${visitId}/sessions
Name Value Mandatory Description
${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.
  • true
  • false
no If true, the returned sessions contain the reference list of the associated pages.
  • 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.
  • true
  • false
no If true, the returned sessions contain the reference list of associated events.
  • 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.


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
Body  JSON Array of Session resources.
This page was last edited on November 6, 2015, at 20:00.


Comment on this article:

blog comments powered by Disqus