-
Notifications
You must be signed in to change notification settings - Fork 145
/
countly.js
2297 lines (2129 loc) · 91 KB
/
countly.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/************
* Countly Web SDK
* https://github.com/Countly/countly-sdk-web
************/
/**
* Countly object to manage the internal queue and send requests to Countly server. More information on {@link http://resources.count.ly/docs/countly-sdk-for-web}
* @name Countly
* @global
* @namespace Countly
* @example <caption>SDK integration</caption>
* <script type="text/javascript">
*
* //some default pre init
* var Countly = Countly || {};
* Countly.q = Countly.q || [];
*
* //provide your app key that you retrieved from Countly dashboard
* Countly.app_key = "YOUR_APP_KEY";
*
* //provide your server IP or name. Use try.count.ly for EE trial server.
* //if you use your own server, make sure you have https enabled if you use
* //https below.
* Countly.url = "https://yourdomain.com";
*
* //start pushing function calls to queue
* //track sessions automatically
* Countly.q.push(["track_sessions"]);
*
* //track sessions automatically
* Countly.q.push(["track_pageview"]);
*
* //load countly script asynchronously
* (function() {
* var cly = document.createElement("script"); cly.type = "text/javascript";
* cly.async = true;
* //enter url of script here
* cly.src = "https://cdn.jsdelivr.net/countly-sdk-web/latest/countly.min.js";
* cly.onload = function(){Countly.init()};
* var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(cly, s);
* })();
* </script>
*/
(function (root, factory) {
if(typeof define === "function" && define.amd) {
define([], function(){ return factory(root.Countly);});
} else if(typeof module === "object" && module.exports) {
module.exports = factory(root.Countly);
} else {
root.Countly = factory(root.Countly);
}
}(typeof window !== "undefined" ? window : this, function (Countly) {
"use strict";
/** @lends Countly */
Countly = Countly || {};
var SDK_VERSION = "18.08";
var SDK_NAME = "javascript_native_web";
var inited = false,
sessionStarted = false,
apiPath = "/i",
beatInterval = 500,
queueSize = 1000,
requestQueue = [],
eventQueue = [],
crashLogs = [],
timedEvents = {},
ignoreReferrers = [],
crashSegments = null,
autoExtend = true,
lastBeat,
storedDuration = 0,
lastView = null,
lastViewTime = 0,
lastViewStoredDuration = 0,
failTimeout = 0,
failTimeoutAmount = 60,
inactivityTime = 20,
inactivityCounter = 0,
sessionUpdate = 60,
maxEventBatch = 10,
maxCrashLogs = 100,
lastMsTs = 0,
readyToProcess = true,
platform,
hasPulse = false,
syncConsents = {},
lastParams = {},
urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/,
searchBotRE = /(CountlySiteBot|nuhk|Googlebot|GoogleSecurityScanner|Yammybot|Openbot|Slurp|MSNBot|Ask Jeeves\/Teoma|ia_archiver|bingbot|Google Web Preview|Mediapartners-Google|AdsBot-Google|Baiduspider|Ezooms|YahooSeeker|AltaVista|AVSearch|Mercator|Scooter|InfoSeek|Ultraseek|Lycos|Wget|YandexBot|Yandex|YaDirectFetcher|SiteBot|Exabot|AhrefsBot|MJ12bot|TurnitinBot|magpie-crawler|Nutch Crawler|CMS Crawler|rogerbot|Domnutch|ssearch_bot|XoviBot|netseer|digincore|fr-crawler|wesee|AliasIO)/,
trackTime = true,
startTime;
/**
* Array with list of available features that you can require consent for
*/
Countly.features = ["sessions", "events", "views", "scrolls", "clicks", "forms", "crashes", "attribution", "users", "star-rating", "location"];
//create object to store consents
var consents = {};
for (var i = 0; i < Countly.features.length; i++) {
consents[Countly.features[i]] = {};
}
/**
* Initialize Countly object
* @param {Object} conf - Countly initialization {@link Init} object with configuration options
* @param {string} conf.app_key - app key for your app created in Countly
* @param {string} conf.device_id - to identify a visitor, will be auto generated if not provided
* @param {string} conf.url - your Countly server url, you can use your server URL or IP here
* @param {string} [conf.app_version=0.0] - the version of your app or website
* @param {string=} conf.country_code - country code for your visitor
* @param {string=} conf.city - name of the city of your visitor
* @param {string=} conf.ip_address - ip address of your visitor
* @param {boolean} [conf.debug=false] - output debug info into console
* @param {boolean} [conf.ignore_bots=true] - option to ignore traffic from bots
* @param {number} [conf.interval=500] - set an interval how often to check if there is any data to report and report it in miliseconds
* @param {number} [conf.queue_size=1000] - maximum amount of queued requests to store
* @param {number} [conf.fail_timeout=60] - set time in seconds to wait after failed connection to server in seconds
* @param {number} [conf.inactivity_time=20] - after how many minutes user should be counted as inactive, if he did not perform any actions, as mouse move, scroll or keypress
* @param {number} [conf.session_update=60] - how often in seconds should session be extended
* @param {number} [conf.max_events=10] - maximum amount of events to send in one batch
* @param {number} [conf.max_logs=100] - maximum amount of breadcrumbs to store for crash logs
* @param {array=} conf.ignore_referrers - array with referrers to ignore
* @param {boolean} [conf.ignore_prefetch=true] - ignore prefetching and pre rendering from counting as real website visits
* @param {boolean} [conf.force_post=false] - force using post method for all requests
* @param {boolean} [conf.ignore_visitor=false] - ignore this current visitor
* @param {boolean} [conf.require_consent=false] - Pass true if you are implementing GDPR compatible consent management. It would prevent running any functionality without proper consent
* @param {boolean} [conf.utm={"source":true, "medium":true, "campaign":true, "term":true, "content":true}] - Object instructing which UTM parameters to track
* @example
* Countly.init({
* //provide your app key that you retrieved from Countly dashboard
* app_key: "YOUR_APP_KEY",
* //provide your server IP or name. Use try.count.ly for EE trial server.
* url: "http://yourdomain.com"
* });
*/
Countly.init = function (ob, requireConsent) {
if (!inited) {
startTime = getTimestamp();
inited = true;
requestQueue = store("cly_queue") || [];
timedEvents = {};
eventQueue = store("cly_event") || [];
ob = ob || {};
beatInterval = ob.interval || Countly.interval || beatInterval;
queueSize = ob.queue_size || Countly.queue_size || queueSize;
failTimeoutAmount = ob.fail_timeout || Countly.fail_timeout || failTimeoutAmount;
inactivityTime = ob.inactivity_time || Countly.inactivity_time || inactivityTime;
sessionUpdate = ob.session_update || Countly.session_update || sessionUpdate;
maxEventBatch = ob.max_events || Countly.max_events || maxEventBatch;
maxCrashLogs = ob.max_logs || Countly.max_logs || maxCrashLogs;
Countly.ignore_prefetch = ob.ignore_prefetch || Countly.ignore_prefetch || true;
Countly.debug = ob.debug || Countly.debug || false;
Countly.app_key = ob.app_key || Countly.app_key || null;
Countly.device_id = ob.device_id || Countly.device_id || getId();
Countly.url = stripTrailingSlash(ob.url || Countly.url || "");
Countly.app_version = ob.app_version || Countly.app_version || "0.0";
Countly.country_code = ob.country_code || Countly.country_code || null;
Countly.city = ob.city || Countly.city || null;
Countly.ip_address = ob.ip_address || Countly.ip_address || null;
Countly.ignore_bots = ob.ignore_bots || Countly.ignore_bots || true;
Countly.force_post = ob.force_post || Countly.force_post || false;
Countly.q = Countly.q || [];
Countly.onload = Countly.onload || [];
Countly.ignore_visitor = ob.ignore_visitor || Countly.ignore_visitor || false;
Countly.require_consent = ob.require_consent || Countly.require_consent || false;
if (ob.ignore_referrers && ob.ignore_referrers.constructor === Array) {
ignoreReferrers = ob.ignore_referrers;
}
else if (Countly.ignore_referrers && Countly.ignore_referrers.constructor === Array) {
ignoreReferrers = Countly.ignore_referrers;
}
if (Countly.url === "") {
log("Please provide server URL");
Countly.ignore_visitor = true;
}
if (store("cly_ignore")) {
//opted out user
Countly.ignore_visitor = true;
}
checkIgnore();
if (window.name && window.name.indexOf("cly:") === 0) {
try{
Countly.passed_data = JSON.parse(window.name.replace("cly:", ""));
} catch(ex){log("Could not parse name", window.name);}
}
else if (location.hash && location.hash.indexOf("#cly:") === 0) {
try{
Countly.passed_data = JSON.parse(location.hash.replace("#cly:", ""));
} catch(ex){log("Could not parse hash", location.hash);}
}
if (Countly.passed_data) {
if (Countly.passed_data.token && Countly.passed_data.purpose) {
if (Countly.passed_data.token !== store("cly_old_token")) {
setToken(Countly.passed_data.token);
store("cly_old_token", Countly.passed_data.token);
}
if (Countly.passed_data.purpose === "heatmap") {
Countly.ignore_visitor = true;
showLoader();
loadJS(Countly.url + "/views/heatmap.js", hideLoader);
}
}
}
if (!Countly.ignore_visitor) {
log("Countly initialized");
//let code waiting for us to load, know that we have loaded
if (Countly.onload.constructor !== Array) {
Countly.onload = [];
}
if (Countly.q.constructor !== Array) {
Countly.q = [];
}
heartBeat();
store("cly_id", Countly.device_id);
var i = 0;
Countly.utm = Countly.utm || {"source":true, "medium":true, "campaign":true, "term":true, "content":true};
if (location.search) {
var parts = location.search.substring(1).split("&");
var utms = {};
var hasUTM = false;
for (i = 0; i < parts.length; i++) {
var nv = parts[i].split("=");
if (nv[0] === "cly_id") {
store("cly_cmp_id", nv[1]);
}
else if (nv[0] === "cly_uid") {
store("cly_cmp_uid", nv[1]);
}
else if((nv[0]+"").indexOf("utm_") === 0 && Countly.utm[nv[0].replace("utm_", "")]){
utms[nv[0].replace("utm_", "")] = nv[1];
hasUTM = true;
}
}
if(hasUTM){
for(var tag in Countly.utm){
if(utms[tag]){
Countly.userData.set("utm_"+tag, utms[tag]);
}
else{
Countly.userData.unset("utm_"+tag);
}
}
Countly.userData.save();
}
}
notifyLoaders();
}
}
};
/**
* Modify feature groups for consent management. Allows you to group multiple features under one feature group
* @param {object} features - object to define feature name as key and core features as value
* @example <caption>Adding all features under one group</caption>
* Countly.group_features({all:["sessions","events","views","scrolls","clicks","forms","crashes","attribution","users"]});
* //After this call Countly.add_consent("all") to allow all features
@example <caption>Grouping features</caption>
* Countly.group_features({
* activity:["sessions","events","views"],
* interaction:["scrolls","clicks","forms"]
* });
* //After this call Countly.add_consent("activity") to allow "sessions","events","views"
* //or call Countly.add_consent("interaction") to allow "scrolls","clicks","forms"
* //or call Countly.add_consent("crashes") to allow some separate feature
*/
Countly.group_features = function (features) {
if (features) {
var ob;
for (var i in features) {
ob = {};
if (!consents[i]) {
if (typeof features[i] === "string") {
consents[i] = { features: [features[i]] };
}
else if (features[i] && features[i].constructor === Array && features[i].length) {
consents[i] = { features: features[i] };
}
else {
log("Incorrect feature list for " + i + " value: " + features[i]);
}
}
else {
log("Feature name " + i + " is already reserved");
}
}
}
else {
log("Incorrect features: " + features);
}
};
/**
* Check if consent is given for specific feature (either core feature of from custom feature group)
* @param {string} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users" or customly provided through {@link Countly.group_features}
*/
Countly.check_consent = function (feature) {
if (!Countly.require_consent) {
//we don't need to have specific consents
return true;
}
if (consents[feature]) {
return (consents[feature] && consents[feature].optin) ? true : false;
}
else {
log("No feature available for " + feature);
}
return false;
};
/**
* Check if any consent is given, for some cases, when crucial parts are like device_id are needed for any request
*/
Countly.check_any_consent = function () {
if (!Countly.require_consent) {
//we don't need to have consents
return true;
}
for (var i in consents) {
if (consents[i] && consents[i].optin) {
return true;
}
}
return false;
};
/**
* Add consent for specific feature, meaning, user allowed to track that data (either core feature of from custom feature group)
* @param {string|array} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users", etc or customly provided through {@link Countly.group_features}
*/
Countly.add_consent = function (feature) {
log("Adding consent for " + feature);
if (feature.constructor === Array) {
for (var i = 0; i < feature.length; i++) {
Countly.add_consent(feature[i]);
}
}
else if (consents[feature]) {
if (consents[feature].features) {
consents[feature].optin = true;
//this is added group, let's iterate through sub features
Countly.add_consent(consents[feature].features);
}
else {
//this is core feature
if (consents[feature].optin !== true) {
syncConsents[feature] = true;
consents[feature].optin = true;
updateConsent();
setTimeout(function () {
if (feature === "sessions" && lastParams.begin_session) {
Countly.begin_session.apply(Countly, lastParams.begin_session);
lastParams.begin_session = null;
}
else if (feature === "views" && lastParams.track_pageview) {
lastView = null;
Countly.track_pageview.apply(Countly, lastParams.track_pageview);
lastParams.track_pageview = null;
}
if (lastParams.change_id) {
Countly.change_id.apply(Countly, lastParams.change_id);
lastParams.change_id = null;
}
}, 1);
}
}
}
else {
log("No feature available for " + feature);
}
};
/**
* Remove consent for specific feature, meaning, user opted out to track that data (either core feature of from custom feature group)
* @param {string|array} feature - name of the feature, possible values, "sessions","events","views","scrolls","clicks","forms","crashes","attribution","users", etc or customly provided through {@link Countly.group_features}
*/
Countly.remove_consent = function (feature) {
log("Removing consent for " + feature);
if (feature.constructor === Array) {
for (var i = 0; i < feature.length; i++) {
Countly.remove_consent(feature[i]);
}
}
else if (consents[feature]) {
if (consents[feature].features) {
//this is added group, let's iterate through sub features
Countly.remove_consent(consents[feature].features);
}
else {
//this is core feature
if (consents[feature].optin !== false) {
syncConsents[feature] = false;
updateConsent();
}
}
consents[feature].optin = false;
}
else {
log("No feature available for " + feature);
}
};
var consentTimer;
var updateConsent = function () {
if (consentTimer) {
//delay syncing consents
clearTimeout(consentTimer);
consentTimer = null;
}
consentTimer = setTimeout(function () {
if (hasAnyProperties(syncConsents)) {
//we have consents to sync, create request
toRequestQueue({ consent: JSON.stringify(syncConsents) });
//clear consents that needs syncing
syncConsents = {};
}
}, 1000);
};
/**
* Start session
* @param {boolean} noHeartBeat - true if you don't want to use internal heartbeat to manage session
*/
Countly.begin_session = function (noHeartBeat) {
if (Countly.check_consent("sessions")) {
if (!sessionStarted) {
log("Session started");
lastBeat = getTimestamp();
sessionStarted = true;
autoExtend = (noHeartBeat) ? false : true;
var req = {};
req.begin_session = 1;
req.metrics = JSON.stringify(getMetrics());
toRequestQueue(req);
}
}
else {
lastParams.begin_session = arguments;
}
};
/**
* Report session duration
* @param {int} sec - amount of seconds to report for current session
*/
Countly.session_duration = function (sec) {
if (Countly.check_consent("sessions")) {
if (sessionStarted) {
log("Session extended", sec);
toRequestQueue({ session_duration: sec });
}
}
};
/**
* End current session
* @param {int} sec - amount of seconds to report for current session, before ending it
*/
Countly.end_session = function (sec) {
if (Countly.check_consent("sessions")) {
if (sessionStarted) {
sec = sec || getTimestamp() - lastBeat;
log("Ending session");
reportViewDuration();
sessionStarted = false;
toRequestQueue({ end_session: 1, session_duration: sec });
}
}
};
/**
* Change current user/device id
* @param {string} newId - new user/device ID to use
* @param {boolean} merge - move data from old ID to new ID on server
**/
Countly.change_id = function (newId, merge) {
if (Countly.device_id !== newId) {
if (!merge) {
//empty event queue
if (eventQueue.length > 0) {
toRequestQueue({ events: JSON.stringify(eventQueue) });
eventQueue = [];
store("cly_event", eventQueue);
}
//end current session
Countly.end_session();
//clear timed events
timedEvents = {};
}
var oldId = Countly.device_id;
Countly.device_id = newId;
store("cly_id", Countly.device_id);
log("Changing id");
if (merge) {
if (Countly.check_any_consent()) {
toRequestQueue({ old_device_id: oldId });
}
else {
lastParams.change_id = arguments;
}
}
else {
//start new session for new id
Countly.begin_session(!autoExtend);
}
}
};
/**
* Report custom event
* @param {Object} event - Countly {@link Event} object
* @param {string} event.key - name or id of the event
* @param {number} [event.count=1] - how many times did event occur
* @param {number=} event.sum - sum to report with event (if any)
* @param {number=} event.dur - duration to report with event (if any)
* @param {Object=} event.segmentation - object with segments key /values
**/
Countly.add_event = function (event) {
if (Countly.check_consent("events")) {
add_cly_events(event);
}
};
//internal method for events, in case there is no consent for custom events, but internal events has consents
function add_cly_events(event) {
//ignore bots
if (Countly.ignore_visitor) {
return;
}
if (!event.key) {
log("Event must have key property");
return;
}
if (!event.count) {
event.count = 1;
}
var props = ["key", "count", "sum", "dur", "segmentation"];
var e = getProperties(event, props);
e.timestamp = getMsTimestamp();
var date = new Date();
e.hour = date.getHours();
e.dow = date.getDay();
eventQueue.push(e);
store("cly_event", eventQueue);
log("Adding event: ", event);
}
/**
* Start timed event, which will fill in duration property upon ending automatically
* @param {string} key - event name that will be used as key property
**/
Countly.start_event = function (key) {
if (timedEvents[key]) {
log("Timed event with key " + key + " already started");
return;
}
timedEvents[key] = getTimestamp();
};
/**
* End timed event
* @param {string|object} event - event key if string or Countly event same as passed to {@link Countly.add_event}
**/
Countly.end_event = function (event) {
if (typeof event == "string") {
event = { key: event };
}
if (!event.key) {
log("Event must have key property");
return;
}
if (!timedEvents[event.key]) {
log("Timed event with key " + event.key + " was not started");
return;
}
event.dur = getTimestamp() - timedEvents[event.key];
Countly.add_event(event);
delete timedEvents[event.key];
};
/**
* Provide information about user
* @param {Object} user - Countly {@link UserDetails} object
* @param {string=} user.name - user's full name
* @param {string=} user.username - user's username or nickname
* @param {string=} user.email - user's email address
* @param {string=} user.organization - user's organization or company
* @param {string=} user.phone - user's phone number
* @param {string=} user.picture - url to user's picture
* @param {string=} user.gender - M value for male and F value for femail
* @param {number=} user.byear - user's birth year used to calculate current age
* @param {Object=} user.custom - object with custom key value properties you want to save with user
**/
Countly.user_details = function (user) {
if (Countly.check_consent("users")) {
log("Adding userdetails: ", user);
var props = ["name", "username", "email", "organization", "phone", "picture", "gender", "byear", "custom"];
toRequestQueue({ user_details: JSON.stringify(getProperties(user, props)) });
}
};
/**
* Report user conversion to the server (when user signup or made a purchase, or whatever your conversion is), if there is no campaign data, user will be reported as organic
* @param {string=} campaign_id - id of campaign, or will use the one that is stored after campaign link click
* @param {string=} campaign_user_id - id of user's click on campaign, or will use the one that is stored after campaign link click
**/
Countly.report_conversion = function (campaign_id, campaign_user_id) {
if (Countly.check_consent("attribution")) {
campaign_id = campaign_id || store("cly_cmp_id") || "cly_organic";
campaign_user_id = campaign_user_id || store("cly_cmp_uid");
if (campaign_id && campaign_user_id) {
toRequestQueue({ campaign_id: campaign_id, campaign_user: campaign_user_id });
}
else if (campaign_id) {
toRequestQueue({ campaign_id: campaign_id });
}
}
};
/**************************
* Modifying custom property values of user details
* Possible modification commands
* - inc, to increment existing value by provided value
* - mul, to multiply existing value by provided value
* - max, to select maximum value between existing and provided value
* - min, to select minimum value between existing and provided value
* - setOnce, to set value only if it was not set before
* - push, creates an array property, if property does not exist, and adds value to array
* - pull, to remove value from array property
* - addToSet, creates an array property, if property does not exist, and adds unique value to array, only if it does not yet exist in array
**************************/
var customData = {};
var change_custom_property = function (key, value, mod) {
if (Countly.check_consent("users")) {
if (!customData[key]) {
customData[key] = {};
}
if (mod === "$push" || mod === "$pull" || mod === "$addToSet") {
if (!customData[key][mod]) {
customData[key][mod] = [];
}
customData[key][mod].push(value);
}
else {
customData[key][mod] = value;
}
}
};
/**
* Control user related custom properties. Don't forget to call save after finishing manipulation of custom data
* @namespace Countly.userData
* @name Countly.userData
* @example
* //set custom key value property
* Countly.userData.set("twitter", "ar2rsawseen");
* //create or increase specific number property
* Countly.userData.increment("login_count");
* //add new value to array property if it is not already there
* Countly.userData.push_unique("selected_category", "IT");
* //send all custom property modified data to server
* Countly.userData.save();
*/
Countly.userData = {
/**
* Sets user's custom property value
* @param {string} key - name of the property to attach to user
* @param {string|number} value - value to store under provided property
**/
set: function (key, value) {
customData[key] = value;
},
/**
* Unset's/delete's user's custom property
* @param {string} key - name of the property to delete
**/
unset: function (key) {
customData[key] = "";
},
/**
* Sets user's custom property value only if it was not set before
* @param {string} key - name of the property to attach to user
* @param {string|number} value - value to store under provided property
**/
set_once: function (key, value) {
change_custom_property(key, 1, "$setOnce");
},
/**
* Increment value under the key of this user's custom properties by one
* @param {string} key - name of the property to attach to user
**/
increment: function (key) {
change_custom_property(key, 1, "$inc");
},
/**
* Increment value under the key of this user's custom properties by provided value
* @param {string} key - name of the property to attach to user
* @param {number} value - value by which to increment server value
**/
increment_by: function (key, value) {
change_custom_property(key, value, "$inc");
},
/**
* Multiply value under the key of this user's custom properties by provided value
* @param {string} key - name of the property to attach to user
* @param {number} value - value by which to multiply server value
**/
multiply: function (key, value) {
change_custom_property(key, value, "$mul");
},
/**
* Save maximal value under the key of this user's custom properties
* @param {string} key - name of the property to attach to user
* @param {number} value - value which to compare to server's value and store maximal value of both provided
**/
max: function (key, value) {
change_custom_property(key, value, "$max");
},
/**
* Save minimal value under the key of this user's custom properties
* @param {string} key - name of the property to attach to user
* @param {number} value - value which to compare to server's value and store minimal value of both provided
**/
min: function (key, value) {
change_custom_property(key, value, "$min");
},
/**
* Add value to array under the key of this user's custom properties. If property is not an array, it will be converted to array
* @param {string} key - name of the property to attach to user
* @param {string|number} value - value which to add to array
**/
push: function (key, value) {
change_custom_property(key, value, "$push");
},
/**
* Add value to array under the key of this user's custom properties, storing only unique values. If property is not an array, it will be converted to array
* @param {string} key - name of the property to attach to user
* @param {string|number} value - value which to add to array
**/
push_unique: function (key, value) {
change_custom_property(key, value, "$addToSet");
},
/**
* Remove value from array under the key of this user's custom properties
* @param {string} key - name of the property
* @param {string|number} value - value which to remove from array
**/
pull: function (key, value) {
change_custom_property(key, value, "$pull");
},
/**
* Save changes made to user's custom properties object and send them to server
**/
save: function () {
if (Countly.check_consent("users")) {
toRequestQueue({ user_details: JSON.stringify({ custom: customData }) });
}
customData = {};
}
};
/**
* Automatically track javascript errors that happen on the website and report them to the server
* @param {string=} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
**/
Countly.track_errors = function (segments) {
crashSegments = segments;
//override global uncaught error handler
window.onerror = function (msg, url, line, col, err) {
if (typeof err !== "undefined") {
recordError(err, false);
}
else {
col = col || (window.event && window.event.errorCharacter);
var error = "";
if (typeof msg !== "undefined") {
error += msg + "\n";
}
if (typeof url !== "undefined") {
error += "at " + url;
}
if (typeof line !== "undefined") {
error += ":" + line;
}
if (typeof col !== "undefined") {
error += ":" + col;
}
error += "\n";
try {
var stack = [];
var f = arguments.callee.caller; // jshint ignore:line
while (f) {
stack.push(f.name);
f = f.caller;
}
error += stack.join("\n");
} catch (ex) { }
recordError(error, false);
}
};
};
/**
* Log an exception that you catched through try and catch block and handled yourself and just want to report it to server
* @param {Object} err - error exception object provided in catch block
* @param {string=} segments - additional key value pairs you want to provide with error report, like versions of libraries used, etc.
**/
Countly.log_error = function (err, segments) {
recordError(err, true, segments);
};
/**
* Add new line in the log of breadcrumbs of what user did, will be included together with error report
* @param {string} record - any text describing what user did
**/
Countly.add_log = function (record) {
if (Countly.check_consent("crashes")) {
if(crashLogs.length > maxCrashLogs) {
crashLogs.shift();
}
crashLogs.push(record);
}
};
/**
* Stop tracking duration time for this user
**/
Countly.stop_time = function () {
if (trackTime) {
trackTime = false;
storedDuration = getTimestamp() - lastBeat;
lastViewStoredDuration = getTimestamp() - lastViewTime;
}
};
/**
* Start tracking duration time for this user, by default it is automatically tracked if you are using internal session handling
**/
Countly.start_time = function () {
if (!trackTime) {
trackTime = true;
lastBeat = getTimestamp() - storedDuration;
lastViewTime = getTimestamp() - lastViewStoredDuration;
lastViewStoredDuration = 0;
}
};
/**
* Track user sessions automatically, including time user spent on your website
**/
Countly.track_sessions = function () {
//start session
Countly.begin_session();
Countly.start_time();
//end session on unload
add_event(window, "beforeunload", function () {
Countly.end_session();
});
add_event(window, "unload", function () {
Countly.end_session();
});
//manage sessions on window visibility events
var hidden = "hidden";
function onchange() {
if (document[hidden]) {
Countly.stop_time();
} else {
Countly.start_time();
}
}
//Page Visibility API
if (hidden in document) {
document.addEventListener("visibilitychange", onchange);
}
else if ((hidden = "mozHidden") in document) {
document.addEventListener("mozvisibilitychange", onchange);
}
else if ((hidden = "webkitHidden") in document) {
document.addEventListener("webkitvisibilitychange", onchange);
}
else if ((hidden = "msHidden") in document) {
document.addEventListener("msvisibilitychange", onchange);
}
// IE 9 and lower:
else if ("onfocusin" in document) {
add_event(window, "focusin", function () {
Countly.start_time();
});
add_event(window, "focusout", function () {
Countly.stop_time();
});
}
// All others:
else {
//old way
add_event(window, "focus", function () {
Countly.start_time();
});
add_event(window, "blur", function () {
Countly.stop_time();
});
//newer mobile compatible way
add_event(window, "pageshow", function () {
Countly.start_time();
});
add_event(window, "pagehide", function () {
Countly.stop_time();
});
}
function resetInactivity() {
if (inactivityCounter >= inactivityTime) {
Countly.start_time();
}
inactivityCounter = 0;
}
add_event(window, "mousemove", resetInactivity);
add_event(window, "click", resetInactivity);
add_event(window, "keydown", resetInactivity);
add_event(window, "scroll", resetInactivity);
//track user inactivity
setInterval(function () {
inactivityCounter++;
if (inactivityCounter >= inactivityTime) {
Countly.stop_time();
}
}, 60000);
};
/**
* Track page views user visits
* @param {string=} page - optional name of the page, by default uses current url path
* @param {array=} ignoreList - optional array of strings or regexes to test for the url/view name to ignore and not report
**/
Countly.track_pageview = function (page, ignoreList) {
reportViewDuration();
//we got ignoreList first
if (page && page.constructor === Array) {
ignoreList = page;
page = null;
}
page = page || window.location.pathname;
if (ignoreList && ignoreList.length) {
for (var i = 0; i < ignoreList.length; i++) {
try {
var reg = new RegExp(ignoreList[i]);
if (reg.test(page)) {
log("Ignored:", page);
return;
}
}
catch (ex) {log("Problem with regex", ignoreList[i]); }
}
}
lastView = page;
lastViewTime = getTimestamp();
var segments = {
"name": page,
"visit": 1,
"domain": window.location.hostname
};
if (typeof document.referrer !== "undefined" && document.referrer.length) {
var matches = urlParseRE.exec(document.referrer);
//do not report referrers of current website
if (matches && matches[11] && matches[11] !== window.location.hostname) {
segments.start = 1;
}
}
//track pageview
if (Countly.check_consent("views")) {
add_cly_events({
"key": "[CLY]_view",
"segmentation": segments
});