@chatbotkit/sdk 1.21.8 → 1.21.10

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.
@@ -1,883 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "title": "ChatBotKit Report Schemas",
4
- "description": "Input and output schemas for all available reports",
5
- "version": "1.0.0",
6
- "reports": {
7
- "clr3m5n8k000008jq7h9e5b1a": {
8
- "id": "clr3m5n8k000008jq7h9e5b1a",
9
- "name": "Total Ratings Report",
10
- "description": "Comprehensive report on total number of ratings received",
11
- "input": {
12
- "$ref": "#/definitions/total-ratings-report-input",
13
- "definitions": {
14
- "total-ratings-report-input": {
15
- "type": "object",
16
- "properties": {
17
- "userId": {
18
- "type": "string"
19
- },
20
- "periodDays": {
21
- "type": "integer",
22
- "exclusiveMinimum": 0,
23
- "default": 30
24
- }
25
- },
26
- "required": [
27
- "userId"
28
- ],
29
- "additionalProperties": false
30
- }
31
- },
32
- "$schema": "http://json-schema.org/draft-07/schema#"
33
- },
34
- "output": {
35
- "$ref": "#/definitions/total-ratings-report-output",
36
- "definitions": {
37
- "total-ratings-report-output": {
38
- "type": "object",
39
- "properties": {
40
- "value": {
41
- "type": "number"
42
- },
43
- "change": {
44
- "type": "number"
45
- },
46
- "period": {
47
- "type": "string"
48
- },
49
- "breakdown": {
50
- "type": "array",
51
- "items": {
52
- "type": "object",
53
- "properties": {
54
- "date": {
55
- "type": "string"
56
- },
57
- "total": {
58
- "type": "number"
59
- }
60
- },
61
- "required": [
62
- "date",
63
- "total"
64
- ],
65
- "additionalProperties": false
66
- }
67
- },
68
- "thumbsUp": {
69
- "type": "number"
70
- },
71
- "thumbsDown": {
72
- "type": "number"
73
- }
74
- },
75
- "required": [
76
- "value",
77
- "period"
78
- ],
79
- "additionalProperties": false
80
- }
81
- },
82
- "$schema": "http://json-schema.org/draft-07/schema#"
83
- },
84
- "createdAt": "2025-11-17T00:00:00.000Z",
85
- "updatedAt": "2025-11-17T00:00:00.000Z"
86
- },
87
- "clr3m5n8k000108jq3c4d7f2b": {
88
- "id": "clr3m5n8k000108jq3c4d7f2b",
89
- "name": "Thumbs Up Report",
90
- "description": "Report on positive ratings received",
91
- "input": {
92
- "$ref": "#/definitions/thumbs-up-report-input",
93
- "definitions": {
94
- "thumbs-up-report-input": {
95
- "type": "object",
96
- "properties": {
97
- "userId": {
98
- "type": "string"
99
- },
100
- "periodDays": {
101
- "type": "integer",
102
- "exclusiveMinimum": 0,
103
- "default": 30
104
- }
105
- },
106
- "required": [
107
- "userId"
108
- ],
109
- "additionalProperties": false
110
- }
111
- },
112
- "$schema": "http://json-schema.org/draft-07/schema#"
113
- },
114
- "output": {
115
- "$ref": "#/definitions/thumbs-up-report-output",
116
- "definitions": {
117
- "thumbs-up-report-output": {
118
- "type": "object",
119
- "properties": {
120
- "value": {
121
- "type": "number"
122
- },
123
- "change": {
124
- "type": "number"
125
- },
126
- "period": {
127
- "type": "string"
128
- },
129
- "breakdown": {
130
- "type": "array",
131
- "items": {
132
- "type": "object",
133
- "properties": {
134
- "date": {
135
- "type": "string"
136
- },
137
- "total": {
138
- "type": "number"
139
- }
140
- },
141
- "required": [
142
- "date",
143
- "total"
144
- ],
145
- "additionalProperties": false
146
- }
147
- }
148
- },
149
- "required": [
150
- "value",
151
- "period"
152
- ],
153
- "additionalProperties": false
154
- }
155
- },
156
- "$schema": "http://json-schema.org/draft-07/schema#"
157
- },
158
- "createdAt": "2025-11-17T00:00:00.000Z",
159
- "updatedAt": "2025-11-17T00:00:00.000Z"
160
- },
161
- "clr3m5n8k000208jq8e5f6g3c": {
162
- "id": "clr3m5n8k000208jq8e5f6g3c",
163
- "name": "Thumbs Down Report",
164
- "description": "Report on negative ratings received",
165
- "input": {
166
- "$ref": "#/definitions/thumbs-down-report-input",
167
- "definitions": {
168
- "thumbs-down-report-input": {
169
- "type": "object",
170
- "properties": {
171
- "userId": {
172
- "type": "string"
173
- },
174
- "periodDays": {
175
- "type": "integer",
176
- "exclusiveMinimum": 0,
177
- "default": 30
178
- }
179
- },
180
- "required": [
181
- "userId"
182
- ],
183
- "additionalProperties": false
184
- }
185
- },
186
- "$schema": "http://json-schema.org/draft-07/schema#"
187
- },
188
- "output": {
189
- "$ref": "#/definitions/thumbs-down-report-output",
190
- "definitions": {
191
- "thumbs-down-report-output": {
192
- "type": "object",
193
- "properties": {
194
- "value": {
195
- "type": "number"
196
- },
197
- "change": {
198
- "type": "number"
199
- },
200
- "period": {
201
- "type": "string"
202
- },
203
- "breakdown": {
204
- "type": "array",
205
- "items": {
206
- "type": "object",
207
- "properties": {
208
- "date": {
209
- "type": "string"
210
- },
211
- "total": {
212
- "type": "number"
213
- }
214
- },
215
- "required": [
216
- "date",
217
- "total"
218
- ],
219
- "additionalProperties": false
220
- }
221
- }
222
- },
223
- "required": [
224
- "value",
225
- "period"
226
- ],
227
- "additionalProperties": false
228
- }
229
- },
230
- "$schema": "http://json-schema.org/draft-07/schema#"
231
- },
232
- "createdAt": "2025-11-17T00:00:00.000Z",
233
- "updatedAt": "2025-11-17T00:00:00.000Z"
234
- },
235
- "clr3m5n8k000308jq1h7i8j4d": {
236
- "id": "clr3m5n8k000308jq1h7i8j4d",
237
- "name": "Total Contacts Report",
238
- "description": "Report on total number of unique contacts/users",
239
- "input": {
240
- "$ref": "#/definitions/total-contacts-report-input",
241
- "definitions": {
242
- "total-contacts-report-input": {
243
- "type": "object",
244
- "properties": {
245
- "userId": {
246
- "type": "string"
247
- }
248
- },
249
- "required": [
250
- "userId"
251
- ],
252
- "additionalProperties": false
253
- }
254
- },
255
- "$schema": "http://json-schema.org/draft-07/schema#"
256
- },
257
- "output": {
258
- "$ref": "#/definitions/total-contacts-report-output",
259
- "definitions": {
260
- "total-contacts-report-output": {
261
- "type": "object",
262
- "properties": {
263
- "value": {
264
- "type": "number"
265
- },
266
- "period": {
267
- "type": "string"
268
- }
269
- },
270
- "required": [
271
- "value",
272
- "period"
273
- ],
274
- "additionalProperties": false
275
- }
276
- },
277
- "$schema": "http://json-schema.org/draft-07/schema#"
278
- },
279
- "createdAt": "2025-11-17T00:00:00.000Z",
280
- "updatedAt": "2025-11-17T00:00:00.000Z"
281
- },
282
- "clr3m5n8k000408jq9i8j9k5e": {
283
- "id": "clr3m5n8k000408jq9i8j9k5e",
284
- "name": "Active Contacts Report",
285
- "description": "Report on number of active contacts with conversations",
286
- "input": {
287
- "$ref": "#/definitions/active-contacts-report-input",
288
- "definitions": {
289
- "active-contacts-report-input": {
290
- "type": "object",
291
- "properties": {
292
- "userId": {
293
- "type": "string"
294
- },
295
- "periodDays": {
296
- "type": "integer",
297
- "exclusiveMinimum": 0,
298
- "default": 30
299
- }
300
- },
301
- "required": [
302
- "userId"
303
- ],
304
- "additionalProperties": false
305
- }
306
- },
307
- "$schema": "http://json-schema.org/draft-07/schema#"
308
- },
309
- "output": {
310
- "$ref": "#/definitions/active-contacts-report-output",
311
- "definitions": {
312
- "active-contacts-report-output": {
313
- "type": "object",
314
- "properties": {
315
- "value": {
316
- "type": "number"
317
- },
318
- "change": {
319
- "type": "number"
320
- },
321
- "period": {
322
- "type": "string"
323
- },
324
- "breakdown": {
325
- "type": "array",
326
- "items": {
327
- "type": "object",
328
- "properties": {
329
- "date": {
330
- "type": "string"
331
- },
332
- "total": {
333
- "type": "number"
334
- }
335
- },
336
- "required": [
337
- "date",
338
- "total"
339
- ],
340
- "additionalProperties": false
341
- }
342
- }
343
- },
344
- "required": [
345
- "value",
346
- "period"
347
- ],
348
- "additionalProperties": false
349
- }
350
- },
351
- "$schema": "http://json-schema.org/draft-07/schema#"
352
- },
353
- "createdAt": "2025-11-17T00:00:00.000Z",
354
- "updatedAt": "2025-11-17T00:00:00.000Z"
355
- },
356
- "clr3m5n8k000508jq2j9k0l6f": {
357
- "id": "clr3m5n8k000508jq2j9k0l6f",
358
- "name": "Total Conversations Report",
359
- "description": "Report on total number of conversations handled",
360
- "input": {
361
- "$ref": "#/definitions/total-conversations-report-input",
362
- "definitions": {
363
- "total-conversations-report-input": {
364
- "type": "object",
365
- "properties": {
366
- "userId": {
367
- "type": "string"
368
- },
369
- "periodDays": {
370
- "type": "integer",
371
- "exclusiveMinimum": 0,
372
- "default": 30
373
- }
374
- },
375
- "required": [
376
- "userId"
377
- ],
378
- "additionalProperties": false
379
- }
380
- },
381
- "$schema": "http://json-schema.org/draft-07/schema#"
382
- },
383
- "output": {
384
- "$ref": "#/definitions/total-conversations-report-output",
385
- "definitions": {
386
- "total-conversations-report-output": {
387
- "type": "object",
388
- "properties": {
389
- "value": {
390
- "type": "number"
391
- },
392
- "change": {
393
- "type": "number"
394
- },
395
- "period": {
396
- "type": "string"
397
- },
398
- "breakdown": {
399
- "type": "array",
400
- "items": {
401
- "type": "object",
402
- "properties": {
403
- "date": {
404
- "type": "string"
405
- },
406
- "total": {
407
- "type": "number"
408
- }
409
- },
410
- "required": [
411
- "date",
412
- "total"
413
- ],
414
- "additionalProperties": false
415
- }
416
- }
417
- },
418
- "required": [
419
- "value",
420
- "period"
421
- ],
422
- "additionalProperties": false
423
- }
424
- },
425
- "$schema": "http://json-schema.org/draft-07/schema#"
426
- },
427
- "createdAt": "2025-11-17T00:00:00.000Z",
428
- "updatedAt": "2025-11-17T00:00:00.000Z"
429
- },
430
- "clr3m5n8k000608jq3k0l1m7g": {
431
- "id": "clr3m5n8k000608jq3k0l1m7g",
432
- "name": "Total Messages Report",
433
- "description": "Report on total number of messages exchanged",
434
- "input": {
435
- "$ref": "#/definitions/total-messages-report-input",
436
- "definitions": {
437
- "total-messages-report-input": {
438
- "type": "object",
439
- "properties": {
440
- "userId": {
441
- "type": "string"
442
- },
443
- "periodDays": {
444
- "type": "integer",
445
- "exclusiveMinimum": 0,
446
- "default": 30
447
- }
448
- },
449
- "required": [
450
- "userId"
451
- ],
452
- "additionalProperties": false
453
- }
454
- },
455
- "$schema": "http://json-schema.org/draft-07/schema#"
456
- },
457
- "output": {
458
- "$ref": "#/definitions/total-messages-report-output",
459
- "definitions": {
460
- "total-messages-report-output": {
461
- "type": "object",
462
- "properties": {
463
- "value": {
464
- "type": "number"
465
- },
466
- "change": {
467
- "type": "number"
468
- },
469
- "period": {
470
- "type": "string"
471
- },
472
- "breakdown": {
473
- "type": "array",
474
- "items": {
475
- "type": "object",
476
- "properties": {
477
- "date": {
478
- "type": "string"
479
- },
480
- "total": {
481
- "type": "number"
482
- }
483
- },
484
- "required": [
485
- "date",
486
- "total"
487
- ],
488
- "additionalProperties": false
489
- }
490
- }
491
- },
492
- "required": [
493
- "value",
494
- "period"
495
- ],
496
- "additionalProperties": false
497
- }
498
- },
499
- "$schema": "http://json-schema.org/draft-07/schema#"
500
- },
501
- "createdAt": "2025-11-17T00:00:00.000Z",
502
- "updatedAt": "2025-11-17T00:00:00.000Z"
503
- },
504
- "clr3m5n8k000708jq4l1m2n8h": {
505
- "id": "clr3m5n8k000708jq4l1m2n8h",
506
- "name": "User Messages Report",
507
- "description": "Report on number of user messages/requests processed",
508
- "input": {
509
- "$ref": "#/definitions/user-messages-report-input",
510
- "definitions": {
511
- "user-messages-report-input": {
512
- "type": "object",
513
- "properties": {
514
- "userId": {
515
- "type": "string"
516
- },
517
- "periodDays": {
518
- "type": "integer",
519
- "exclusiveMinimum": 0,
520
- "default": 30
521
- }
522
- },
523
- "required": [
524
- "userId"
525
- ],
526
- "additionalProperties": false
527
- }
528
- },
529
- "$schema": "http://json-schema.org/draft-07/schema#"
530
- },
531
- "output": {
532
- "$ref": "#/definitions/user-messages-report-output",
533
- "definitions": {
534
- "user-messages-report-output": {
535
- "type": "object",
536
- "properties": {
537
- "value": {
538
- "type": "number"
539
- },
540
- "change": {
541
- "type": "number"
542
- },
543
- "period": {
544
- "type": "string"
545
- },
546
- "breakdown": {
547
- "type": "array",
548
- "items": {
549
- "type": "object",
550
- "properties": {
551
- "date": {
552
- "type": "string"
553
- },
554
- "total": {
555
- "type": "number"
556
- }
557
- },
558
- "required": [
559
- "date",
560
- "total"
561
- ],
562
- "additionalProperties": false
563
- }
564
- }
565
- },
566
- "required": [
567
- "value",
568
- "period"
569
- ],
570
- "additionalProperties": false
571
- }
572
- },
573
- "$schema": "http://json-schema.org/draft-07/schema#"
574
- },
575
- "createdAt": "2025-11-17T00:00:00.000Z",
576
- "updatedAt": "2025-11-17T00:00:00.000Z"
577
- },
578
- "clr3m5n8k000808jq5m2n3o9i": {
579
- "id": "clr3m5n8k000808jq5m2n3o9i",
580
- "name": "Bot Messages Report",
581
- "description": "Report on number of bot/agent responses delivered",
582
- "input": {
583
- "$ref": "#/definitions/bot-messages-report-input",
584
- "definitions": {
585
- "bot-messages-report-input": {
586
- "type": "object",
587
- "properties": {
588
- "userId": {
589
- "type": "string"
590
- },
591
- "periodDays": {
592
- "type": "integer",
593
- "exclusiveMinimum": 0,
594
- "default": 30
595
- }
596
- },
597
- "required": [
598
- "userId"
599
- ],
600
- "additionalProperties": false
601
- }
602
- },
603
- "$schema": "http://json-schema.org/draft-07/schema#"
604
- },
605
- "output": {
606
- "$ref": "#/definitions/bot-messages-report-output",
607
- "definitions": {
608
- "bot-messages-report-output": {
609
- "type": "object",
610
- "properties": {
611
- "value": {
612
- "type": "number"
613
- },
614
- "change": {
615
- "type": "number"
616
- },
617
- "period": {
618
- "type": "string"
619
- },
620
- "breakdown": {
621
- "type": "array",
622
- "items": {
623
- "type": "object",
624
- "properties": {
625
- "date": {
626
- "type": "string"
627
- },
628
- "total": {
629
- "type": "number"
630
- }
631
- },
632
- "required": [
633
- "date",
634
- "total"
635
- ],
636
- "additionalProperties": false
637
- }
638
- }
639
- },
640
- "required": [
641
- "value",
642
- "period"
643
- ],
644
- "additionalProperties": false
645
- }
646
- },
647
- "$schema": "http://json-schema.org/draft-07/schema#"
648
- },
649
- "createdAt": "2025-11-17T00:00:00.000Z",
650
- "updatedAt": "2025-11-17T00:00:00.000Z"
651
- },
652
- "clr3m5n8k000908jq6n3o4p0j": {
653
- "id": "clr3m5n8k000908jq6n3o4p0j",
654
- "name": "Activity Messages Report",
655
- "description": "Report on number of agent actions taken",
656
- "input": {
657
- "$ref": "#/definitions/activity-messages-report-input",
658
- "definitions": {
659
- "activity-messages-report-input": {
660
- "type": "object",
661
- "properties": {
662
- "userId": {
663
- "type": "string"
664
- },
665
- "periodDays": {
666
- "type": "integer",
667
- "exclusiveMinimum": 0,
668
- "default": 30
669
- }
670
- },
671
- "required": [
672
- "userId"
673
- ],
674
- "additionalProperties": false
675
- }
676
- },
677
- "$schema": "http://json-schema.org/draft-07/schema#"
678
- },
679
- "output": {
680
- "$ref": "#/definitions/activity-messages-report-output",
681
- "definitions": {
682
- "activity-messages-report-output": {
683
- "type": "object",
684
- "properties": {
685
- "value": {
686
- "type": "number"
687
- },
688
- "change": {
689
- "type": "number"
690
- },
691
- "period": {
692
- "type": "string"
693
- },
694
- "breakdown": {
695
- "type": "array",
696
- "items": {
697
- "type": "object",
698
- "properties": {
699
- "date": {
700
- "type": "string"
701
- },
702
- "total": {
703
- "type": "number"
704
- }
705
- },
706
- "required": [
707
- "date",
708
- "total"
709
- ],
710
- "additionalProperties": false
711
- }
712
- }
713
- },
714
- "required": [
715
- "value",
716
- "period"
717
- ],
718
- "additionalProperties": false
719
- }
720
- },
721
- "$schema": "http://json-schema.org/draft-07/schema#"
722
- },
723
- "createdAt": "2025-11-17T00:00:00.000Z",
724
- "updatedAt": "2025-11-17T00:00:00.000Z"
725
- },
726
- "clr3m5n8k000a08jq7o4p5q1k": {
727
- "id": "clr3m5n8k000a08jq7o4p5q1k",
728
- "name": "Average User Messages per Conversation Report",
729
- "description": "Report on average number of user messages per conversation",
730
- "input": {
731
- "$ref": "#/definitions/average-user-messages-per-conversation-report-input",
732
- "definitions": {
733
- "average-user-messages-per-conversation-report-input": {
734
- "type": "object",
735
- "properties": {
736
- "userId": {
737
- "type": "string"
738
- },
739
- "periodDays": {
740
- "type": "integer",
741
- "exclusiveMinimum": 0,
742
- "default": 30
743
- }
744
- },
745
- "required": [
746
- "userId"
747
- ],
748
- "additionalProperties": false
749
- }
750
- },
751
- "$schema": "http://json-schema.org/draft-07/schema#"
752
- },
753
- "output": {
754
- "$ref": "#/definitions/average-user-messages-per-conversation-report-output",
755
- "definitions": {
756
- "average-user-messages-per-conversation-report-output": {
757
- "type": "object",
758
- "properties": {
759
- "value": {
760
- "type": "number"
761
- },
762
- "period": {
763
- "type": "string"
764
- }
765
- },
766
- "required": [
767
- "value",
768
- "period"
769
- ],
770
- "additionalProperties": false
771
- }
772
- },
773
- "$schema": "http://json-schema.org/draft-07/schema#"
774
- },
775
- "createdAt": "2025-11-17T00:00:00.000Z",
776
- "updatedAt": "2025-11-17T00:00:00.000Z"
777
- },
778
- "clr3m5n8k000b08jq8p5q6r2l": {
779
- "id": "clr3m5n8k000b08jq8p5q6r2l",
780
- "name": "Average Bot Messages per Conversation Report",
781
- "description": "Report on average number of bot responses per conversation",
782
- "input": {
783
- "$ref": "#/definitions/average-bot-messages-per-conversation-report-input",
784
- "definitions": {
785
- "average-bot-messages-per-conversation-report-input": {
786
- "type": "object",
787
- "properties": {
788
- "userId": {
789
- "type": "string"
790
- },
791
- "periodDays": {
792
- "type": "integer",
793
- "exclusiveMinimum": 0,
794
- "default": 30
795
- }
796
- },
797
- "required": [
798
- "userId"
799
- ],
800
- "additionalProperties": false
801
- }
802
- },
803
- "$schema": "http://json-schema.org/draft-07/schema#"
804
- },
805
- "output": {
806
- "$ref": "#/definitions/average-bot-messages-per-conversation-report-output",
807
- "definitions": {
808
- "average-bot-messages-per-conversation-report-output": {
809
- "type": "object",
810
- "properties": {
811
- "value": {
812
- "type": "number"
813
- },
814
- "period": {
815
- "type": "string"
816
- }
817
- },
818
- "required": [
819
- "value",
820
- "period"
821
- ],
822
- "additionalProperties": false
823
- }
824
- },
825
- "$schema": "http://json-schema.org/draft-07/schema#"
826
- },
827
- "createdAt": "2025-11-17T00:00:00.000Z",
828
- "updatedAt": "2025-11-17T00:00:00.000Z"
829
- },
830
- "clr3m5n8k000c08jq9q6r7s3m": {
831
- "id": "clr3m5n8k000c08jq9q6r7s3m",
832
- "name": "Average Actions per Conversation Report",
833
- "description": "Report on average number of actions per conversation",
834
- "input": {
835
- "$ref": "#/definitions/average-actions-per-conversation-report-input",
836
- "definitions": {
837
- "average-actions-per-conversation-report-input": {
838
- "type": "object",
839
- "properties": {
840
- "userId": {
841
- "type": "string"
842
- },
843
- "periodDays": {
844
- "type": "integer",
845
- "exclusiveMinimum": 0,
846
- "default": 30
847
- }
848
- },
849
- "required": [
850
- "userId"
851
- ],
852
- "additionalProperties": false
853
- }
854
- },
855
- "$schema": "http://json-schema.org/draft-07/schema#"
856
- },
857
- "output": {
858
- "$ref": "#/definitions/average-actions-per-conversation-report-output",
859
- "definitions": {
860
- "average-actions-per-conversation-report-output": {
861
- "type": "object",
862
- "properties": {
863
- "value": {
864
- "type": "number"
865
- },
866
- "period": {
867
- "type": "string"
868
- }
869
- },
870
- "required": [
871
- "value",
872
- "period"
873
- ],
874
- "additionalProperties": false
875
- }
876
- },
877
- "$schema": "http://json-schema.org/draft-07/schema#"
878
- },
879
- "createdAt": "2025-11-17T00:00:00.000Z",
880
- "updatedAt": "2025-11-17T00:00:00.000Z"
881
- }
882
- }
883
- }