Integrate with Third-Party Ana...
Code Samples for Third-Party Analytics Integrations
You can use these sample code snippets with a variety of common third-party analytics vendors. While you can likely copy and paste these code examples following the steps in Configure a Custom Third-Party Analytics Report, note the modifications in some sections.
You may need to further customize a code sample to meet your individual needs. Submit a support ticket using the if you need troubleshooting assistance.
If you use Google tag (gtag.js) and need to customize your integration, use one of these code samples in the code editor in step 6 of Creating the Custom Report.
Use this code if you've transitioned to Google Analytics 4 and the Google tag (gtag.js), formerly called the global site tag.
This code requires no special modifications.
GA4 with Google Tag Code Example
1var max = 50;
2setTimeout(function() {
3 if (typeof(window.gtag) === "function") {
4 for (var i = 0; i < campaigns.length; i++) {
5 var campaign = campaigns[i];
6 window.gtag('event', campaign.key, {
7 'event_category': 'Monetate',
8 'event_label': campaign.split,
9 'non_interaction': true
10 });
11 }
12 } else if (max--) {
13 setTimeout(arguments.callee);
14 }
15}, 100);
This code is the most basic one for implementing Google Analytics 4 and the Google tag (gtag.js), formerly called the global site tag.
Minimal GA4 with Google Tag Example
1// The `campaigns` variable is an array of experiences active on the page.
2if (typeof(window.gtag) === "function") {
3 for (var i = 0; i < campaigns.length; i++) {
4 var campaign = campaigns[i];
5 window.gtag('event', campaign.key, {
6 'event_category': 'Monetate',
7 'event_label': campaign.split,
8 'non_interaction': true
9 });
10 }
11}
Use this code if you have already created a GA4 property but are still using Universal Analytics for reports.
On July 1, 2023, Google's standard Universal Analytics properties stopped processing data.
GA4 with Universal Analytics Compatibility Example
1// The `campaigns` variable is an array of experiences active on the page.
2if (typeof(window.gtag) === "function") {
3 for (var i = 0; i < campaigns.length; i++) {
4 var campaign = campaigns[i];
5 window.gtag('event', campaign.key, {
6 'event_category': 'Monetate',
7 'event_label': campaign.split,
8 'non_interaction': true
9 });
10 }
11} else if (typeof(window.ga) === "function") {
12 // Universal Analytics (analytics.js)
13 var trackers = window.ga.getAll ? window.ga.getAll() : [];
14 var trackerName = trackers.length && trackers[0].get ? trackers[0].get("name") : "t0";
15 for (var i = 0; i < campaigns.length; i++) {
16 var campaign = campaigns[i];
17 var options = {nonInteraction: 1};
18 window.ga(trackerName + ".send", "event", "Monetate", campaign.key, campaign.split, options);
19 }
20} else {
21 // Legacy Analytics (ga.js)
22 // Initialize Google Analytics object
23 window._gaq = window._gaq || [];
24 var trackers = window._gat && window._gat._getTrackers ? window._gat._getTrackers() : [];
25 var trackerName = trackers.length && trackers[0]._getName ? trackers[0]._getName() : "";
26 var eventString = trackerName ? trackerName + "._trackEvent" : "_trackEvent";
27 // Report _trackEvent for each campaign
28 for (var i = 0; i < campaigns.length; i++) {
29 var campaign = campaigns[i];
30 // Non-interaction events are excluded in bounce rate calculations
31 window._gaq.push([eventString, "Monetate", campaign.key, campaign.split, null, true]);
32 }
33}
If you use Adobe Analytics (formerly SiteCatalyst) and need to customize your integration, use one of these code samples in the code editor in step 6 of Creating the Custom Report. See Adobe Analytics' documentation for more information about the tl() method.
This report code sends a track link to Adobe Analytics with the experiences that the site visitor saw. Because Adobe Analytics has limits and bills according to the number of server requests, this track line reporting may impact a client's contact with Adobe Analytics.
Because of how Adobe Analytics tracks bounce rate, this track line reporting affects the bounce rate analytics. To avoid this, use the code sample without s.tl instead.
Follow these steps to modify the code sample for your integration:
- Replace the value of the varKey variable with the specific eVar or listVar to which labels should be sent.
- Replace the value of the opt_accountId variable with the name of the report suite to which labels should be sent. To find this name, look at the window variable s_i_xyz where xyz is the unique report suite name.
Adobe Analytics with s.tl Example
1var varKey = 'LIST_X';
2var opt_accountId = 'ACCOUNT_ID';
3var imgKey = 's_i_' + opt_accountId;
4
5var opt_linkTrackEvents;
6// set this if you want a delimiter other than | (should match what the client has set up if using a list variable)
7var opt_delimiter;
8
9// translate array of objects into array of strings
10var xr = [];
11for (var i = 0, len = campaigns.length; i < len; i++)
12{
13 var campaign = campaigns[i];
14 xr.push(campaign.key + ':' + campaign.split);
15}
16
17var pollingFunction = function (interval, timeout, isReady, onReady, opt_onTimeout)
18{
19 (function ()
20 {
21 if (isReady())
22 {
23 onReady();
24 }
25 else
26 {
27 if (timeout > 0)
28 {
29 timeout -= interval;
30 setTimeout( /** @type {function()} */ (arguments.callee), interval);
31 }
32 else
33 {
34 if (opt_onTimeout)
35 {
36 opt_onTimeout();
37 }
38 }
39 }
40 })();
41};
42
43var submitToSiteCat = function (accountId, varKey, opt_linkTrackEvents, opt_delimiter)
44{
45 var s = window.s_gi(accountId);
46 if (s && s.tl)
47 {
48 var reportTxt = opt_delimiter ? xr.join(opt_delimiter) : xr.join('|');
49 s.linkTrackVars = varKey + (opt_linkTrackEvents ? ',events' : '');
50 if (opt_linkTrackEvents)
51 {
52 s.linkTrackEvents = opt_linkTrackEvents;
53 s.events = s.linkTrackEvents;
54 }
55 s[varKey] = reportTxt;
56 s.tl(true, 'o', 'Monetate');
57 }
58};
59
60var pollForSiteCat = function (successHandler, imgKey, opt_accountId)
61{
62 var pageViewComplete = function ()
63 {
64 var pageViewPixel = window[imgKey];
65 return pageViewPixel && pageViewPixel.src && pageViewPixel.complete;
66 };
67
68 pollingFunction(50, 10000, function ()
69 { // every 50ms for 10s
70 return window.s_gi && window.Image && ((opt_accountId) ? true : window.s_account) &&
71 pageViewComplete();
72 }, function ()
73 {
74 successHandler(opt_accountId || window.s_account);
75 });
76};
77
78pollForSiteCat(function (accountId)
79{
80 submitToSiteCat(accountId, varKey, opt_linkTrackEvents, opt_delimiter);
81}, imgKey, opt_accountId);
This report code doesn't directly send labels to Adobe Analytics. Instead, it's a generic one to store the information that would be reported in a cookie. It's especially useful for Adobe Analytics to avoid sending a track link that can adversely affect bounce rate metrics in Adobe Analytics.
With this solution additional development is required on site to implement code that would take the information from the cookie and send it to the analytics provider however desired. It is usually delayed one-page load as the site usually reads the cookie at page load. The site is also responsible of clearing this cookie after the information is used.
Adobe Analytics Without s.tl Example
1/*
2 DEVELOPMENT NEEDED ON THE SITE:
3 Before s.t() is called (but after the SiteCatalyst object has been created), read the value of our cookie (which is called 'mt.aa').
4 If it has a value, set the list variable 'list2' to the value in the cookie, then clear the cookie.
5 That's it! If it doesn't have a value, it wouldn't set the list variable and would just call s.t() as normal.
6 */
7
8// set this if you want a delimiter other than | (should match what the client has set up if using a list variable)
9var opt_delimiter;
10
11// translate array of objects into array of strings
12var xr = [];
13for (var i = 0, len = campaigns.length; i < len; i++)
14{
15 var campaign = campaigns[i];
16 xr.push(campaign.key + ':' + campaign.split);
17}
18
19var reportTxt = opt_delimiter ? xr.join(opt_delimiter) : xr.join('|');
20var cookieKey = 'mt.aa';
21
22var getCookie = function (n, opt_spaces)
23{
24 var cookies = (document.cookie || '').split(/\s*;\s*/);
25 for (var i = 0, l = cookies.length; i < l; i++)
26 {
27 var cookie = cookies[i];
28
29 // Index of the first equal sign, for cases where the cookie
30 // value contains an equal sign. If you set a cookie with multiple
31 // equal signs the value before the first equal sign is interpreted
32 // as the name. example:
33 // document.cookie = 'a=b';
34 // document.cookie = 'a=b=c'; // overwrites a's value with 'b=c'
35 var index = cookie.indexOf('=');
36
37 // Skip Cookies with empty names.
38 if (index != -1)
39 {
40 var name = cookie.substring(0, index);
41 if (n === name)
42 {
43
44 // If there is no value this will be an empty string.
45 var value = cookie.substring(index + 1);
46 return unescape(opt_spaces ? value.replace(/\+/g, ' ') : value);
47 }
48 }
49 }
50 return null;
51};
52
53var setCookie = function (name, value, domain, path, expiration)
54{
55 document.cookie = name + '=' + risonQuote(value) + '; ' +
56 (domain && domain.length ? 'domain=' + domain + '; ' : '') + // empty domain string same as null
57 (path && path.length ? 'path=' + path + '; ' : '') + // empty path string same as null
58 (expiration ? 'expires=' + generateExpirationString(expiration) + '; ' : '');
59};
60
61var URI_OK = { // ok in url paths and in form query args
62 '~': true,
63 '!': true,
64 '*': true,
65 '(': true,
66 ')': true,
67 '-': true,
68 '_': true,
69 '.': true,
70 ',': true,
71 ':': true,
72 '@': true,
73 '$': true,
74 "'": true,
75 '/': true
76};
77
78var risonQuote = function (x)
79{
80 // speedups todo:
81 // regex match exact set of URI_OK chars.
82 // chunking series of unsafe chars rather than encoding char-by-char
83
84 if (/^[A-Za-z0-9_\-]*$/.test(x))
85 { // XXX add more safe chars
86 return x;
87 }
88
89 x = x.replace(/([^A-Za-z0-9_\-])/g, function (a, b)
90 {
91 var c = URI_OK[b];
92 if (c)
93 {
94 return b;
95 }
96 return encodeURIComponent(b);
97 });
98 return x.replace(/%20/g, '+');
99};
100
101var generateExpirationString = function (ms)
102{
103 return new Date(new Date().getTime() + ms).toGMTString();
104};
105
106var cookieVal = getCookie(cookieKey, true);
107if (cookieVal)
108{
109 cookieVal += '|' + reportTxt;
110}
111else
112{
113 cookieVal = reportTxt;
114}
115
116setCookie(cookieKey, cookieVal, document.location.host, '/', 1800000);
This standard integration sends report labels as a conversion event and requires no modifications.
IBM Coremetrics Example
1var counter = 0;
2var interval = setInterval(function ()
3{
4 counter += 50;
5 var done = false;
6
7 if (window.cmCreateConversionEventTag && window._cm && window.Image)
8 {
9 var events = ''; // Combine all events into a pipe delimited string.
10 var last = null;
11
12 for (var i = 0, len = campaigns.length; i < len; i++)
13 {
14 var campaign = campaigns[i];
15 if (events.length)
16 {
17 events += '|';
18 }
19 events += campaign.key + ',' + campaign.split;
20 }
21
22 if (events)
23 {
24 window.cmCreateConversionEventTag(events, 2, 'CGN - Monetate', 0);
25 }
26 done = true;
27 }
28
29 if (counter === 3000 || done)
30 {
31 clearInterval(interval);
32 }
33}, 50);
This standard integration requires no modifications.
Clicktale Example
1var interval = 50;
2var timeout = 6000;
3(function() {
4 if (isReady()) {
5 onReady();
6 } else {
7 if (timeout > 0) {
8 timeout -= interval;
9 setTimeout( /** @type {function()} */ (arguments.callee), interval);
10 } else {
11 if (opt_onTimeout) {
12 opt_onTimeout();
13 }
14 }
15 }
16})();
17};
18
19var isReady = function() {
20 return window.ClickTaleEvent &&
21 window.ClicktaleIntegrationExperienceHandler;
22};
23
24var onReady = function() {
25 var experiencesArray = [];
26 // The `campaigns` variable is an array of experiences active on the page.
27 for (var i = 0; i < campaigns.length; i++) {
28 experiencesArray.push(campaigns[i].key + ',' + campaigns[i].split);
29 }
30
31 if (window.ClickTaleIsRecording && window.ClickTaleIsRecording()) {
32 window.ClicktaleIntegrationExperienceHandler(experiencesArray);
33 }
34};
35
36poll(isReady, onReady);
This standard integration requires no modifications.
FullStory Example
1var _fs = function() {
2 return window[window['_fs_namespace']];
3};
4
5var poll = function(isReady, onReady, opt_onTimeout) {
6 var interval = 50;
7 var timeout = 6000;
8 (function() {
9 if (isReady()) {
10 onReady();
11 } else {
12 if (timeout > 0) {
13 timeout -= interval;
14 setTimeout( /** @type {function()} */ (arguments.callee), interval);
15 } else {
16 if (opt_onTimeout) {
17 opt_onTimeout();
18 }
19 }
20 }
21 })();
22};
23
24var isReady = function() {
25 return typeof _fs() === 'function';
26};
27
28var onReady = function() {
29 var experiencesArray = [];
30 // The `campaigns` variable is an array of experiences active on the page.
31 for (var i = 0; i < campaigns.length; i++) {
32 payload = {};
33 payload.experiment = {};
34 payload.experiment.id_str = campaigns[i].key;
35 payload.experiment.name_str = campaigns[i].split;
36 _fs().event('Experiment', payload, 'Monetate');
37 }
38};
39
40poll(isReady, onReady);
This standard integration requires no modifications.
Glassbox Example
1var counter = 0;
2var interval = setInterval(function () {
3 if (typeof (window._detector) === "object") {
4 clearInterval(interval);
5 for (var i = 0; i < campaigns.length; i++) {
6 window._detector.triggerABTestingEvent("Monetate", campaigns[i].id, campaigns[i].key, campaigns[i].variant_id, campaigns[i].split);
7 }
8 if (counter++ > 30) {
9 clearInterval(interval);
10 }
11 }
12}, 100);
This code sample is a typical method for sending experience information to Mixpanel.
Mixpanel Example
1// The 'campaigns' variable is an array of experiences active on the page.
2for (var i = 0; i < campaigns.length; i++) {
3 mixpanel.track("Video played", {
4 "id": campaigns[i].id,
5 "key": campaigns[i].key,
6 "split": campaigns[i].split
7 });
8}
This standard integration requires no modifications.
New Relic Example
1for (var i = 0; i < campaigns.length; i++) {
2 newrelic.setCustomAttribute('MonetateExperienceID', campaigns[i].key);
3 newrelic.setCustomAttribute('MonetateExperienceSplit', campaigns[i].split);
4 newrelic.addPageAction('MonetateExperience');
5}
This standard integration requires no modifications.
Session Cam Example
1window.sessioncamConfiguration = window.sessioncamConfiguration || {};
2window.sessioncamConfiguration.customDataObjects = window.sessioncamConfiguration.customDataObjects || [];
3for (var i = 0; i < campaigns.length; i++) {
4 var item = {
5 key: 'Monetate-' + campaigns[i].key,
6 value: campaigns[i].split
7 };
8 window.sessioncamConfiguration.customDataObjects.push(item);
9}
10