@xyd-js/uniform 0.0.0-build-099b7bb-20250918135344 → 0.0.0-build-9f87f13-20250930210637
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/dist/index.cjs +156 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -3
- package/dist/index.d.ts +6 -3
- package/dist/index.js +154 -1
- package/dist/index.js.map +1 -1
- package/dist/markdown.d.cts +1 -1
- package/dist/markdown.d.ts +1 -1
- package/dist/{types-DiQsFerK.d.cts → types-DcJGRAj1.d.cts} +3 -2
- package/dist/{types-DiQsFerK.d.ts → types-DcJGRAj1.d.ts} +3 -2
- package/index.ts +1 -1
- package/output.json +617 -0
- package/package.json +2 -2
- package/src/__fixtures__/1.basic/input.json +1369 -0
- package/src/__fixtures__/1.basic/output.json +44 -0
- package/src/__fixtures__/2.advanced/input.json +1530 -0
- package/src/__fixtures__/2.advanced/output.json +323 -0
- package/src/__fixtures__/2.advanced.livesession/input.json +7079 -0
- package/src/__fixtures__/2.advanced.livesession/output.json +1448 -0
- package/src/converters.test.ts +74 -0
- package/src/converters.ts +215 -0
- package/src/index.ts +5 -0
- package/src/types.ts +3 -1
|
@@ -0,0 +1,1448 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"$id": "$rest.param.query",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"page": {
|
|
7
|
+
"type": "integer",
|
|
8
|
+
"description": "The number of page to start with (default 0, max 10000)."
|
|
9
|
+
},
|
|
10
|
+
"size": {
|
|
11
|
+
"type": "integer",
|
|
12
|
+
"description": "The number of page's size (default 25, max 100)."
|
|
13
|
+
},
|
|
14
|
+
"email": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"description": "The email address that you have associated with a session via [identify](/docs/api/browser/methods#identify)."
|
|
17
|
+
},
|
|
18
|
+
"visitor_id": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"description": "The visitor ID."
|
|
21
|
+
},
|
|
22
|
+
"tz": {
|
|
23
|
+
"type": "string",
|
|
24
|
+
"description": "IANA timezone. Default Europe/London if RelativeDateString is applied."
|
|
25
|
+
},
|
|
26
|
+
"date_from": {
|
|
27
|
+
"description": "[ISO 8601](https://wikipedia.org/wiki/ISO_8601) string or [RelativeDateString](/docs/api/rest/RelativeDateString).\n",
|
|
28
|
+
"oneOf": [
|
|
29
|
+
{
|
|
30
|
+
"type": "string",
|
|
31
|
+
"description": ""
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"description": "* `TODAY` - Today since midnight\n* `YESTERDAY` - Yesterday since midnight\n* `BEGINNING_OF_WEEK` - Nearest monday since midnight\n* `BEGINNING_OF_MONTH` - 1st of the month since midnight\n* `BEGINNING_OF_PREV_MONTH` - Previous 1st of the month since midnight\n* `TODAY-7DAYS` - Exact 7 days ago since midnight\n* `TODAY-30DAYS` - Exact 30 days ago since midnight\n",
|
|
35
|
+
"type": "string",
|
|
36
|
+
"enum": [
|
|
37
|
+
"TODAY",
|
|
38
|
+
"YESTERDAY",
|
|
39
|
+
"BEGINNING_OF_WEEK",
|
|
40
|
+
"BEGINNING_OF_MONTH",
|
|
41
|
+
"BEGINNING_OF_PREV_MONTH",
|
|
42
|
+
"TODAY-7DAYS",
|
|
43
|
+
"TODAY-30DAYS"
|
|
44
|
+
]
|
|
45
|
+
}
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
"date_to": {
|
|
49
|
+
"description": "[ISO 8601](https://wikipedia.org/wiki/ISO_8601) string or [RelativeDateString](/docs/api/rest/RelativeDateString).\n",
|
|
50
|
+
"oneOf": [
|
|
51
|
+
{
|
|
52
|
+
"type": "string",
|
|
53
|
+
"description": ""
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"description": "* `TODAY` - Today since midnight\n* `YESTERDAY` - Yesterday since midnight\n* `BEGINNING_OF_WEEK` - Nearest monday since midnight\n* `BEGINNING_OF_MONTH` - 1st of the month since midnight\n* `BEGINNING_OF_PREV_MONTH` - Previous 1st of the month since midnight\n* `TODAY-7DAYS` - Exact 7 days ago since midnight\n* `TODAY-30DAYS` - Exact 30 days ago since midnight\n",
|
|
57
|
+
"type": "string",
|
|
58
|
+
"enum": [
|
|
59
|
+
"TODAY",
|
|
60
|
+
"YESTERDAY",
|
|
61
|
+
"BEGINNING_OF_WEEK",
|
|
62
|
+
"BEGINNING_OF_MONTH",
|
|
63
|
+
"BEGINNING_OF_PREV_MONTH",
|
|
64
|
+
"TODAY-7DAYS",
|
|
65
|
+
"TODAY-30DAYS"
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"$id": "$rest.request.body",
|
|
74
|
+
"type": "object",
|
|
75
|
+
"properties": {
|
|
76
|
+
"name": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"description": "Name of the alert for easy identification"
|
|
79
|
+
},
|
|
80
|
+
"events": {
|
|
81
|
+
"type": "array",
|
|
82
|
+
"description": "List of events that will trigger the alert",
|
|
83
|
+
"items": {
|
|
84
|
+
"type": "object",
|
|
85
|
+
"description": "",
|
|
86
|
+
"properties": {
|
|
87
|
+
"kind": {
|
|
88
|
+
"type": "integer",
|
|
89
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
90
|
+
},
|
|
91
|
+
"value": {
|
|
92
|
+
"type": "string",
|
|
93
|
+
"description": "Value or threshold that triggers the alert"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"provider": {
|
|
99
|
+
"description": "Notification provider for the alert, `slack` or `webhooks`",
|
|
100
|
+
"type": "string",
|
|
101
|
+
"enum": [
|
|
102
|
+
"slack",
|
|
103
|
+
"webhooks"
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
"slack_channel_id": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"description": "Slack channel ID where notifications will be sent (required if provider is `slack`)"
|
|
109
|
+
},
|
|
110
|
+
"webhook_id": {
|
|
111
|
+
"type": "string",
|
|
112
|
+
"description": "Webhook ID where notifications will be sent (required if provider is `webhooks`)"
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"required": [
|
|
116
|
+
"name",
|
|
117
|
+
"events",
|
|
118
|
+
"provider"
|
|
119
|
+
]
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"allOf": [
|
|
123
|
+
{
|
|
124
|
+
"$id": "$rest.param.path",
|
|
125
|
+
"type": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"id": {
|
|
128
|
+
"type": "string",
|
|
129
|
+
"description": "Unique identifier of the alert to update"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"required": [
|
|
133
|
+
"id"
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"$id": "$rest.request.body",
|
|
138
|
+
"type": "object",
|
|
139
|
+
"properties": {
|
|
140
|
+
"name": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"description": "New name for the alert"
|
|
143
|
+
},
|
|
144
|
+
"events": {
|
|
145
|
+
"type": "array",
|
|
146
|
+
"description": "Updated list of events that will trigger the alert",
|
|
147
|
+
"items": {
|
|
148
|
+
"type": "object",
|
|
149
|
+
"description": "",
|
|
150
|
+
"properties": {
|
|
151
|
+
"kind": {
|
|
152
|
+
"type": "integer",
|
|
153
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
154
|
+
},
|
|
155
|
+
"value": {
|
|
156
|
+
"type": "string",
|
|
157
|
+
"description": "Value or threshold that triggers the alert"
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
},
|
|
162
|
+
"provider": {
|
|
163
|
+
"description": "Updated notification provider for the alert",
|
|
164
|
+
"type": "string",
|
|
165
|
+
"enum": [
|
|
166
|
+
"slack",
|
|
167
|
+
"webhooks"
|
|
168
|
+
]
|
|
169
|
+
},
|
|
170
|
+
"slack_channel_id": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"description": "Updated Slack channel ID for notifications"
|
|
173
|
+
},
|
|
174
|
+
"webhook_id": {
|
|
175
|
+
"type": "string",
|
|
176
|
+
"description": "Updated webhook ID for notifications"
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
]
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"$id": "$rest.param.path",
|
|
184
|
+
"type": "object",
|
|
185
|
+
"properties": {
|
|
186
|
+
"id": {
|
|
187
|
+
"type": "string",
|
|
188
|
+
"description": "Unique identifier of the alert to delete"
|
|
189
|
+
}
|
|
190
|
+
},
|
|
191
|
+
"required": [
|
|
192
|
+
"id"
|
|
193
|
+
]
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"$id": "$rest.request.body",
|
|
197
|
+
"type": "object",
|
|
198
|
+
"properties": {
|
|
199
|
+
"url": {
|
|
200
|
+
"type": "string",
|
|
201
|
+
"description": "URL for the webhook"
|
|
202
|
+
},
|
|
203
|
+
"website_id": {
|
|
204
|
+
"type": "string",
|
|
205
|
+
"description": "Website ID"
|
|
206
|
+
},
|
|
207
|
+
"version": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "API version (e.g., v1.0)"
|
|
210
|
+
}
|
|
211
|
+
},
|
|
212
|
+
"required": [
|
|
213
|
+
"url",
|
|
214
|
+
"website_id",
|
|
215
|
+
"version"
|
|
216
|
+
]
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"allOf": [
|
|
220
|
+
{
|
|
221
|
+
"$id": "$rest.param.path",
|
|
222
|
+
"type": "object",
|
|
223
|
+
"properties": {
|
|
224
|
+
"id": {
|
|
225
|
+
"type": "string",
|
|
226
|
+
"description": "ID of the webhook to update"
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"required": [
|
|
230
|
+
"id"
|
|
231
|
+
]
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"$id": "$rest.param.query",
|
|
235
|
+
"type": "object",
|
|
236
|
+
"properties": {
|
|
237
|
+
"version": {
|
|
238
|
+
"description": "API version",
|
|
239
|
+
"type": "string",
|
|
240
|
+
"enum": [
|
|
241
|
+
"v1.0"
|
|
242
|
+
]
|
|
243
|
+
}
|
|
244
|
+
},
|
|
245
|
+
"required": [
|
|
246
|
+
"version"
|
|
247
|
+
]
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"$id": "$rest.request.body",
|
|
251
|
+
"type": "object",
|
|
252
|
+
"properties": {
|
|
253
|
+
"url": {
|
|
254
|
+
"type": "string",
|
|
255
|
+
"description": "URL for the webhook"
|
|
256
|
+
},
|
|
257
|
+
"website_id": {
|
|
258
|
+
"type": "string",
|
|
259
|
+
"description": "Website ID"
|
|
260
|
+
},
|
|
261
|
+
"version": {
|
|
262
|
+
"type": "string",
|
|
263
|
+
"description": "API version (e.g., v1.0)"
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"required": [
|
|
267
|
+
"url",
|
|
268
|
+
"website_id",
|
|
269
|
+
"version"
|
|
270
|
+
]
|
|
271
|
+
}
|
|
272
|
+
]
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"$id": "$rest.param.path",
|
|
276
|
+
"type": "object",
|
|
277
|
+
"properties": {
|
|
278
|
+
"id": {
|
|
279
|
+
"type": "string",
|
|
280
|
+
"description": "ID of the webhook to delete"
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"required": [
|
|
284
|
+
"id"
|
|
285
|
+
]
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"$id": "$rest.request.body",
|
|
289
|
+
"type": "object",
|
|
290
|
+
"properties": {
|
|
291
|
+
"host": {
|
|
292
|
+
"type": "string",
|
|
293
|
+
"description": "Domain name or hostname of the website to track"
|
|
294
|
+
},
|
|
295
|
+
"description": {
|
|
296
|
+
"type": "string",
|
|
297
|
+
"description": "Optional description of the website for organization purposes"
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
"required": [
|
|
301
|
+
"host"
|
|
302
|
+
]
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"type": "object",
|
|
306
|
+
"properties": {
|
|
307
|
+
"error": {
|
|
308
|
+
"type": "object",
|
|
309
|
+
"description": "",
|
|
310
|
+
"properties": {
|
|
311
|
+
"type": {
|
|
312
|
+
"type": "string",
|
|
313
|
+
"description": "Type of error (e.g., validation_error, authentication_error)"
|
|
314
|
+
},
|
|
315
|
+
"code": {
|
|
316
|
+
"type": "string",
|
|
317
|
+
"description": "Machine-readable error code"
|
|
318
|
+
},
|
|
319
|
+
"param": {
|
|
320
|
+
"type": "string",
|
|
321
|
+
"description": "Name of the parameter that caused the error"
|
|
322
|
+
},
|
|
323
|
+
"message": {
|
|
324
|
+
"type": "string",
|
|
325
|
+
"description": "Human-readable error message"
|
|
326
|
+
},
|
|
327
|
+
"http_status_code": {
|
|
328
|
+
"type": "integer",
|
|
329
|
+
"description": "HTTP status code associated with the error"
|
|
330
|
+
},
|
|
331
|
+
"request_id": {
|
|
332
|
+
"type": "string",
|
|
333
|
+
"description": "Unique identifier for the request that caused the error"
|
|
334
|
+
}
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"type": "object",
|
|
341
|
+
"properties": {
|
|
342
|
+
"id": {
|
|
343
|
+
"type": "string",
|
|
344
|
+
"description": "Unique identifier for the session"
|
|
345
|
+
},
|
|
346
|
+
"website_id": {
|
|
347
|
+
"type": "string",
|
|
348
|
+
"description": "ID of the website where the session was recorded"
|
|
349
|
+
},
|
|
350
|
+
"session_url": {
|
|
351
|
+
"type": "string",
|
|
352
|
+
"description": "URL to view the session in LiveSession dashboard"
|
|
353
|
+
},
|
|
354
|
+
"creation_timestamp": {
|
|
355
|
+
"type": "integer",
|
|
356
|
+
"description": "Unix timestamp when the session was created"
|
|
357
|
+
},
|
|
358
|
+
"duration": {
|
|
359
|
+
"type": "integer",
|
|
360
|
+
"description": "Total duration of the session in seconds"
|
|
361
|
+
},
|
|
362
|
+
"end_timestamp": {
|
|
363
|
+
"type": "integer",
|
|
364
|
+
"description": "Unix timestamp when the session ended"
|
|
365
|
+
},
|
|
366
|
+
"active_time": {
|
|
367
|
+
"type": "integer",
|
|
368
|
+
"description": "Total time the user was actively interacting with the page in seconds"
|
|
369
|
+
},
|
|
370
|
+
"end_url": {
|
|
371
|
+
"type": "string",
|
|
372
|
+
"description": "The last URL visited during the session"
|
|
373
|
+
},
|
|
374
|
+
"expiration_timestamp": {
|
|
375
|
+
"type": "integer",
|
|
376
|
+
"description": "Unix timestamp when the session recording will expire"
|
|
377
|
+
},
|
|
378
|
+
"last_event_timestamp": {
|
|
379
|
+
"type": "integer",
|
|
380
|
+
"description": "Unix timestamp of the last event recorded in the session"
|
|
381
|
+
},
|
|
382
|
+
"product": {
|
|
383
|
+
"type": "string",
|
|
384
|
+
"description": "Product identifier associated with the session"
|
|
385
|
+
},
|
|
386
|
+
"device": {
|
|
387
|
+
"type": "string",
|
|
388
|
+
"description": "Device type (e.g., desktop, mobile, tablet)"
|
|
389
|
+
},
|
|
390
|
+
"tags": {
|
|
391
|
+
"type": "array",
|
|
392
|
+
"description": "Custom tags associated with the session",
|
|
393
|
+
"items": {
|
|
394
|
+
"type": "string",
|
|
395
|
+
"description": ""
|
|
396
|
+
}
|
|
397
|
+
},
|
|
398
|
+
"last_seen_page_view_id": {
|
|
399
|
+
"type": "string",
|
|
400
|
+
"description": "ID of the last page view in the session"
|
|
401
|
+
},
|
|
402
|
+
"seen": {
|
|
403
|
+
"type": "boolean",
|
|
404
|
+
"description": "Whether the session has been viewed in the dashboard"
|
|
405
|
+
},
|
|
406
|
+
"referrer": {
|
|
407
|
+
"type": "string",
|
|
408
|
+
"description": "URL where the user came from before starting the session"
|
|
409
|
+
},
|
|
410
|
+
"start_url": {
|
|
411
|
+
"type": "string",
|
|
412
|
+
"description": "First URL visited during the session"
|
|
413
|
+
},
|
|
414
|
+
"visitor_first_session": {
|
|
415
|
+
"type": "boolean",
|
|
416
|
+
"description": "Whether this is the visitor's first session"
|
|
417
|
+
},
|
|
418
|
+
"engagment_score": {
|
|
419
|
+
"type": "number",
|
|
420
|
+
"description": "Calculated engagement score for the session (0-100)"
|
|
421
|
+
},
|
|
422
|
+
"visitor": {
|
|
423
|
+
"type": "object",
|
|
424
|
+
"description": "",
|
|
425
|
+
"properties": {
|
|
426
|
+
"id": {
|
|
427
|
+
"type": "string",
|
|
428
|
+
"description": "Unique identifier for the visitor"
|
|
429
|
+
},
|
|
430
|
+
"ip": {
|
|
431
|
+
"type": "string",
|
|
432
|
+
"description": "IP address of the visitor"
|
|
433
|
+
},
|
|
434
|
+
"geolocation": {
|
|
435
|
+
"type": "object",
|
|
436
|
+
"description": "",
|
|
437
|
+
"properties": {
|
|
438
|
+
"country_code": {
|
|
439
|
+
"type": "string",
|
|
440
|
+
"description": "Two-letter country code (ISO 3166-1 alpha-2)"
|
|
441
|
+
},
|
|
442
|
+
"city": {
|
|
443
|
+
"type": "string",
|
|
444
|
+
"description": "City name"
|
|
445
|
+
},
|
|
446
|
+
"region": {
|
|
447
|
+
"type": "string",
|
|
448
|
+
"description": "Region or state name"
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
},
|
|
452
|
+
"name": {
|
|
453
|
+
"type": "string",
|
|
454
|
+
"description": "Name of the visitor if identified"
|
|
455
|
+
},
|
|
456
|
+
"email": {
|
|
457
|
+
"type": "string",
|
|
458
|
+
"description": "Email address of the visitor if identified"
|
|
459
|
+
},
|
|
460
|
+
"email_hash": {
|
|
461
|
+
"type": "string",
|
|
462
|
+
"description": "Hashed version of the visitor's email for privacy"
|
|
463
|
+
},
|
|
464
|
+
"params": {
|
|
465
|
+
"type": "array",
|
|
466
|
+
"description": "Custom parameters associated with the visitor",
|
|
467
|
+
"items": {
|
|
468
|
+
"type": "object",
|
|
469
|
+
"description": "",
|
|
470
|
+
"properties": {
|
|
471
|
+
"name": {
|
|
472
|
+
"type": "string",
|
|
473
|
+
"description": "Parameter name"
|
|
474
|
+
},
|
|
475
|
+
"value": {
|
|
476
|
+
"type": "string",
|
|
477
|
+
"description": "Parameter value"
|
|
478
|
+
}
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
},
|
|
482
|
+
"last_session_timestamp": {
|
|
483
|
+
"type": "integer",
|
|
484
|
+
"description": "Unix timestamp of the visitor's last session"
|
|
485
|
+
},
|
|
486
|
+
"first_session_timestamp": {
|
|
487
|
+
"type": "integer",
|
|
488
|
+
"description": "Unix timestamp of the visitor's first session"
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
},
|
|
492
|
+
"resolution": {
|
|
493
|
+
"type": "object",
|
|
494
|
+
"description": "",
|
|
495
|
+
"properties": {
|
|
496
|
+
"height": {
|
|
497
|
+
"type": "integer",
|
|
498
|
+
"description": "Screen height in pixels"
|
|
499
|
+
},
|
|
500
|
+
"width": {
|
|
501
|
+
"type": "integer",
|
|
502
|
+
"description": "Screen width in pixels"
|
|
503
|
+
},
|
|
504
|
+
"resolution": {
|
|
505
|
+
"type": "string",
|
|
506
|
+
"description": "Screen resolution (e.g., \"1920x1080\")"
|
|
507
|
+
}
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
"os": {
|
|
511
|
+
"type": "object",
|
|
512
|
+
"description": "",
|
|
513
|
+
"properties": {
|
|
514
|
+
"name": {
|
|
515
|
+
"type": "string",
|
|
516
|
+
"description": "Operating system name (e.g., Windows, macOS, iOS)"
|
|
517
|
+
},
|
|
518
|
+
"version": {
|
|
519
|
+
"type": "string",
|
|
520
|
+
"description": "Operating system version"
|
|
521
|
+
}
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"browser": {
|
|
525
|
+
"type": "object",
|
|
526
|
+
"description": "",
|
|
527
|
+
"properties": {
|
|
528
|
+
"description": {
|
|
529
|
+
"type": "string",
|
|
530
|
+
"description": "Full browser description string"
|
|
531
|
+
},
|
|
532
|
+
"name": {
|
|
533
|
+
"type": "string",
|
|
534
|
+
"description": "Browser name (e.g., Chrome, Firefox, Safari)"
|
|
535
|
+
},
|
|
536
|
+
"version": {
|
|
537
|
+
"type": "string",
|
|
538
|
+
"description": "Browser version"
|
|
539
|
+
}
|
|
540
|
+
}
|
|
541
|
+
},
|
|
542
|
+
"utm": {
|
|
543
|
+
"type": "object",
|
|
544
|
+
"description": "",
|
|
545
|
+
"properties": {
|
|
546
|
+
"source": {
|
|
547
|
+
"type": "string",
|
|
548
|
+
"description": "UTM source parameter (e.g., google, facebook)"
|
|
549
|
+
},
|
|
550
|
+
"medium": {
|
|
551
|
+
"type": "string",
|
|
552
|
+
"description": "UTM medium parameter (e.g., cpc, social)"
|
|
553
|
+
},
|
|
554
|
+
"campaign": {
|
|
555
|
+
"type": "string",
|
|
556
|
+
"description": "UTM campaign parameter"
|
|
557
|
+
},
|
|
558
|
+
"term": {
|
|
559
|
+
"type": "string",
|
|
560
|
+
"description": "UTM term parameter (search keywords)"
|
|
561
|
+
},
|
|
562
|
+
"content": {
|
|
563
|
+
"type": "string",
|
|
564
|
+
"description": "UTM content parameter"
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
},
|
|
568
|
+
"page_views_statistics": {
|
|
569
|
+
"type": "object",
|
|
570
|
+
"description": "",
|
|
571
|
+
"properties": {
|
|
572
|
+
"count": {
|
|
573
|
+
"type": "integer",
|
|
574
|
+
"description": "Total number of page views in the session"
|
|
575
|
+
}
|
|
576
|
+
}
|
|
577
|
+
},
|
|
578
|
+
"events_statistics": {
|
|
579
|
+
"type": "object",
|
|
580
|
+
"description": "",
|
|
581
|
+
"properties": {
|
|
582
|
+
"clicks": {
|
|
583
|
+
"type": "integer",
|
|
584
|
+
"description": "Total number of clicks during the session"
|
|
585
|
+
},
|
|
586
|
+
"error_clicks": {
|
|
587
|
+
"type": "integer",
|
|
588
|
+
"description": "Number of clicks on error elements"
|
|
589
|
+
},
|
|
590
|
+
"rage_clicks": {
|
|
591
|
+
"type": "integer",
|
|
592
|
+
"description": "Number of rapid clicks indicating user frustration"
|
|
593
|
+
},
|
|
594
|
+
"error_logs": {
|
|
595
|
+
"type": "integer",
|
|
596
|
+
"description": "Number of JavaScript errors logged"
|
|
597
|
+
},
|
|
598
|
+
"net_errors": {
|
|
599
|
+
"type": "integer",
|
|
600
|
+
"description": "Number of network errors encountered"
|
|
601
|
+
}
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"type": "object",
|
|
608
|
+
"properties": {
|
|
609
|
+
"id": {
|
|
610
|
+
"type": "string",
|
|
611
|
+
"description": "Unique identifier for the visitor"
|
|
612
|
+
},
|
|
613
|
+
"ip": {
|
|
614
|
+
"type": "string",
|
|
615
|
+
"description": "IP address of the visitor"
|
|
616
|
+
},
|
|
617
|
+
"geolocation": {
|
|
618
|
+
"type": "object",
|
|
619
|
+
"description": "",
|
|
620
|
+
"properties": {
|
|
621
|
+
"country_code": {
|
|
622
|
+
"type": "string",
|
|
623
|
+
"description": "Two-letter country code (ISO 3166-1 alpha-2)"
|
|
624
|
+
},
|
|
625
|
+
"city": {
|
|
626
|
+
"type": "string",
|
|
627
|
+
"description": "City name"
|
|
628
|
+
},
|
|
629
|
+
"region": {
|
|
630
|
+
"type": "string",
|
|
631
|
+
"description": "Region or state name"
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
},
|
|
635
|
+
"name": {
|
|
636
|
+
"type": "string",
|
|
637
|
+
"description": "Name of the visitor if identified"
|
|
638
|
+
},
|
|
639
|
+
"email": {
|
|
640
|
+
"type": "string",
|
|
641
|
+
"description": "Email address of the visitor if identified"
|
|
642
|
+
},
|
|
643
|
+
"email_hash": {
|
|
644
|
+
"type": "string",
|
|
645
|
+
"description": "Hashed version of the visitor's email for privacy"
|
|
646
|
+
},
|
|
647
|
+
"params": {
|
|
648
|
+
"type": "array",
|
|
649
|
+
"description": "Custom parameters associated with the visitor",
|
|
650
|
+
"items": {
|
|
651
|
+
"type": "object",
|
|
652
|
+
"description": "",
|
|
653
|
+
"properties": {
|
|
654
|
+
"name": {
|
|
655
|
+
"type": "string",
|
|
656
|
+
"description": "Parameter name"
|
|
657
|
+
},
|
|
658
|
+
"value": {
|
|
659
|
+
"type": "string",
|
|
660
|
+
"description": "Parameter value"
|
|
661
|
+
}
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
},
|
|
665
|
+
"last_session_timestamp": {
|
|
666
|
+
"type": "integer",
|
|
667
|
+
"description": "Unix timestamp of the visitor's last session"
|
|
668
|
+
},
|
|
669
|
+
"first_session_timestamp": {
|
|
670
|
+
"type": "integer",
|
|
671
|
+
"description": "Unix timestamp of the visitor's first session"
|
|
672
|
+
}
|
|
673
|
+
}
|
|
674
|
+
},
|
|
675
|
+
{
|
|
676
|
+
"type": "object",
|
|
677
|
+
"properties": {
|
|
678
|
+
"name": {
|
|
679
|
+
"type": "string",
|
|
680
|
+
"description": "Operating system name (e.g., Windows, macOS, iOS)"
|
|
681
|
+
},
|
|
682
|
+
"version": {
|
|
683
|
+
"type": "string",
|
|
684
|
+
"description": "Operating system version"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"type": "object",
|
|
690
|
+
"properties": {
|
|
691
|
+
"description": {
|
|
692
|
+
"type": "string",
|
|
693
|
+
"description": "Full browser description string"
|
|
694
|
+
},
|
|
695
|
+
"name": {
|
|
696
|
+
"type": "string",
|
|
697
|
+
"description": "Browser name (e.g., Chrome, Firefox, Safari)"
|
|
698
|
+
},
|
|
699
|
+
"version": {
|
|
700
|
+
"type": "string",
|
|
701
|
+
"description": "Browser version"
|
|
702
|
+
}
|
|
703
|
+
}
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"type": "object",
|
|
707
|
+
"properties": {
|
|
708
|
+
"source": {
|
|
709
|
+
"type": "string",
|
|
710
|
+
"description": "UTM source parameter (e.g., google, facebook)"
|
|
711
|
+
},
|
|
712
|
+
"medium": {
|
|
713
|
+
"type": "string",
|
|
714
|
+
"description": "UTM medium parameter (e.g., cpc, social)"
|
|
715
|
+
},
|
|
716
|
+
"campaign": {
|
|
717
|
+
"type": "string",
|
|
718
|
+
"description": "UTM campaign parameter"
|
|
719
|
+
},
|
|
720
|
+
"term": {
|
|
721
|
+
"type": "string",
|
|
722
|
+
"description": "UTM term parameter (search keywords)"
|
|
723
|
+
},
|
|
724
|
+
"content": {
|
|
725
|
+
"type": "string",
|
|
726
|
+
"description": "UTM content parameter"
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"type": "object",
|
|
732
|
+
"properties": {
|
|
733
|
+
"clicks": {
|
|
734
|
+
"type": "integer",
|
|
735
|
+
"description": "Total number of clicks during the session"
|
|
736
|
+
},
|
|
737
|
+
"error_clicks": {
|
|
738
|
+
"type": "integer",
|
|
739
|
+
"description": "Number of clicks on error elements"
|
|
740
|
+
},
|
|
741
|
+
"rage_clicks": {
|
|
742
|
+
"type": "integer",
|
|
743
|
+
"description": "Number of rapid clicks indicating user frustration"
|
|
744
|
+
},
|
|
745
|
+
"error_logs": {
|
|
746
|
+
"type": "integer",
|
|
747
|
+
"description": "Number of JavaScript errors logged"
|
|
748
|
+
},
|
|
749
|
+
"net_errors": {
|
|
750
|
+
"type": "integer",
|
|
751
|
+
"description": "Number of network errors encountered"
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
"type": "object",
|
|
757
|
+
"properties": {
|
|
758
|
+
"base": {
|
|
759
|
+
"type": "string",
|
|
760
|
+
"description": "Base URL of the page"
|
|
761
|
+
},
|
|
762
|
+
"href": {
|
|
763
|
+
"type": "string",
|
|
764
|
+
"description": "Full URL of the page"
|
|
765
|
+
},
|
|
766
|
+
"origin": {
|
|
767
|
+
"type": "string",
|
|
768
|
+
"description": "Origin of the page (protocol + hostname)"
|
|
769
|
+
},
|
|
770
|
+
"referrer": {
|
|
771
|
+
"type": "string",
|
|
772
|
+
"description": "URL of the previous page"
|
|
773
|
+
}
|
|
774
|
+
}
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
"type": "object",
|
|
778
|
+
"properties": {
|
|
779
|
+
"height": {
|
|
780
|
+
"type": "integer",
|
|
781
|
+
"description": "Viewport height in pixels"
|
|
782
|
+
},
|
|
783
|
+
"width": {
|
|
784
|
+
"type": "integer",
|
|
785
|
+
"description": "Viewport width in pixels"
|
|
786
|
+
}
|
|
787
|
+
}
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"type": "object",
|
|
791
|
+
"properties": {
|
|
792
|
+
"country_code": {
|
|
793
|
+
"type": "string",
|
|
794
|
+
"description": "Two-letter country code (ISO 3166-1 alpha-2)"
|
|
795
|
+
},
|
|
796
|
+
"city": {
|
|
797
|
+
"type": "string",
|
|
798
|
+
"description": "City name"
|
|
799
|
+
},
|
|
800
|
+
"region": {
|
|
801
|
+
"type": "string",
|
|
802
|
+
"description": "Region or state name"
|
|
803
|
+
}
|
|
804
|
+
}
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"type": "object",
|
|
808
|
+
"properties": {
|
|
809
|
+
"name": {
|
|
810
|
+
"type": "string",
|
|
811
|
+
"description": "Parameter name"
|
|
812
|
+
},
|
|
813
|
+
"value": {
|
|
814
|
+
"type": "string",
|
|
815
|
+
"description": "Parameter value"
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
},
|
|
819
|
+
{
|
|
820
|
+
"type": "object",
|
|
821
|
+
"properties": {
|
|
822
|
+
"height": {
|
|
823
|
+
"type": "integer",
|
|
824
|
+
"description": "Screen height in pixels"
|
|
825
|
+
},
|
|
826
|
+
"width": {
|
|
827
|
+
"type": "integer",
|
|
828
|
+
"description": "Screen width in pixels"
|
|
829
|
+
},
|
|
830
|
+
"resolution": {
|
|
831
|
+
"type": "string",
|
|
832
|
+
"description": "Screen resolution (e.g., \"1920x1080\")"
|
|
833
|
+
}
|
|
834
|
+
}
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"type": "object",
|
|
838
|
+
"properties": {
|
|
839
|
+
"count": {
|
|
840
|
+
"type": "integer",
|
|
841
|
+
"description": "Total number of page views in the session"
|
|
842
|
+
}
|
|
843
|
+
}
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"type": "object",
|
|
847
|
+
"properties": {
|
|
848
|
+
"total": {
|
|
849
|
+
"type": "integer",
|
|
850
|
+
"description": "Total number of sessions matching the query"
|
|
851
|
+
},
|
|
852
|
+
"page": {
|
|
853
|
+
"type": "object",
|
|
854
|
+
"description": "",
|
|
855
|
+
"properties": {
|
|
856
|
+
"num": {
|
|
857
|
+
"type": "integer",
|
|
858
|
+
"description": "Current page number"
|
|
859
|
+
},
|
|
860
|
+
"size": {
|
|
861
|
+
"type": "integer",
|
|
862
|
+
"description": "Number of items per page"
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
"sessions": {
|
|
867
|
+
"type": "array",
|
|
868
|
+
"description": "List of session objects",
|
|
869
|
+
"items": {
|
|
870
|
+
"type": "object",
|
|
871
|
+
"description": "",
|
|
872
|
+
"properties": {
|
|
873
|
+
"id": {
|
|
874
|
+
"type": "string",
|
|
875
|
+
"description": "Unique identifier for the session"
|
|
876
|
+
},
|
|
877
|
+
"website_id": {
|
|
878
|
+
"type": "string",
|
|
879
|
+
"description": "ID of the website where the session was recorded"
|
|
880
|
+
},
|
|
881
|
+
"session_url": {
|
|
882
|
+
"type": "string",
|
|
883
|
+
"description": "URL to view the session in LiveSession dashboard"
|
|
884
|
+
},
|
|
885
|
+
"creation_timestamp": {
|
|
886
|
+
"type": "integer",
|
|
887
|
+
"description": "Unix timestamp when the session was created"
|
|
888
|
+
},
|
|
889
|
+
"duration": {
|
|
890
|
+
"type": "integer",
|
|
891
|
+
"description": "Total duration of the session in seconds"
|
|
892
|
+
},
|
|
893
|
+
"end_timestamp": {
|
|
894
|
+
"type": "integer",
|
|
895
|
+
"description": "Unix timestamp when the session ended"
|
|
896
|
+
},
|
|
897
|
+
"active_time": {
|
|
898
|
+
"type": "integer",
|
|
899
|
+
"description": "Total time the user was actively interacting with the page in seconds"
|
|
900
|
+
},
|
|
901
|
+
"end_url": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"description": "The last URL visited during the session"
|
|
904
|
+
},
|
|
905
|
+
"expiration_timestamp": {
|
|
906
|
+
"type": "integer",
|
|
907
|
+
"description": "Unix timestamp when the session recording will expire"
|
|
908
|
+
},
|
|
909
|
+
"last_event_timestamp": {
|
|
910
|
+
"type": "integer",
|
|
911
|
+
"description": "Unix timestamp of the last event recorded in the session"
|
|
912
|
+
},
|
|
913
|
+
"product": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"description": "Product identifier associated with the session"
|
|
916
|
+
},
|
|
917
|
+
"device": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"description": "Device type (e.g., desktop, mobile, tablet)"
|
|
920
|
+
},
|
|
921
|
+
"tags": {
|
|
922
|
+
"type": "array",
|
|
923
|
+
"description": "Custom tags associated with the session",
|
|
924
|
+
"items": {
|
|
925
|
+
"type": "string",
|
|
926
|
+
"description": ""
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
"last_seen_page_view_id": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"description": "ID of the last page view in the session"
|
|
932
|
+
},
|
|
933
|
+
"seen": {
|
|
934
|
+
"type": "boolean",
|
|
935
|
+
"description": "Whether the session has been viewed in the dashboard"
|
|
936
|
+
},
|
|
937
|
+
"referrer": {
|
|
938
|
+
"type": "string",
|
|
939
|
+
"description": "URL where the user came from before starting the session"
|
|
940
|
+
},
|
|
941
|
+
"start_url": {
|
|
942
|
+
"type": "string",
|
|
943
|
+
"description": "First URL visited during the session"
|
|
944
|
+
},
|
|
945
|
+
"visitor_first_session": {
|
|
946
|
+
"type": "boolean",
|
|
947
|
+
"description": "Whether this is the visitor's first session"
|
|
948
|
+
},
|
|
949
|
+
"engagment_score": {
|
|
950
|
+
"type": "number",
|
|
951
|
+
"description": "Calculated engagement score for the session (0-100)"
|
|
952
|
+
},
|
|
953
|
+
"visitor": {
|
|
954
|
+
"type": "object",
|
|
955
|
+
"description": "",
|
|
956
|
+
"properties": {
|
|
957
|
+
"id": {
|
|
958
|
+
"type": "string",
|
|
959
|
+
"description": "Unique identifier for the visitor"
|
|
960
|
+
},
|
|
961
|
+
"ip": {
|
|
962
|
+
"type": "string",
|
|
963
|
+
"description": "IP address of the visitor"
|
|
964
|
+
},
|
|
965
|
+
"geolocation": {
|
|
966
|
+
"type": "object",
|
|
967
|
+
"description": "",
|
|
968
|
+
"properties": {
|
|
969
|
+
"country_code": {
|
|
970
|
+
"type": "string",
|
|
971
|
+
"description": "Two-letter country code (ISO 3166-1 alpha-2)"
|
|
972
|
+
},
|
|
973
|
+
"city": {
|
|
974
|
+
"type": "string",
|
|
975
|
+
"description": "City name"
|
|
976
|
+
},
|
|
977
|
+
"region": {
|
|
978
|
+
"type": "string",
|
|
979
|
+
"description": "Region or state name"
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
"name": {
|
|
984
|
+
"type": "string",
|
|
985
|
+
"description": "Name of the visitor if identified"
|
|
986
|
+
},
|
|
987
|
+
"email": {
|
|
988
|
+
"type": "string",
|
|
989
|
+
"description": "Email address of the visitor if identified"
|
|
990
|
+
},
|
|
991
|
+
"email_hash": {
|
|
992
|
+
"type": "string",
|
|
993
|
+
"description": "Hashed version of the visitor's email for privacy"
|
|
994
|
+
},
|
|
995
|
+
"params": {
|
|
996
|
+
"type": "array",
|
|
997
|
+
"description": "Custom parameters associated with the visitor",
|
|
998
|
+
"items": {
|
|
999
|
+
"type": "object",
|
|
1000
|
+
"description": "",
|
|
1001
|
+
"properties": {
|
|
1002
|
+
"name": {
|
|
1003
|
+
"type": "string",
|
|
1004
|
+
"description": "Parameter name"
|
|
1005
|
+
},
|
|
1006
|
+
"value": {
|
|
1007
|
+
"type": "string",
|
|
1008
|
+
"description": "Parameter value"
|
|
1009
|
+
}
|
|
1010
|
+
}
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"last_session_timestamp": {
|
|
1014
|
+
"type": "integer",
|
|
1015
|
+
"description": "Unix timestamp of the visitor's last session"
|
|
1016
|
+
},
|
|
1017
|
+
"first_session_timestamp": {
|
|
1018
|
+
"type": "integer",
|
|
1019
|
+
"description": "Unix timestamp of the visitor's first session"
|
|
1020
|
+
}
|
|
1021
|
+
}
|
|
1022
|
+
},
|
|
1023
|
+
"resolution": {
|
|
1024
|
+
"type": "object",
|
|
1025
|
+
"description": "",
|
|
1026
|
+
"properties": {
|
|
1027
|
+
"height": {
|
|
1028
|
+
"type": "integer",
|
|
1029
|
+
"description": "Screen height in pixels"
|
|
1030
|
+
},
|
|
1031
|
+
"width": {
|
|
1032
|
+
"type": "integer",
|
|
1033
|
+
"description": "Screen width in pixels"
|
|
1034
|
+
},
|
|
1035
|
+
"resolution": {
|
|
1036
|
+
"type": "string",
|
|
1037
|
+
"description": "Screen resolution (e.g., \"1920x1080\")"
|
|
1038
|
+
}
|
|
1039
|
+
}
|
|
1040
|
+
},
|
|
1041
|
+
"os": {
|
|
1042
|
+
"type": "object",
|
|
1043
|
+
"description": "",
|
|
1044
|
+
"properties": {
|
|
1045
|
+
"name": {
|
|
1046
|
+
"type": "string",
|
|
1047
|
+
"description": "Operating system name (e.g., Windows, macOS, iOS)"
|
|
1048
|
+
},
|
|
1049
|
+
"version": {
|
|
1050
|
+
"type": "string",
|
|
1051
|
+
"description": "Operating system version"
|
|
1052
|
+
}
|
|
1053
|
+
}
|
|
1054
|
+
},
|
|
1055
|
+
"browser": {
|
|
1056
|
+
"type": "object",
|
|
1057
|
+
"description": "",
|
|
1058
|
+
"properties": {
|
|
1059
|
+
"description": {
|
|
1060
|
+
"type": "string",
|
|
1061
|
+
"description": "Full browser description string"
|
|
1062
|
+
},
|
|
1063
|
+
"name": {
|
|
1064
|
+
"type": "string",
|
|
1065
|
+
"description": "Browser name (e.g., Chrome, Firefox, Safari)"
|
|
1066
|
+
},
|
|
1067
|
+
"version": {
|
|
1068
|
+
"type": "string",
|
|
1069
|
+
"description": "Browser version"
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
},
|
|
1073
|
+
"utm": {
|
|
1074
|
+
"type": "object",
|
|
1075
|
+
"description": "",
|
|
1076
|
+
"properties": {
|
|
1077
|
+
"source": {
|
|
1078
|
+
"type": "string",
|
|
1079
|
+
"description": "UTM source parameter (e.g., google, facebook)"
|
|
1080
|
+
},
|
|
1081
|
+
"medium": {
|
|
1082
|
+
"type": "string",
|
|
1083
|
+
"description": "UTM medium parameter (e.g., cpc, social)"
|
|
1084
|
+
},
|
|
1085
|
+
"campaign": {
|
|
1086
|
+
"type": "string",
|
|
1087
|
+
"description": "UTM campaign parameter"
|
|
1088
|
+
},
|
|
1089
|
+
"term": {
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"description": "UTM term parameter (search keywords)"
|
|
1092
|
+
},
|
|
1093
|
+
"content": {
|
|
1094
|
+
"type": "string",
|
|
1095
|
+
"description": "UTM content parameter"
|
|
1096
|
+
}
|
|
1097
|
+
}
|
|
1098
|
+
},
|
|
1099
|
+
"page_views_statistics": {
|
|
1100
|
+
"type": "object",
|
|
1101
|
+
"description": "",
|
|
1102
|
+
"properties": {
|
|
1103
|
+
"count": {
|
|
1104
|
+
"type": "integer",
|
|
1105
|
+
"description": "Total number of page views in the session"
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
},
|
|
1109
|
+
"events_statistics": {
|
|
1110
|
+
"type": "object",
|
|
1111
|
+
"description": "",
|
|
1112
|
+
"properties": {
|
|
1113
|
+
"clicks": {
|
|
1114
|
+
"type": "integer",
|
|
1115
|
+
"description": "Total number of clicks during the session"
|
|
1116
|
+
},
|
|
1117
|
+
"error_clicks": {
|
|
1118
|
+
"type": "integer",
|
|
1119
|
+
"description": "Number of clicks on error elements"
|
|
1120
|
+
},
|
|
1121
|
+
"rage_clicks": {
|
|
1122
|
+
"type": "integer",
|
|
1123
|
+
"description": "Number of rapid clicks indicating user frustration"
|
|
1124
|
+
},
|
|
1125
|
+
"error_logs": {
|
|
1126
|
+
"type": "integer",
|
|
1127
|
+
"description": "Number of JavaScript errors logged"
|
|
1128
|
+
},
|
|
1129
|
+
"net_errors": {
|
|
1130
|
+
"type": "integer",
|
|
1131
|
+
"description": "Number of network errors encountered"
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
}
|
|
1137
|
+
}
|
|
1138
|
+
}
|
|
1139
|
+
},
|
|
1140
|
+
{
|
|
1141
|
+
"type": "object",
|
|
1142
|
+
"properties": {
|
|
1143
|
+
"num": {
|
|
1144
|
+
"type": "integer",
|
|
1145
|
+
"description": "Current page number"
|
|
1146
|
+
},
|
|
1147
|
+
"size": {
|
|
1148
|
+
"type": "integer",
|
|
1149
|
+
"description": "Number of items per page"
|
|
1150
|
+
}
|
|
1151
|
+
}
|
|
1152
|
+
},
|
|
1153
|
+
{
|
|
1154
|
+
"type": "object",
|
|
1155
|
+
"properties": {
|
|
1156
|
+
"name": {
|
|
1157
|
+
"type": "string",
|
|
1158
|
+
"description": "Name of the alert for easy identification"
|
|
1159
|
+
},
|
|
1160
|
+
"events": {
|
|
1161
|
+
"type": "array",
|
|
1162
|
+
"description": "List of events that will trigger the alert",
|
|
1163
|
+
"items": {
|
|
1164
|
+
"type": "object",
|
|
1165
|
+
"description": "",
|
|
1166
|
+
"properties": {
|
|
1167
|
+
"kind": {
|
|
1168
|
+
"type": "integer",
|
|
1169
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
1170
|
+
},
|
|
1171
|
+
"value": {
|
|
1172
|
+
"type": "string",
|
|
1173
|
+
"description": "Value or threshold that triggers the alert"
|
|
1174
|
+
}
|
|
1175
|
+
}
|
|
1176
|
+
}
|
|
1177
|
+
},
|
|
1178
|
+
"provider": {
|
|
1179
|
+
"description": "Notification provider for the alert, `slack` or `webhooks`",
|
|
1180
|
+
"type": "string",
|
|
1181
|
+
"enum": [
|
|
1182
|
+
"slack",
|
|
1183
|
+
"webhooks"
|
|
1184
|
+
]
|
|
1185
|
+
},
|
|
1186
|
+
"slack_channel_id": {
|
|
1187
|
+
"type": "string",
|
|
1188
|
+
"description": "Slack channel ID where notifications will be sent (required if provider is `slack`)"
|
|
1189
|
+
},
|
|
1190
|
+
"webhook_id": {
|
|
1191
|
+
"type": "string",
|
|
1192
|
+
"description": "Webhook ID where notifications will be sent (required if provider is `webhooks`)"
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1195
|
+
"required": [
|
|
1196
|
+
"name",
|
|
1197
|
+
"events",
|
|
1198
|
+
"provider"
|
|
1199
|
+
]
|
|
1200
|
+
},
|
|
1201
|
+
{
|
|
1202
|
+
"type": "object",
|
|
1203
|
+
"properties": {
|
|
1204
|
+
"name": {
|
|
1205
|
+
"type": "string",
|
|
1206
|
+
"description": "New name for the alert"
|
|
1207
|
+
},
|
|
1208
|
+
"events": {
|
|
1209
|
+
"type": "array",
|
|
1210
|
+
"description": "Updated list of events that will trigger the alert",
|
|
1211
|
+
"items": {
|
|
1212
|
+
"type": "object",
|
|
1213
|
+
"description": "",
|
|
1214
|
+
"properties": {
|
|
1215
|
+
"kind": {
|
|
1216
|
+
"type": "integer",
|
|
1217
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
1218
|
+
},
|
|
1219
|
+
"value": {
|
|
1220
|
+
"type": "string",
|
|
1221
|
+
"description": "Value or threshold that triggers the alert"
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
},
|
|
1226
|
+
"provider": {
|
|
1227
|
+
"description": "Updated notification provider for the alert",
|
|
1228
|
+
"type": "string",
|
|
1229
|
+
"enum": [
|
|
1230
|
+
"slack",
|
|
1231
|
+
"webhooks"
|
|
1232
|
+
]
|
|
1233
|
+
},
|
|
1234
|
+
"slack_channel_id": {
|
|
1235
|
+
"type": "string",
|
|
1236
|
+
"description": "Updated Slack channel ID for notifications"
|
|
1237
|
+
},
|
|
1238
|
+
"webhook_id": {
|
|
1239
|
+
"type": "string",
|
|
1240
|
+
"description": "Updated webhook ID for notifications"
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
"type": "object",
|
|
1246
|
+
"properties": {
|
|
1247
|
+
"kind": {
|
|
1248
|
+
"type": "integer",
|
|
1249
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
1250
|
+
},
|
|
1251
|
+
"value": {
|
|
1252
|
+
"type": "string",
|
|
1253
|
+
"description": "Value or threshold that triggers the alert"
|
|
1254
|
+
}
|
|
1255
|
+
}
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"type": "object",
|
|
1259
|
+
"properties": {
|
|
1260
|
+
"alert_id": {
|
|
1261
|
+
"type": "string",
|
|
1262
|
+
"description": "Unique identifier for the alert"
|
|
1263
|
+
},
|
|
1264
|
+
"name": {
|
|
1265
|
+
"type": "string",
|
|
1266
|
+
"description": "Name of the alert"
|
|
1267
|
+
},
|
|
1268
|
+
"events": {
|
|
1269
|
+
"type": "array",
|
|
1270
|
+
"description": "List of events that trigger the alert",
|
|
1271
|
+
"items": {
|
|
1272
|
+
"type": "object",
|
|
1273
|
+
"description": "",
|
|
1274
|
+
"properties": {
|
|
1275
|
+
"kind": {
|
|
1276
|
+
"type": "integer",
|
|
1277
|
+
"description": "Kind of event, more info [here](/docs/api/rest/EventKind)"
|
|
1278
|
+
},
|
|
1279
|
+
"value": {
|
|
1280
|
+
"type": "string",
|
|
1281
|
+
"description": "Value or threshold that triggers the alert"
|
|
1282
|
+
}
|
|
1283
|
+
}
|
|
1284
|
+
}
|
|
1285
|
+
},
|
|
1286
|
+
"provider": {
|
|
1287
|
+
"description": "Notification provider for the alert",
|
|
1288
|
+
"type": "string",
|
|
1289
|
+
"enum": [
|
|
1290
|
+
"slack",
|
|
1291
|
+
"webhooks"
|
|
1292
|
+
]
|
|
1293
|
+
},
|
|
1294
|
+
"slack_channel_id": {
|
|
1295
|
+
"type": "string",
|
|
1296
|
+
"description": "Slack channel ID for notifications"
|
|
1297
|
+
},
|
|
1298
|
+
"webhook_id": {
|
|
1299
|
+
"type": "string",
|
|
1300
|
+
"description": "Webhook ID for notifications"
|
|
1301
|
+
},
|
|
1302
|
+
"enabled": {
|
|
1303
|
+
"type": "boolean",
|
|
1304
|
+
"description": "Whether the alert is currently active"
|
|
1305
|
+
},
|
|
1306
|
+
"creation_date": {
|
|
1307
|
+
"type": "string",
|
|
1308
|
+
"description": "[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp when the alert was created\n"
|
|
1309
|
+
}
|
|
1310
|
+
}
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
"type": "object",
|
|
1314
|
+
"properties": {
|
|
1315
|
+
"alert_id": {
|
|
1316
|
+
"type": "string",
|
|
1317
|
+
"description": "ID of the deleted alert"
|
|
1318
|
+
},
|
|
1319
|
+
"deleted": {
|
|
1320
|
+
"type": "boolean",
|
|
1321
|
+
"description": "Confirmation that the alert was deleted"
|
|
1322
|
+
}
|
|
1323
|
+
}
|
|
1324
|
+
},
|
|
1325
|
+
{
|
|
1326
|
+
"type": "object",
|
|
1327
|
+
"properties": {
|
|
1328
|
+
"url": {
|
|
1329
|
+
"type": "string",
|
|
1330
|
+
"description": "URL for the webhook"
|
|
1331
|
+
},
|
|
1332
|
+
"website_id": {
|
|
1333
|
+
"type": "string",
|
|
1334
|
+
"description": "Website ID"
|
|
1335
|
+
},
|
|
1336
|
+
"version": {
|
|
1337
|
+
"type": "string",
|
|
1338
|
+
"description": "API version (e.g., v1.0)"
|
|
1339
|
+
}
|
|
1340
|
+
},
|
|
1341
|
+
"required": [
|
|
1342
|
+
"url",
|
|
1343
|
+
"website_id",
|
|
1344
|
+
"version"
|
|
1345
|
+
]
|
|
1346
|
+
},
|
|
1347
|
+
{
|
|
1348
|
+
"type": "object",
|
|
1349
|
+
"properties": {
|
|
1350
|
+
"url": {
|
|
1351
|
+
"type": "string",
|
|
1352
|
+
"description": "URL for the webhook"
|
|
1353
|
+
},
|
|
1354
|
+
"website_id": {
|
|
1355
|
+
"type": "string",
|
|
1356
|
+
"description": "Website ID"
|
|
1357
|
+
},
|
|
1358
|
+
"version": {
|
|
1359
|
+
"type": "string",
|
|
1360
|
+
"description": "API version (e.g., v1.0)"
|
|
1361
|
+
}
|
|
1362
|
+
},
|
|
1363
|
+
"required": [
|
|
1364
|
+
"url",
|
|
1365
|
+
"website_id",
|
|
1366
|
+
"version"
|
|
1367
|
+
]
|
|
1368
|
+
},
|
|
1369
|
+
{
|
|
1370
|
+
"type": "object",
|
|
1371
|
+
"properties": {
|
|
1372
|
+
"webhook_id": {
|
|
1373
|
+
"type": "string",
|
|
1374
|
+
"description": "Webhook ID"
|
|
1375
|
+
},
|
|
1376
|
+
"url": {
|
|
1377
|
+
"type": "string",
|
|
1378
|
+
"description": "URL for the webhook"
|
|
1379
|
+
},
|
|
1380
|
+
"website": {
|
|
1381
|
+
"type": "string",
|
|
1382
|
+
"description": "Website name"
|
|
1383
|
+
},
|
|
1384
|
+
"website_id": {
|
|
1385
|
+
"type": "string",
|
|
1386
|
+
"description": "Website ID"
|
|
1387
|
+
},
|
|
1388
|
+
"version": {
|
|
1389
|
+
"type": "string",
|
|
1390
|
+
"description": "API version"
|
|
1391
|
+
},
|
|
1392
|
+
"enabled": {
|
|
1393
|
+
"type": "boolean",
|
|
1394
|
+
"description": "Webhook enabled status"
|
|
1395
|
+
},
|
|
1396
|
+
"created_date": {
|
|
1397
|
+
"type": "integer",
|
|
1398
|
+
"description": "Unix timestamp for creation date"
|
|
1399
|
+
},
|
|
1400
|
+
"created_by": {
|
|
1401
|
+
"type": "string",
|
|
1402
|
+
"description": "Creator of the webhook"
|
|
1403
|
+
}
|
|
1404
|
+
}
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
"type": "object",
|
|
1408
|
+
"properties": {
|
|
1409
|
+
"webhook_id": {
|
|
1410
|
+
"type": "string",
|
|
1411
|
+
"description": "Webhook ID"
|
|
1412
|
+
},
|
|
1413
|
+
"deleted": {
|
|
1414
|
+
"type": "boolean",
|
|
1415
|
+
"description": "Indicates if the webhook was deleted"
|
|
1416
|
+
}
|
|
1417
|
+
}
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"type": "object",
|
|
1421
|
+
"properties": {
|
|
1422
|
+
"website_id": {
|
|
1423
|
+
"type": "string",
|
|
1424
|
+
"description": "Unique identifier for the website"
|
|
1425
|
+
},
|
|
1426
|
+
"host": {
|
|
1427
|
+
"type": "string",
|
|
1428
|
+
"description": "Domain name or hostname of the website (e.g., example.com)"
|
|
1429
|
+
}
|
|
1430
|
+
}
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"type": "object",
|
|
1434
|
+
"properties": {
|
|
1435
|
+
"host": {
|
|
1436
|
+
"type": "string",
|
|
1437
|
+
"description": "Domain name or hostname of the website to track"
|
|
1438
|
+
},
|
|
1439
|
+
"description": {
|
|
1440
|
+
"type": "string",
|
|
1441
|
+
"description": "Optional description of the website for organization purposes"
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"required": [
|
|
1445
|
+
"host"
|
|
1446
|
+
]
|
|
1447
|
+
}
|
|
1448
|
+
]
|