Visit Resource
Describes the Visit Resource.
|
Description
The visit resource contains the information related to a customer's visit, which is the browser session opened by the customer to visit the website. The visit starts with the VisitStarted
event (submitted by the website) and then, all the browsing activity is recorded in page, session, and event resources associated with the visit. The customer remains Anonymous
till he or she authenticates on the website. When the authentication occurs, the visit is associated with an identity resource, in addition to the new session resource created.
Note that several identities will be associated with the same visitId if several customers authenticate on the website. See Identity Resource.
Resource Details
Field | Type | Mandatory | Description |
---|---|---|---|
visitId | string | yes | ID<ref name="guid">GUID (Globally Unique Identifier)</ref> of the given visit. |
startDate | long | yes | Date in milliseconds at which the visit started. |
endDate | long | no | Date in milliseconds at which the visit ended; 0 means that the visit is not terminated. |
activeSessionId | string | no | ID<ref name="guid"/> of the current active session if any; otherwise, null. |
globalVisitID | string | no | ID<ref name="guid"/> of the global visit. |
userAgentID | string | no | ID<ref name="guid"/> of the associated user agent if any; otherwise, null. |
eventIds | string[] | no | Array of event IDs<ref name="guid"/> associated with this visit. |
events | event[] | no | Array of the event resources associated with this visit. |
pageIds | string[] | no | Array of page IDs<ref name="guid"/> associated with this visit. |
pages | page[] | no | Array of the page resources associated with this visit. |
sessionIds | string[] | no | Array of session IDs<ref name="guid"/> associated with this visit. |
sessions | session[] | no | Array of the session resources associated with this visit. |
<references />
Related Operations
- Create new event for visit
- Create new page for visit
- Create new session for visit
- Create new visit
- Query events by visit
- Query identities by visit
- Query pages by visit
- Query sessions by visit
- Query visit
- Create new visit for identity
- Query visits by identity
Example
Retrieve a Given Visit
Request
GET http://192.168.73.246:9081/backend/data/visits/f24c60f6-0728-4f3d-b8b4-1e7bad2dc8a3
Response
HTTP/1.1 200 OK Date: Wed, 12 Dec 2012 16:03:03 GMT Content-Type: application/json; charset=UTF-8 Date: Wed, 12 Dec 2012 16:03:03 GMT Accept-Ranges: bytes Server: Restlet-Framework/2.1.0 Content-Length: 345 {"eventIds":null,"events":null,"pageIds":null,"pages":null," sessionIds":null,"sessions":null, "visitId":"f24c60f6-0728-4f3d-b8b4-1e7bad2dc8a3", "startDate":1354797882714,"endDate":0, "activeSessionId":"00000000-0000-1000-8000-000000000000", "globalVisitID":"c93a19a1-45db-4d59-9c85-b637daea4a20", "userAgentId":"b4ec8ef0-3fa2-11e2-aee5-00505625a04f"}
This page was last edited on February 15, 2013, at 16:01.
Comments or questions about this documentation? Contact us for support!