Compatibility Tested on Edge, Chrome, Safari Mobile and Firefox(Pre-Quantum). Does not work on Firefox Quantum.
Description
Send events using a browser's sendBeacon API and Optimzely's event api.
Sends the following payload to Optimizely:
- Account ID
- Event Name as key
- Event ID as entity ID
- Sets Session_ID to AUTO
- Timestamp in milliseconds
Optimizely will attribute these events to an experiment as long as the event is sent > 30 minutes after the last network call sent by the Optimizely client JS.
To solve the issue where some click goals on links that leads visitors to a new domain are dropped.
The image below contains 3 events. The 1st one is sent using this API and the other 2 are sent using Optimizely's built in click tracking.
[Image of Chrome's network panel] (https://github.com/dorrvid/Optimizely-EventAPI-SendBeacon/blob/master/issue.jpg?raw=true)
- Copy index.js and paste it in project JS. You can remove lines 5 through 8 if you already implemented the preconnect tag.
- Send events using
window.optly.beacon.sendEvent('myEventName');'myEventName' must be an custom event or eventName ofan existing event in your project.
JQuery example:
$(document).delegate('a','mousedown',function(){
window.optly.beacon.sendEvent('myEventName');
});
- Failed network requests will be lost. Optimizely stores pending events in local storage if an event does not successfully get sent. This allows events to be sent at a later time as long as the visitor comes back to the site.
- May not work with cross project metrics
Optimizely's Event API: https://developers.optimizely.com/x/events/api/
SendBeacon API: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon
W3 sendBeacon specs: https://www.w3.org/TR/beacon/
UUID: https://stackoverflow.com/questions/105034/create-guid-uuid-in-javascript