UNPKG

@financial-times/o-tracking

Version:

Provides tracking for a product. Tracking requests are sent to the Spoor API.

registry.origami.ft.com/components/o-tracking

134 lines (81 loc) • 2.33 kB
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
# comment:report_start A comment:report_start event is sent on all clicks that open the overlay to report on a comment. --------- These are the documented parameters for a comment:report_start event. ## Required ### system_category - Key: `category` - Required: **yes** - Value: `comment` - o-tracking automatic: no - spoor pipeline automatic: no ### system_action - Key: `action` - Required: **yes** - Value: `report_start` - o-tracking automatic: no - spoor pipeline automatic: no ### comment_ID - Key: `context.comment_ID` - Required: **yes** - Value: `<comment ID>` - o-tracking automatic: no - spoor pipeline automatic: no Unique ID for Comment ### thread_ID - Key: `context.thread_ID` - Required: **yes** - Value: `<thread ID>` - o-tracking automatic: no - spoor pipeline automatic: no Unique ID for Thread ### action_type - Key: `context.action_type` - Required: **yes** - Value: `open overlay' - o-tracking automatic: no - spoor pipeline automatic: no ### is_reply - Key: `context.is_reply` - Required: **yes** - Value: `<Boolean>` - o-tracking automatic: no - spoor pipeline automatic: no Flag's for whether the event was for a thread reply or the root of a thread. Two values: 1. Event is a reply: `1` 2. Event is the root of a thread `0` ### is_success - Key: `context.is_reply` - Required: **yes** - Value: `<Boolean>` - o-tracking automatic: no - spoor pipeline automatic: no Flag's for whether the event was successful 1. Successful: `1` 2. Unscuccessful: `0` ### commentor_name - Key: `context.commentor_name` - Required: **yes** - Value: `<commentor pseudoname>` - o-tracking automatic: no - spoor pipeline automatic: no Pseudoname of commenetor ### character_count - Key: `context.character_count` - Required: **yes** - Value: `<characters in comment>` - o-tracking automatic: no - spoor pipeline automatic: no The number of characters in the comment ### comment_depth - Key: `context.comment_depth` - Required: **yes** - Value: `<Number of comments above the comment acted on - at a page level>` - o-tracking automatic: no - spoor pipeline automatic: no ### thread_depth - Key: `context.thread_depth` - Required: **yes** - Value: `<Number of comments above the comment acted on - at a thread level>` - o-tracking automatic: no - spoor pipeline automatic: no