Skip to content

Commit a6be202

Browse files
authored
Merge branch 'master' into c-noonan-update-computed-trait-docs
2 parents 77bb324 + ed262bd commit a6be202

File tree

52 files changed

+2045
-1071
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2045
-1071
lines changed

analytics/index.js

Lines changed: 249 additions & 49 deletions
Large diffs are not rendered by default.

analytics/plan.json

Lines changed: 161 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"create_time": "2019-11-12T22:38:00.000Z",
3-
"display_name": "DocsV2",
4-
"name": "workspaces/personal-sandbox/tracking-plans/rs_1TXEwonMAr3lovaSXucnJifEEg4",
2+
"create_time": "2019-07-29T22:48:36.000Z",
3+
"display_name": "Docs",
4+
"name": "workspaces/segment_prod/tracking-plans/rs_1Ohr9MJskSjbjKIZJ8ixf5dIAJ1",
55
"rules": {
66
"events": [
77
{
@@ -37,7 +37,8 @@
3737
"version": 1
3838
},
3939
{
40-
"name": "Feedback Provided",
40+
"description": "User submits comments after their thumbs/down rating",
41+
"name": "Feedback Comment Provided",
4142
"rules": {
4243
"$schema": "http://json-schema.org/draft-07/schema#",
4344
"labels": {
@@ -47,40 +48,36 @@
4748
},
4849
"properties": {
4950
"properties": {
51+
"comment": {
52+
"description": "the comment",
53+
"type": "string"
54+
},
5055
"helpful": {
51-
"description": "",
56+
"description": "the rating given prior to the comment",
5257
"type": "boolean"
5358
},
5459
"section": {
5560
"description": "Was the feedback form in the right-nav or footer clicked?",
56-
"pattern": "right-nav|footer",
5761
"type": "string"
5862
},
5963
"title": {
6064
"description": "",
6165
"type": "string"
6266
}
6367
},
64-
"required": [
65-
"helpful",
66-
"title",
67-
"section"
68-
],
6968
"type": "object"
7069
},
7170
"traits": {
7271
"type": "object"
7372
}
7473
},
75-
"required": [
76-
"properties"
77-
],
7874
"type": "object"
7975
},
8076
"version": 1
8177
},
8278
{
83-
"name": "Home Button Clicked",
79+
"description": "User submits a thumbs up/down rating for a docs article",
80+
"name": "Feedback Provided",
8481
"rules": {
8582
"$schema": "http://json-schema.org/draft-07/schema#",
8683
"labels": {
@@ -90,13 +87,28 @@
9087
},
9188
"properties": {
9289
"properties": {
93-
"url": {
94-
"description": "The url of the page the home button was clicked on",
90+
"comment": {
91+
"description": "",
92+
"type": "string"
93+
},
94+
"helpful": {
95+
"description": "Boolean representing the value of the feedback, true is helpful, false is not helpful",
96+
"type": "boolean"
97+
},
98+
"section": {
99+
"description": "Was the feedback form in the right-nav or footer clicked?",
100+
"pattern": "right-nav|footer",
101+
"type": "string"
102+
},
103+
"title": {
104+
"description": "",
95105
"type": "string"
96106
}
97107
},
98108
"required": [
99-
"url"
109+
"helpful",
110+
"section",
111+
"title"
100112
],
101113
"type": "object"
102114
},
@@ -111,6 +123,26 @@
111123
},
112124
"version": 1
113125
},
126+
{
127+
"name": "Home Button Clicked",
128+
"rules": {
129+
"$schema": "http://json-schema.org/draft-07/schema#",
130+
"labels": {
131+
},
132+
"properties": {
133+
"context": {
134+
},
135+
"properties": {
136+
"type": "object"
137+
},
138+
"traits": {
139+
"type": "object"
140+
}
141+
},
142+
"type": "object"
143+
},
144+
"version": 1
145+
},
114146
{
115147
"name": "Lead Captured",
116148
"rules": {
@@ -154,7 +186,8 @@
154186
"version": 1
155187
},
156188
{
157-
"name": "Scroll to Top Clicked",
189+
"description": "User clicks one of the navigation elements like the home button, ToC, or searches",
190+
"name": "Navigation Control Used",
158191
"rules": {
159192
"$schema": "http://json-schema.org/draft-07/schema#",
160193
"labels": {
@@ -163,19 +196,34 @@
163196
"context": {
164197
},
165198
"properties": {
199+
"properties": {
200+
"control_value": {
201+
"description": "Name of control used",
202+
"type": "string"
203+
},
204+
"search_value": {
205+
"description": "Value of search term if search bar is used",
206+
"type": "string"
207+
}
208+
},
209+
"required": [
210+
"control_value"
211+
],
166212
"type": "object"
167213
},
168214
"traits": {
169215
"type": "object"
170216
}
171217
},
218+
"required": [
219+
"properties"
220+
],
172221
"type": "object"
173222
},
174223
"version": 1
175224
},
176225
{
177-
"description": "User scrolled to the bottom of the page",
178-
"name": "Scrolled To Bottom",
226+
"name": "Page Viewed",
179227
"rules": {
180228
"$schema": "http://json-schema.org/draft-07/schema#",
181229
"labels": {
@@ -185,29 +233,84 @@
185233
},
186234
"properties": {
187235
"properties": {
236+
"browser_language": {
237+
"description": "Custom property to identify user's browser language",
238+
"type": "string"
239+
},
240+
"frontmatter": {
241+
"description": "Custom property to add additional frontmatter context to each page call",
242+
"type": "string"
243+
},
244+
"ip": {
245+
"description": "",
246+
"type": "string"
247+
},
248+
"name": {
249+
"description": "",
250+
"type": "string"
251+
},
252+
"path": {
253+
"description": "",
254+
"type": "string"
255+
},
256+
"referrer": {
257+
"description": "",
258+
"type": "string"
259+
},
260+
"search": {
261+
"description": "",
262+
"type": "string"
263+
},
264+
"timestamp": {
265+
"description": "",
266+
"type": "string"
267+
},
268+
"timezone": {
269+
"description": "",
270+
"type": "string"
271+
},
272+
"title": {
273+
"description": "",
274+
"type": "string"
275+
},
188276
"url": {
189277
"description": "",
190278
"type": "string"
191279
}
192280
},
193-
"required": [
194-
"url"
195-
],
196281
"type": "object"
197282
},
198283
"traits": {
199284
"type": "object"
200285
}
201286
},
202-
"required": [
203-
"properties"
204-
],
205287
"type": "object"
206288
},
207289
"version": 1
208290
},
209291
{
210-
"name": "Search Clicked",
292+
"name": "Scroll to Top Clicked",
293+
"rules": {
294+
"$schema": "http://json-schema.org/draft-07/schema#",
295+
"labels": {
296+
},
297+
"properties": {
298+
"context": {
299+
},
300+
"properties": {
301+
"type": "object"
302+
},
303+
"traits": {
304+
"type": "object"
305+
}
306+
},
307+
"type": "object"
308+
},
309+
"version": 1
310+
},
311+
{
312+
"description": "User scrolled to the bottom of the page",
313+
"name": "Scrolled To Bottom",
211314
"rules": {
212315
"$schema": "http://json-schema.org/draft-07/schema#",
213316
"labels": {
@@ -216,12 +319,24 @@
216319
"context": {
217320
},
218321
"properties": {
322+
"properties": {
323+
"url": {
324+
"description": "",
325+
"type": "string"
326+
}
327+
},
328+
"required": [
329+
"url"
330+
],
219331
"type": "object"
220332
},
221333
"traits": {
222334
"type": "object"
223335
}
224336
},
337+
"required": [
338+
"properties"
339+
],
225340
"type": "object"
226341
},
227342
"version": 1
@@ -252,9 +367,9 @@
252367
}
253368
},
254369
"required": [
370+
"link",
255371
"name",
256-
"url",
257-
"link"
372+
"url"
258373
],
259374
"type": "object"
260375
},
@@ -270,10 +385,25 @@
270385
"version": 1
271386
}
272387
],
388+
"global": {
389+
"$schema": "http://json-schema.org/draft-07/schema#",
390+
"properties": {
391+
"context": {
392+
"type": "object"
393+
},
394+
"properties": {
395+
"type": "object"
396+
},
397+
"traits": {
398+
"type": "object"
399+
}
400+
},
401+
"type": "object"
402+
},
273403
"group_traits": [
274404
],
275405
"identify_traits": [
276406
]
277407
},
278-
"update_time": "2019-11-20T23:36:54.000Z"
408+
"update_time": "2020-08-03T16:55:35.000Z"
279409
}

0 commit comments

Comments
 (0)