Jump to: navigation, search

Event Resource

ApiRef2.png
Describes the event resource.

Description

The event resource contains the information relative to a business or system event that occurred on a specific web page at a given time. Two types of event can be issued:

  • SYSTEM events are constant and cannot be customized. There are two groups of System events:
    • Visit related (VisitStarted, PageEntered, PageExited);
    • Identity related (SignIn, SignOut, UserInfo).
  • BUSINESS events are custom events that you can define within the Browser DSL.

The possible event names are listed in the following table:

Name Type Description
VisitStarted SYSTEM Generated by the browser tier when the customer starts visiting the web site and enters in a first page. It creates a new visit resource. Then, all the pages visited by the customer are associated with this visit resource.
PageEntered SYSTEM Generated by the browser tier when the customer enters a page; the Backend Server creates a page resource which is associated with the visit. The page resource can be associated with an identity and a session, according to the identification scope of the customer.
PageExited SYSTEM Generated by the browser tier when the customer exits a page; the Backend Server updates accordingly the page resource. If the customer comes back on the page, a new page resource will be created.
SignIn SYSTEM Generated by the browser tier when the customer signs in (or gets authenticated with the company web portal). It captures the identification information processed to authenticate the customer, for instance, the e-mail address used to login. When the Backend Server receives this event, it updates or creates the identity resource associated with the identity identifier. Additionally, it creates a new session with a unique sessionID across the visit, which becomes the new active session for the current visit.
SignOut SYSTEM Generated by the browser tier when the customer signs out. The end date of the session resource is updated and the session is no longer the visit's current active session.
UserInfo SYSTEM Generated when the browser tier submits information about the customer. This event occurs when the customer gets recognized or updates his or her profile information.
Timeout or InactivityTimeout BUSINESS Default business event with Timeout set to 10 seconds. Generated when the customer's mouse is no longer moving. This business event needs customization through the DSL rules. For further information, read Creating Business Events in the Developer's Guide.
Search BUSINESS Default business event. Generated when the web customer is searching on the web site. Needs further DSL customization. For further information, read Creating Business Events in the Developer's Guide section.
Custom name BUSINESS Custom business event created through DSL customization. For further information, read Creating Business Events in the Developer's Guide.

Resource Details

Field Type Mandatory Description
eventID string yes The unique ID<ref name="guid">GUID (Globally Unique Identifier)</ref> of the event resource.
eventName string yes Name of the event. See the Description section for further information.
eventType SYSTEM, BUSINESS yes Event type.
category string no Category related to the generated event.
serverTimestamp long yes Server timestamp.
browserPageID string yes The browser page ID.
globalVisitID string yes Global Visit ID<ref name="guid"/>.
url string yes The url of the page.
timestamp long yes Timestamp. (Difference with the Server timestamp?)
pageID string yes ID<ref name="guid"/> of the associated page resource.
sessionID string no ID<ref name="guid"/> of the associated session resource.
data string[] no Additional JSON data, specific to the event.

<references />

Related Operations

You can retrieve event resources by using the following operations:

Examples

Retrieving a UserInfo Event

Operation

GET http://192.168.73.246:9081/backend/data/events/5cdca781-3fa3-11e2-aee5-00505625a04f

Response

HTTP/1.1 200 OK
Date: Wed, 12 Dec 2012 15:48:08 GMT
Content-Type: application/json; charset=UTF-8
Date: Wed, 12 Dec 2012 15:48:08 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
Content-Length: 587
{"eventID":"5cdca781-3fa3-11e2-aee5-00505625a04f",
"category":"",
"eventType":"SYSTEM","eventName":"UserInfo",
"serverTimestamp":1354798164472,"browserPageID":"2D869014426A4CAA8FA5C0D7B8668D0A",
"globalVisitID":"c93a19a1-45db-4d59-9c85-b637daea4a20",
"url":"http://www.genesyslab.com/afu_FLS_intermediary.page?returnUrl=/?","timestamp":1354798163915,
"visitID":"f24c60f6-0728-4f3d-b8b4-1e7bad2dc8a3","pageID":"5c911f90-3fa3-11e2-aee5-00505625a04f",
"data":{"userID":"user@genesyslab.com","sex":"male","name":"user1","age":30}}

Retrieving a PageEntered Event

Request

GET http://192.168.73.246:9081/backend/data/events/c4203381-3fa3-11e2-aee5-00505625a04f

Response

HTTP/1.1 200 OK
Date: Wed, 12 Dec 2012 15:48:08 GMT
Content-Type: application/json; charset=UTF-8
Date: Wed, 12 Dec 2012 15:48:08 GMT
Accept-Ranges: bytes
Server: Restlet-Framework/2.1.0
Content-Length: 587
{"eventID":"c4203381-3fa3-11e2-aee5-00505625a04f","category":"",
"eventType":"SYSTEM","eventName":"PageEntered",
"serverTimestamp":1354798337720,"browserPageID":"AA8C3E0B8C9543D58D9CAB122A714124",
"globalVisitID":"c93a19a1-45db-4d59-9c85-b637daea4a20",
"url":"http://www.genesyslab.com/%3f","timestamp":1354798337628,
"visitID":"f24c60f6-0728-4f3d-b8b4-1e7bad2dc8a3",
"pageID":"c489cac0-3fa3-11e2-aee5-00505625a04f",
"data":{"urlReferrer":"http://www.genesyslab.com/afu_FLS_intermediary.page?returnUrl=/%3f",
"localTime":"2012-12-06T12:52:17.628Z",
"title":"404 - Not found"}}












This page was last modified on February 27, 2013, at 11:55.

Feedback

Comment on this article:

blog comments powered by Disqus