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 visit

Description

This method retrieves a given visit.

Request

Method GET
URL /visits/${visitId}
Parameters
Name   Value Mandatory Description
${visitId} string yes Visit identifier.
include_sessions
  • true
  • false
no If true, the returned visit contains the reference list of authentication sessions.
include_sessions_detail
  • true (if include_sessions=true)
  • false
no If true, the returned visit contains the associated authentication sessions. You can only use this parameter if include_sessions is set to true.
include_pages
  • true
  • false
no If true, the returned visit contains the reference list of the associated pages.
include_pages_detail
  • true (if include_pages=true)
  • false
no If true, the returned visit 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 visit contains the reference list of associated events.
include_events_detail
  • true (if include_events=true)
  • false
no If true,  the returned visit 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  Visit.
This page was last edited on November 6, 2015, at 20:00.

Feedback

Comment on this article:

blog comments powered by Disqus