Query visits by identity
Description
This method retrieves the visits for a given identity.
Request
| Method | GET | |||
|---|---|---|---|---|
| URL | /identities/${identityId}/visits | |||
| Parameters | ||||
| Name | Value | Mandatory | Description | |
| ${identityId} | string | yes | Identity identifier. | |
| age | integer | no | Visits' maximum age in seconds. Older visits will not be returned. | |
| globalVisitID | string | no | Filters the visit results based on the given global Visit ID. | |
| userAgent | string | no | Returns the visits matching the UserAgent field. | |
| include_pages | 
  | 
no | If true, the returned visits contain the reference list of the associated pages. | |
| include_pages_detail | 
  | 
no | If true, the returned visits contain the associated pages. You can only use this parameter if include_pages is set to true. | |
| include_events | 
  | 
no | If true, the returned visits contain the reference list of associated events. | |
| include_events_detail | 
  | 
no | If true,  the returned visits contain 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 Visit resources. | 
 This page was last edited on March 10, 2020, at 13:56.
                
                
                
                
                
                
		
		
			Comments or questions about this documentation? Contact us for support! 
		
                
                                
            