@@ -250,6 +250,26 @@ console.log(init.user);
250
250
</TabItem >
251
251
</Tabs >
252
252
253
+ ## Context
254
+
255
+ All events have ` context ` of the parent frame to easily access contextual data about where and how the event occurred.
256
+
257
+ | Property | Description | Reference |
258
+ | -------------| ------------------------| ---------------|
259
+ | ` document ` | Data from the top-frame ` document ` object (e.g., title, referrer). | [ Document] ( https://developer.mozilla.org/en-US/docs/Web/API/Document ) |
260
+ | ` navigator ` | Data from the top-frame ` navigator ` object (e.g., userAgent, language). | [ Navigator] ( https://developer.mozilla.org/en-US/docs/Web/API/Navigator ) |
261
+ | ` window ` | Data from the top-frame ` window ` object (e.g., innerWidth, location). | [ Window] ( https://developer.mozilla.org/en-US/docs/Web/API/Window ) |
262
+
263
+ ``` json title="Example conext object"
264
+ {
265
+ "context" : {
266
+ "document" : {... }, // frame parent document
267
+ "navigator" : {... }, // frame parent navigator
268
+ "window" : {... } // frame parent window
269
+ }
270
+ }
271
+ ```
272
+
253
273
## Available Tracking Events
254
274
255
275
@@ -266,6 +286,11 @@ analytics.subscribe("page_viewed", event => {
266
286
``` json
267
287
{
268
288
"object" : " page" ,
289
+ "context" : {
290
+ "document" : {... }, // frame parent document
291
+ "navigator" : {... }, // frame parent navigator
292
+ "window" : {... } // frame parent window
293
+ },
269
294
"data" : {},
270
295
"event_type" : " page_viewed" ,
271
296
"timestamp" : " 2024-12-09T06:42:47.750998+00:00" ,
@@ -290,6 +315,11 @@ analytics.subscribe("product_category_viewed", event => {
290
315
``` json
291
316
{
292
317
"object" : " products" ,
318
+ "context" : {
319
+ "document" : {... }, // frame parent document
320
+ "navigator" : {... }, // frame parent navigator
321
+ "window" : {... } // frame parent window
322
+ },
293
323
"data" : [
294
324
{
295
325
"id" : 111 ,
@@ -434,6 +464,11 @@ analytics.subscribe("product_viewed", event => {
434
464
435
465
{
436
466
"object" : " product" ,
467
+ "context" : {
468
+ "document" : {... }, // frame parent document
469
+ "navigator" : {... }, // frame parent navigator
470
+ "window" : {... } // frame parent window
471
+ },
437
472
"data" : {
438
473
"id" : 111 ,
439
474
"url" : " https://examplestore.com/catalogue/timeless-watch_111/" ,
@@ -550,6 +585,11 @@ analytics.subscribe("product_added_to_cart", event => {
550
585
``` json
551
586
{
552
587
"object" : " cart_line" ,
588
+ "context" : {
589
+ "document" : {... }, // frame parent document
590
+ "navigator" : {... }, // frame parent navigator
591
+ "window" : {... } // frame parent window
592
+ },
553
593
"data" : {
554
594
"currency" : " USD" ,
555
595
"interval" : null ,
@@ -590,6 +630,11 @@ analytics.subscribe("product_removed_from_cart", event => {
590
630
``` json
591
631
{
592
632
"object" : " cart_line" ,
633
+ "context" : {
634
+ "document" : {... }, // frame parent document
635
+ "navigator" : {... }, // frame parent navigator
636
+ "window" : {... } // frame parent window
637
+ },
593
638
"data" : {
594
639
"currency" : " USD" ,
595
640
"interval" : null ,
@@ -630,6 +675,11 @@ analytics.subscribe("checkout_started", event => {
630
675
``` json
631
676
{
632
677
"object" : " checkout" ,
678
+ "context" : {
679
+ "document" : {... }, // frame parent document
680
+ "navigator" : {... }, // frame parent navigator
681
+ "window" : {... } // frame parent window
682
+ },
633
683
"data" : {
634
684
"number" : null ,
635
685
"status" : null ,
@@ -718,6 +768,11 @@ analytics.subscribe("checkout_contact_info_submitted", event => {
718
768
``` json
719
769
{
720
770
"object" : " checkout" ,
771
+ "context" : {
772
+ "document" : {... }, // frame parent document
773
+ "navigator" : {... }, // frame parent navigator
774
+ "window" : {... } // frame parent window
775
+ },
721
776
"data" : {
722
777
"number" : null ,
723
778
"status" : null ,
@@ -816,7 +871,12 @@ analytics.subscribe("checkout_shipping_address_submitted", event => {
816
871
``` json
817
872
{
818
873
"object" : " checkout" ,
819
- "data" : {
874
+ "context" : {
875
+ "document" : {... }, // frame parent document
876
+ "navigator" : {... }, // frame parent navigator
877
+ "window" : {... } // frame parent window
878
+ },
879
+ "data" : {
820
880
"number" : null ,
821
881
"status" : null ,
822
882
"fulfillment_status" : null ,
@@ -926,7 +986,12 @@ analytics.subscribe("checkout_shipping_method_submitted", event => {
926
986
``` json
927
987
{
928
988
"object" : " checkout" ,
929
- "data" : {
989
+ "context" : {
990
+ "document" : {... }, // frame parent document
991
+ "navigator" : {... }, // frame parent navigator
992
+ "window" : {... } // frame parent window
993
+ },
994
+ "data" : {
930
995
"number" : null ,
931
996
"status" : null ,
932
997
"fulfillment_status" : null ,
@@ -1038,6 +1103,11 @@ analytics.subscribe("checkout_completed", event => {
1038
1103
``` json
1039
1104
{
1040
1105
"object" : " checkout" ,
1106
+ "context" : {
1107
+ "document" : {... }, // frame parent document
1108
+ "navigator" : {... }, // frame parent navigator
1109
+ "window" : {... } // frame parent window
1110
+ },
1041
1111
"data" : {
1042
1112
"number" : " 109659" ,
1043
1113
"status" : " open" ,
0 commit comments