@produce8/analytics-openapi-types 1.0.0-dev.20251218191537 → 1.0.1

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.
Files changed (4) hide show
  1. package/README.md +1 -14
  2. package/openapi-types.ts +0 -1
  3. package/package.json +1 -2
  4. package/openapi.json +0 -1672
package/openapi.json DELETED
@@ -1,1672 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "paths": {
4
- "/health": {
5
- "get": {
6
- "operationId": "HealthController_healthCheck",
7
- "summary": "Health check endpoint",
8
- "parameters": [],
9
- "responses": {
10
- "200": {
11
- "description": "Service health status",
12
- "content": {
13
- "application/json": {
14
- "schema": {
15
- "type": "object",
16
- "properties": {
17
- "status": {
18
- "type": "string",
19
- "example": "ok"
20
- },
21
- "timestamp": {
22
- "type": "string",
23
- "format": "date-time"
24
- }
25
- }
26
- }
27
- }
28
- }
29
- }
30
- }
31
- }
32
- },
33
- "/get-user-real-time-working-sessions": {
34
- "get": {
35
- "operationId": "RealTimeWorkingSessionsController_getRealTimeWorkingSessions",
36
- "parameters": [
37
- {
38
- "name": "userId",
39
- "required": true,
40
- "in": "query",
41
- "description": "User ID (UUID)",
42
- "example": "123e4567-e89b-12d3-a456-426614174000",
43
- "schema": {
44
- "format": "uuid",
45
- "type": "string"
46
- }
47
- },
48
- {
49
- "name": "accountId",
50
- "required": true,
51
- "in": "query",
52
- "description": "Account ID (UUID)",
53
- "example": "123e4567-e89b-12d3-a456-426614174000",
54
- "schema": {
55
- "format": "uuid",
56
- "type": "string"
57
- }
58
- },
59
- {
60
- "name": "date",
61
- "required": true,
62
- "in": "query",
63
- "description": "Date in YYYY-MM-DD format",
64
- "example": "2025-11-22",
65
- "schema": {
66
- "format": "date",
67
- "type": "string"
68
- }
69
- },
70
- {
71
- "name": "utcOffset",
72
- "required": true,
73
- "in": "query",
74
- "description": "UTC offset in format: UTC, UTC-8, UTC+5, etc.",
75
- "example": "UTC-8",
76
- "schema": {
77
- "type": "string"
78
- }
79
- }
80
- ],
81
- "responses": {
82
- "200": {
83
- "description": "Returns real-time working sessions for the user",
84
- "content": {
85
- "application/json": {
86
- "schema": {
87
- "$ref": "#/components/schemas/RealTimeWorkingSessionsResponseDto"
88
- }
89
- }
90
- }
91
- }
92
- }
93
- }
94
- },
95
- "/app-usage-metrics": {
96
- "get": {
97
- "operationId": "AppUsageReportController_getAppUsageMetrics",
98
- "parameters": [
99
- {
100
- "name": "averagingPeriod",
101
- "required": true,
102
- "in": "query",
103
- "description": "Averaging period for metrics",
104
- "schema": {
105
- "enum": [
106
- "day",
107
- "week",
108
- "month",
109
- "quarter",
110
- "year"
111
- ],
112
- "type": "string"
113
- }
114
- },
115
- {
116
- "name": "averagingType",
117
- "required": true,
118
- "in": "query",
119
- "description": "Averaging type (total or perUser)",
120
- "schema": {
121
- "enum": [
122
- "total",
123
- "perUser"
124
- ],
125
- "type": "string"
126
- }
127
- },
128
- {
129
- "name": "startDate",
130
- "required": true,
131
- "in": "query",
132
- "description": "Start date for the metrics period",
133
- "schema": {
134
- "format": "date",
135
- "type": "string"
136
- }
137
- },
138
- {
139
- "name": "endDate",
140
- "required": false,
141
- "in": "query",
142
- "description": "End date for the metrics period",
143
- "schema": {
144
- "format": "date",
145
- "type": "string"
146
- }
147
- },
148
- {
149
- "name": "userIds",
150
- "required": false,
151
- "in": "query",
152
- "description": "Filter by user IDs",
153
- "schema": {
154
- "format": "uuid",
155
- "type": "array",
156
- "items": {
157
- "type": "string"
158
- }
159
- }
160
- },
161
- {
162
- "name": "departmentId",
163
- "required": false,
164
- "in": "query",
165
- "description": "Filter by department ID",
166
- "schema": {
167
- "format": "uuid",
168
- "type": "string"
169
- }
170
- },
171
- {
172
- "name": "workspaceId",
173
- "required": false,
174
- "in": "query",
175
- "description": "Filter by workspace ID",
176
- "schema": {
177
- "format": "uuid",
178
- "type": "string"
179
- }
180
- },
181
- {
182
- "name": "appCategoryId",
183
- "required": false,
184
- "in": "query",
185
- "description": "Filter by app category ID",
186
- "schema": {
187
- "format": "uuid",
188
- "type": "string"
189
- }
190
- },
191
- {
192
- "name": "appIds",
193
- "required": false,
194
- "in": "query",
195
- "description": "Filter by app IDs",
196
- "schema": {
197
- "format": "uuid",
198
- "type": "array",
199
- "items": {
200
- "type": "string"
201
- }
202
- }
203
- },
204
- {
205
- "name": "accountId",
206
- "required": false,
207
- "in": "query",
208
- "description": "Filter by account ID",
209
- "schema": {
210
- "format": "uuid",
211
- "type": "string"
212
- }
213
- },
214
- {
215
- "name": "comparisonStartDate",
216
- "required": false,
217
- "in": "query",
218
- "description": "Start date for comparison period",
219
- "schema": {
220
- "format": "date",
221
- "type": "string"
222
- }
223
- },
224
- {
225
- "name": "comparisonEndDate",
226
- "required": false,
227
- "in": "query",
228
- "description": "End date for comparison period",
229
- "schema": {
230
- "format": "date",
231
- "type": "string"
232
- }
233
- },
234
- {
235
- "name": "hourlyRate",
236
- "required": false,
237
- "in": "query",
238
- "description": "Hourly rate for cost calculation",
239
- "schema": {
240
- "type": "number"
241
- }
242
- },
243
- {
244
- "name": "first",
245
- "required": false,
246
- "in": "query",
247
- "description": "Number of items to return",
248
- "schema": {
249
- "minimum": 1,
250
- "maximum": 100,
251
- "type": "number"
252
- }
253
- },
254
- {
255
- "name": "after",
256
- "required": false,
257
- "in": "query",
258
- "description": "Cursor for pagination",
259
- "schema": {
260
- "type": "number"
261
- }
262
- },
263
- {
264
- "name": "sortField",
265
- "required": false,
266
- "in": "query",
267
- "description": "Field to sort by",
268
- "schema": {
269
- "enum": [
270
- "appName",
271
- "appCreatedDate",
272
- "appCategoryName",
273
- "uniqueUsers",
274
- "uniqueUsersDeviation",
275
- "duration",
276
- "durationDeviation",
277
- "interactions",
278
- "interactionsDeviation",
279
- "cost",
280
- "costDeviation"
281
- ],
282
- "type": "string"
283
- }
284
- },
285
- {
286
- "name": "sortDirection",
287
- "required": false,
288
- "in": "query",
289
- "description": "Sort direction",
290
- "schema": {
291
- "enum": [
292
- "ASC",
293
- "DESC"
294
- ],
295
- "type": "string"
296
- }
297
- },
298
- {
299
- "name": "metricType",
300
- "required": true,
301
- "in": "query",
302
- "description": "Type of metric to retrieve",
303
- "schema": {
304
- "enum": [
305
- "uniqueUsers",
306
- "duration",
307
- "interactions",
308
- "cost"
309
- ],
310
- "type": "string"
311
- }
312
- }
313
- ],
314
- "responses": {
315
- "200": {
316
- "description": "Returns app usage metrics list",
317
- "content": {
318
- "application/json": {
319
- "schema": {
320
- "$ref": "#/components/schemas/AppUsageMetricsListResponseDto"
321
- }
322
- }
323
- }
324
- }
325
- }
326
- }
327
- },
328
- "/app-usage-metrics/highlights": {
329
- "get": {
330
- "operationId": "AppUsageReportController_getAppUsageMetricsHighlights",
331
- "parameters": [
332
- {
333
- "name": "averagingPeriod",
334
- "required": true,
335
- "in": "query",
336
- "description": "Averaging period for metrics",
337
- "schema": {
338
- "enum": [
339
- "day",
340
- "week",
341
- "month",
342
- "quarter",
343
- "year"
344
- ],
345
- "type": "string"
346
- }
347
- },
348
- {
349
- "name": "averagingType",
350
- "required": true,
351
- "in": "query",
352
- "description": "Averaging type (total or perUser)",
353
- "schema": {
354
- "enum": [
355
- "total",
356
- "perUser"
357
- ],
358
- "type": "string"
359
- }
360
- },
361
- {
362
- "name": "startDate",
363
- "required": true,
364
- "in": "query",
365
- "description": "Start date for the metrics period",
366
- "schema": {
367
- "format": "date",
368
- "type": "string"
369
- }
370
- },
371
- {
372
- "name": "endDate",
373
- "required": false,
374
- "in": "query",
375
- "description": "End date for the metrics period",
376
- "schema": {
377
- "format": "date",
378
- "type": "string"
379
- }
380
- },
381
- {
382
- "name": "userIds",
383
- "required": false,
384
- "in": "query",
385
- "description": "Filter by user IDs",
386
- "schema": {
387
- "format": "uuid",
388
- "type": "array",
389
- "items": {
390
- "type": "string"
391
- }
392
- }
393
- },
394
- {
395
- "name": "departmentId",
396
- "required": false,
397
- "in": "query",
398
- "description": "Filter by department ID",
399
- "schema": {
400
- "format": "uuid",
401
- "type": "string"
402
- }
403
- },
404
- {
405
- "name": "workspaceId",
406
- "required": false,
407
- "in": "query",
408
- "description": "Filter by workspace ID",
409
- "schema": {
410
- "format": "uuid",
411
- "type": "string"
412
- }
413
- },
414
- {
415
- "name": "appCategoryId",
416
- "required": false,
417
- "in": "query",
418
- "description": "Filter by app category ID",
419
- "schema": {
420
- "format": "uuid",
421
- "type": "string"
422
- }
423
- },
424
- {
425
- "name": "appIds",
426
- "required": false,
427
- "in": "query",
428
- "description": "Filter by app IDs",
429
- "schema": {
430
- "format": "uuid",
431
- "type": "array",
432
- "items": {
433
- "type": "string"
434
- }
435
- }
436
- },
437
- {
438
- "name": "accountId",
439
- "required": false,
440
- "in": "query",
441
- "description": "Filter by account ID",
442
- "schema": {
443
- "format": "uuid",
444
- "type": "string"
445
- }
446
- },
447
- {
448
- "name": "comparisonStartDate",
449
- "required": true,
450
- "in": "query",
451
- "description": "Start date for comparison period",
452
- "schema": {
453
- "format": "date",
454
- "type": "string"
455
- }
456
- },
457
- {
458
- "name": "comparisonEndDate",
459
- "required": true,
460
- "in": "query",
461
- "description": "End date for comparison period",
462
- "schema": {
463
- "format": "date",
464
- "type": "string"
465
- }
466
- },
467
- {
468
- "name": "hourlyRate",
469
- "required": false,
470
- "in": "query",
471
- "description": "Hourly rate for cost calculation",
472
- "schema": {
473
- "type": "number"
474
- }
475
- },
476
- {
477
- "name": "first",
478
- "required": false,
479
- "in": "query",
480
- "description": "Number of items to return",
481
- "schema": {
482
- "minimum": 1,
483
- "maximum": 100,
484
- "type": "number"
485
- }
486
- },
487
- {
488
- "name": "after",
489
- "required": false,
490
- "in": "query",
491
- "description": "Cursor for pagination",
492
- "schema": {
493
- "type": "number"
494
- }
495
- },
496
- {
497
- "name": "sortField",
498
- "required": false,
499
- "in": "query",
500
- "description": "Field to sort by",
501
- "schema": {
502
- "enum": [
503
- "appName",
504
- "appCreatedDate",
505
- "appCategoryName",
506
- "uniqueUsers",
507
- "uniqueUsersDeviation",
508
- "duration",
509
- "durationDeviation",
510
- "interactions",
511
- "interactionsDeviation",
512
- "cost",
513
- "costDeviation"
514
- ],
515
- "type": "string"
516
- }
517
- },
518
- {
519
- "name": "sortDirection",
520
- "required": false,
521
- "in": "query",
522
- "description": "Sort direction",
523
- "schema": {
524
- "enum": [
525
- "ASC",
526
- "DESC"
527
- ],
528
- "type": "string"
529
- }
530
- },
531
- {
532
- "name": "metricType",
533
- "required": true,
534
- "in": "query",
535
- "description": "Type of metric to retrieve",
536
- "schema": {
537
- "enum": [
538
- "uniqueUsers",
539
- "duration",
540
- "interactions",
541
- "cost"
542
- ],
543
- "type": "string"
544
- }
545
- }
546
- ],
547
- "responses": {
548
- "200": {
549
- "description": "Returns app usage metrics highlights",
550
- "content": {
551
- "application/json": {
552
- "schema": {
553
- "$ref": "#/components/schemas/AppUsageMetricsHighlightsResponseDto"
554
- }
555
- }
556
- }
557
- }
558
- }
559
- }
560
- },
561
- "/app-usage-metrics/search": {
562
- "get": {
563
- "operationId": "AppUsageReportController_searchAppUsageMetrics",
564
- "parameters": [
565
- {
566
- "name": "query",
567
- "required": true,
568
- "in": "query",
569
- "description": "Search query string",
570
- "schema": {
571
- "type": "string"
572
- }
573
- },
574
- {
575
- "name": "averagingPeriod",
576
- "required": true,
577
- "in": "query",
578
- "description": "Averaging period for metrics",
579
- "schema": {
580
- "enum": [
581
- "day",
582
- "week",
583
- "month",
584
- "quarter",
585
- "year"
586
- ],
587
- "type": "string"
588
- }
589
- },
590
- {
591
- "name": "averagingType",
592
- "required": true,
593
- "in": "query",
594
- "description": "Averaging type (total or perUser)",
595
- "schema": {
596
- "enum": [
597
- "total",
598
- "perUser"
599
- ],
600
- "type": "string"
601
- }
602
- },
603
- {
604
- "name": "startDate",
605
- "required": true,
606
- "in": "query",
607
- "description": "Start date for the metrics period",
608
- "schema": {
609
- "format": "date",
610
- "type": "string"
611
- }
612
- },
613
- {
614
- "name": "endDate",
615
- "required": false,
616
- "in": "query",
617
- "description": "End date for the metrics period",
618
- "schema": {
619
- "format": "date",
620
- "type": "string"
621
- }
622
- },
623
- {
624
- "name": "userIds",
625
- "required": false,
626
- "in": "query",
627
- "description": "Filter by user IDs",
628
- "schema": {
629
- "format": "uuid",
630
- "type": "array",
631
- "items": {
632
- "type": "string"
633
- }
634
- }
635
- },
636
- {
637
- "name": "departmentId",
638
- "required": false,
639
- "in": "query",
640
- "description": "Filter by department ID",
641
- "schema": {
642
- "format": "uuid",
643
- "type": "string"
644
- }
645
- },
646
- {
647
- "name": "workspaceId",
648
- "required": false,
649
- "in": "query",
650
- "description": "Filter by workspace ID",
651
- "schema": {
652
- "format": "uuid",
653
- "type": "string"
654
- }
655
- },
656
- {
657
- "name": "appCategoryId",
658
- "required": false,
659
- "in": "query",
660
- "description": "Filter by app category ID",
661
- "schema": {
662
- "format": "uuid",
663
- "type": "string"
664
- }
665
- },
666
- {
667
- "name": "appIds",
668
- "required": false,
669
- "in": "query",
670
- "description": "Filter by app IDs",
671
- "schema": {
672
- "format": "uuid",
673
- "type": "array",
674
- "items": {
675
- "type": "string"
676
- }
677
- }
678
- },
679
- {
680
- "name": "accountId",
681
- "required": false,
682
- "in": "query",
683
- "description": "Filter by account ID",
684
- "schema": {
685
- "format": "uuid",
686
- "type": "string"
687
- }
688
- },
689
- {
690
- "name": "hourlyRate",
691
- "required": false,
692
- "in": "query",
693
- "description": "Hourly rate for cost calculation",
694
- "schema": {
695
- "type": "number"
696
- }
697
- },
698
- {
699
- "name": "comparisonStartDate",
700
- "required": false,
701
- "in": "query",
702
- "description": "Start date for comparison period",
703
- "schema": {
704
- "format": "date",
705
- "type": "string"
706
- }
707
- },
708
- {
709
- "name": "comparisonEndDate",
710
- "required": false,
711
- "in": "query",
712
- "description": "End date for comparison period",
713
- "schema": {
714
- "format": "date",
715
- "type": "string"
716
- }
717
- },
718
- {
719
- "name": "first",
720
- "required": false,
721
- "in": "query",
722
- "description": "Number of items to return",
723
- "schema": {
724
- "minimum": 1,
725
- "maximum": 100,
726
- "type": "number"
727
- }
728
- },
729
- {
730
- "name": "after",
731
- "required": false,
732
- "in": "query",
733
- "description": "Cursor for pagination",
734
- "schema": {
735
- "type": "number"
736
- }
737
- },
738
- {
739
- "name": "sortField",
740
- "required": false,
741
- "in": "query",
742
- "description": "Field to sort by",
743
- "schema": {
744
- "enum": [
745
- "appName",
746
- "appCreatedDate",
747
- "appCategoryName",
748
- "uniqueUsers",
749
- "uniqueUsersDeviation",
750
- "duration",
751
- "durationDeviation",
752
- "interactions",
753
- "interactionsDeviation",
754
- "cost",
755
- "costDeviation"
756
- ],
757
- "type": "string"
758
- }
759
- },
760
- {
761
- "name": "sortDirection",
762
- "required": false,
763
- "in": "query",
764
- "description": "Sort direction",
765
- "schema": {
766
- "enum": [
767
- "ASC",
768
- "DESC"
769
- ],
770
- "type": "string"
771
- }
772
- },
773
- {
774
- "name": "metricType",
775
- "required": true,
776
- "in": "query",
777
- "description": "Type of metric to retrieve",
778
- "schema": {
779
- "enum": [
780
- "uniqueUsers",
781
- "duration",
782
- "interactions",
783
- "cost"
784
- ],
785
- "type": "string"
786
- }
787
- }
788
- ],
789
- "responses": {
790
- "200": {
791
- "description": "Returns app usage metrics search results",
792
- "content": {
793
- "application/json": {
794
- "schema": {
795
- "$ref": "#/components/schemas/AppUsageMetricsListResponseDto"
796
- }
797
- }
798
- }
799
- }
800
- }
801
- }
802
- }
803
- },
804
- "info": {
805
- "title": "Produce8Analytics API",
806
- "description": "Automatically generated API documentation",
807
- "version": "1.0.0",
808
- "contact": {}
809
- },
810
- "tags": [],
811
- "servers": [],
812
- "components": {
813
- "schemas": {
814
- "RealTimeWorkingSessionsRequestDto": {
815
- "type": "object",
816
- "properties": {
817
- "userId": {
818
- "type": "string",
819
- "format": "uuid",
820
- "description": "User ID (UUID)",
821
- "example": "123e4567-e89b-12d3-a456-426614174000"
822
- },
823
- "accountId": {
824
- "type": "string",
825
- "format": "uuid",
826
- "description": "Account ID (UUID)",
827
- "example": "123e4567-e89b-12d3-a456-426614174000"
828
- },
829
- "date": {
830
- "type": "string",
831
- "format": "date",
832
- "description": "Date in YYYY-MM-DD format",
833
- "example": "2025-11-22"
834
- },
835
- "utcOffset": {
836
- "type": "string",
837
- "description": "UTC offset in format: UTC, UTC-8, UTC+5, etc.",
838
- "example": "UTC-8"
839
- }
840
- },
841
- "required": [
842
- "userId",
843
- "accountId",
844
- "date",
845
- "utcOffset"
846
- ]
847
- },
848
- "RealTimeWorkingSessionItemDto": {
849
- "type": "object",
850
- "properties": {
851
- "id": {
852
- "type": "string",
853
- "format": "uuid",
854
- "description": "Session identifier (UUID)"
855
- },
856
- "accountId": {
857
- "type": "string",
858
- "format": "uuid",
859
- "description": "Account identifier (UUID)"
860
- },
861
- "userId": {
862
- "type": "string",
863
- "format": "uuid",
864
- "description": "User identifier (UUID)"
865
- },
866
- "localStartTime": {
867
- "type": "string",
868
- "format": "date-time",
869
- "description": "Session start time in local timezone (ISO 8601)"
870
- },
871
- "localEndTime": {
872
- "type": "string",
873
- "format": "date-time",
874
- "description": "Session end time in local timezone (ISO 8601)"
875
- },
876
- "sessionDuration": {
877
- "type": "number",
878
- "description": "Total session duration in milliseconds"
879
- },
880
- "activityCount": {
881
- "type": "number",
882
- "description": "Number of activities in the session"
883
- },
884
- "activityDuration": {
885
- "type": "number",
886
- "description": "Total activity duration in milliseconds"
887
- },
888
- "callCount": {
889
- "type": "number",
890
- "description": "Number of calls in the session"
891
- },
892
- "callDuration": {
893
- "type": "number",
894
- "description": "Total call duration in milliseconds"
895
- },
896
- "contextSwitchCount": {
897
- "type": "number",
898
- "description": "Number of context switches in the session"
899
- },
900
- "focusScore": {
901
- "type": "number",
902
- "minimum": 0,
903
- "maximum": 100,
904
- "description": "Focus score (0-100)"
905
- },
906
- "intensityScore": {
907
- "type": "number",
908
- "minimum": 0,
909
- "maximum": 100,
910
- "description": "Intensity score (0-100)"
911
- },
912
- "timezone": {
913
- "type": "string",
914
- "description": "User's timezone (e.g., 'America/New_York', 'UTC')"
915
- },
916
- "localStartDate": {
917
- "type": "string",
918
- "format": "date",
919
- "description": "Session date in YYYY-MM-DD format"
920
- }
921
- },
922
- "required": [
923
- "id",
924
- "accountId",
925
- "userId",
926
- "localStartTime",
927
- "localEndTime",
928
- "sessionDuration",
929
- "activityCount",
930
- "activityDuration",
931
- "callCount",
932
- "callDuration",
933
- "contextSwitchCount",
934
- "focusScore",
935
- "intensityScore",
936
- "timezone",
937
- "localStartDate"
938
- ]
939
- },
940
- "RealTimeWorkingSessionsResponseDto": {
941
- "type": "object",
942
- "properties": {
943
- "sessions": {
944
- "description": "Array of working sessions",
945
- "type": "array",
946
- "items": {
947
- "$ref": "#/components/schemas/RealTimeWorkingSessionItemDto"
948
- }
949
- },
950
- "count": {
951
- "type": "number",
952
- "description": "Total count of sessions"
953
- }
954
- },
955
- "required": [
956
- "sessions",
957
- "count"
958
- ]
959
- },
960
- "AppUsageMetricsReportRequestDto": {
961
- "type": "object",
962
- "properties": {
963
- "averagingPeriod": {
964
- "type": "string",
965
- "enum": [
966
- "day",
967
- "week",
968
- "month",
969
- "quarter",
970
- "year"
971
- ],
972
- "description": "Averaging period for metrics"
973
- },
974
- "averagingType": {
975
- "type": "string",
976
- "enum": [
977
- "total",
978
- "perUser"
979
- ],
980
- "description": "Averaging type (total or perUser)"
981
- },
982
- "startDate": {
983
- "type": "string",
984
- "format": "date",
985
- "description": "Start date for the metrics period"
986
- },
987
- "endDate": {
988
- "type": "string",
989
- "format": "date",
990
- "description": "End date for the metrics period"
991
- },
992
- "userIds": {
993
- "description": "Filter by user IDs",
994
- "type": "array",
995
- "items": {
996
- "type": "string",
997
- "format": "uuid"
998
- }
999
- },
1000
- "departmentId": {
1001
- "type": "string",
1002
- "format": "uuid",
1003
- "description": "Filter by department ID"
1004
- },
1005
- "workspaceId": {
1006
- "type": "string",
1007
- "format": "uuid",
1008
- "description": "Filter by workspace ID"
1009
- },
1010
- "appCategoryId": {
1011
- "type": "string",
1012
- "format": "uuid",
1013
- "description": "Filter by app category ID"
1014
- },
1015
- "appIds": {
1016
- "description": "Filter by app IDs",
1017
- "type": "array",
1018
- "items": {
1019
- "type": "string",
1020
- "format": "uuid"
1021
- }
1022
- },
1023
- "accountId": {
1024
- "type": "string",
1025
- "format": "uuid",
1026
- "description": "Filter by account ID"
1027
- },
1028
- "comparisonStartDate": {
1029
- "type": "string",
1030
- "format": "date",
1031
- "description": "Start date for comparison period"
1032
- },
1033
- "comparisonEndDate": {
1034
- "type": "string",
1035
- "format": "date",
1036
- "description": "End date for comparison period"
1037
- },
1038
- "hourlyRate": {
1039
- "type": "number",
1040
- "description": "Hourly rate for cost calculation"
1041
- },
1042
- "first": {
1043
- "type": "number",
1044
- "minimum": 1,
1045
- "maximum": 100,
1046
- "description": "Number of items to return"
1047
- },
1048
- "after": {
1049
- "type": "number",
1050
- "description": "Cursor for pagination"
1051
- },
1052
- "sortField": {
1053
- "type": "string",
1054
- "enum": [
1055
- "appName",
1056
- "appCreatedDate",
1057
- "appCategoryName",
1058
- "uniqueUsers",
1059
- "uniqueUsersDeviation",
1060
- "duration",
1061
- "durationDeviation",
1062
- "interactions",
1063
- "interactionsDeviation",
1064
- "cost",
1065
- "costDeviation"
1066
- ],
1067
- "description": "Field to sort by"
1068
- },
1069
- "sortDirection": {
1070
- "type": "string",
1071
- "enum": [
1072
- "ASC",
1073
- "DESC"
1074
- ],
1075
- "description": "Sort direction"
1076
- },
1077
- "metricType": {
1078
- "type": "string",
1079
- "enum": [
1080
- "uniqueUsers",
1081
- "duration",
1082
- "interactions",
1083
- "cost"
1084
- ],
1085
- "description": "Type of metric to retrieve"
1086
- }
1087
- },
1088
- "required": [
1089
- "averagingPeriod",
1090
- "averagingType",
1091
- "startDate",
1092
- "metricType"
1093
- ]
1094
- },
1095
- "AppUsageMetricsHighlightsRequestDto": {
1096
- "type": "object",
1097
- "properties": {
1098
- "averagingPeriod": {
1099
- "type": "string",
1100
- "enum": [
1101
- "day",
1102
- "week",
1103
- "month",
1104
- "quarter",
1105
- "year"
1106
- ],
1107
- "description": "Averaging period for metrics"
1108
- },
1109
- "averagingType": {
1110
- "type": "string",
1111
- "enum": [
1112
- "total",
1113
- "perUser"
1114
- ],
1115
- "description": "Averaging type (total or perUser)"
1116
- },
1117
- "startDate": {
1118
- "type": "string",
1119
- "format": "date",
1120
- "description": "Start date for the metrics period"
1121
- },
1122
- "endDate": {
1123
- "type": "string",
1124
- "format": "date",
1125
- "description": "End date for the metrics period"
1126
- },
1127
- "userIds": {
1128
- "description": "Filter by user IDs",
1129
- "type": "array",
1130
- "items": {
1131
- "type": "string",
1132
- "format": "uuid"
1133
- }
1134
- },
1135
- "departmentId": {
1136
- "type": "string",
1137
- "format": "uuid",
1138
- "description": "Filter by department ID"
1139
- },
1140
- "workspaceId": {
1141
- "type": "string",
1142
- "format": "uuid",
1143
- "description": "Filter by workspace ID"
1144
- },
1145
- "appCategoryId": {
1146
- "type": "string",
1147
- "format": "uuid",
1148
- "description": "Filter by app category ID"
1149
- },
1150
- "appIds": {
1151
- "description": "Filter by app IDs",
1152
- "type": "array",
1153
- "items": {
1154
- "type": "string",
1155
- "format": "uuid"
1156
- }
1157
- },
1158
- "accountId": {
1159
- "type": "string",
1160
- "format": "uuid",
1161
- "description": "Filter by account ID"
1162
- },
1163
- "comparisonStartDate": {
1164
- "type": "string",
1165
- "format": "date",
1166
- "description": "Start date for comparison period"
1167
- },
1168
- "comparisonEndDate": {
1169
- "type": "string",
1170
- "format": "date",
1171
- "description": "End date for comparison period"
1172
- },
1173
- "hourlyRate": {
1174
- "type": "number",
1175
- "description": "Hourly rate for cost calculation"
1176
- },
1177
- "first": {
1178
- "type": "number",
1179
- "minimum": 1,
1180
- "maximum": 100,
1181
- "description": "Number of items to return"
1182
- },
1183
- "after": {
1184
- "type": "number",
1185
- "description": "Cursor for pagination"
1186
- },
1187
- "sortField": {
1188
- "type": "string",
1189
- "enum": [
1190
- "appName",
1191
- "appCreatedDate",
1192
- "appCategoryName",
1193
- "uniqueUsers",
1194
- "uniqueUsersDeviation",
1195
- "duration",
1196
- "durationDeviation",
1197
- "interactions",
1198
- "interactionsDeviation",
1199
- "cost",
1200
- "costDeviation"
1201
- ],
1202
- "description": "Field to sort by"
1203
- },
1204
- "sortDirection": {
1205
- "type": "string",
1206
- "enum": [
1207
- "ASC",
1208
- "DESC"
1209
- ],
1210
- "description": "Sort direction"
1211
- },
1212
- "metricType": {
1213
- "type": "string",
1214
- "enum": [
1215
- "uniqueUsers",
1216
- "duration",
1217
- "interactions",
1218
- "cost"
1219
- ],
1220
- "description": "Type of metric to retrieve"
1221
- }
1222
- },
1223
- "required": [
1224
- "averagingPeriod",
1225
- "averagingType",
1226
- "startDate",
1227
- "comparisonStartDate",
1228
- "comparisonEndDate",
1229
- "metricType"
1230
- ]
1231
- },
1232
- "AppUsageMetricsSearchRequestDto": {
1233
- "type": "object",
1234
- "properties": {
1235
- "query": {
1236
- "type": "string",
1237
- "description": "Search query string"
1238
- },
1239
- "averagingPeriod": {
1240
- "type": "string",
1241
- "enum": [
1242
- "day",
1243
- "week",
1244
- "month",
1245
- "quarter",
1246
- "year"
1247
- ],
1248
- "description": "Averaging period for metrics"
1249
- },
1250
- "averagingType": {
1251
- "type": "string",
1252
- "enum": [
1253
- "total",
1254
- "perUser"
1255
- ],
1256
- "description": "Averaging type (total or perUser)"
1257
- },
1258
- "startDate": {
1259
- "type": "string",
1260
- "format": "date",
1261
- "description": "Start date for the metrics period"
1262
- },
1263
- "endDate": {
1264
- "type": "string",
1265
- "format": "date",
1266
- "description": "End date for the metrics period"
1267
- },
1268
- "userIds": {
1269
- "description": "Filter by user IDs",
1270
- "type": "array",
1271
- "items": {
1272
- "type": "string",
1273
- "format": "uuid"
1274
- }
1275
- },
1276
- "departmentId": {
1277
- "type": "string",
1278
- "format": "uuid",
1279
- "description": "Filter by department ID"
1280
- },
1281
- "workspaceId": {
1282
- "type": "string",
1283
- "format": "uuid",
1284
- "description": "Filter by workspace ID"
1285
- },
1286
- "appCategoryId": {
1287
- "type": "string",
1288
- "format": "uuid",
1289
- "description": "Filter by app category ID"
1290
- },
1291
- "appIds": {
1292
- "description": "Filter by app IDs",
1293
- "type": "array",
1294
- "items": {
1295
- "type": "string",
1296
- "format": "uuid"
1297
- }
1298
- },
1299
- "accountId": {
1300
- "type": "string",
1301
- "format": "uuid",
1302
- "description": "Filter by account ID"
1303
- },
1304
- "hourlyRate": {
1305
- "type": "number",
1306
- "description": "Hourly rate for cost calculation"
1307
- },
1308
- "comparisonStartDate": {
1309
- "type": "string",
1310
- "format": "date",
1311
- "description": "Start date for comparison period"
1312
- },
1313
- "comparisonEndDate": {
1314
- "type": "string",
1315
- "format": "date",
1316
- "description": "End date for comparison period"
1317
- },
1318
- "first": {
1319
- "type": "number",
1320
- "minimum": 1,
1321
- "maximum": 100,
1322
- "description": "Number of items to return"
1323
- },
1324
- "after": {
1325
- "type": "number",
1326
- "description": "Cursor for pagination"
1327
- },
1328
- "sortField": {
1329
- "type": "string",
1330
- "enum": [
1331
- "appName",
1332
- "appCreatedDate",
1333
- "appCategoryName",
1334
- "uniqueUsers",
1335
- "uniqueUsersDeviation",
1336
- "duration",
1337
- "durationDeviation",
1338
- "interactions",
1339
- "interactionsDeviation",
1340
- "cost",
1341
- "costDeviation"
1342
- ],
1343
- "description": "Field to sort by"
1344
- },
1345
- "sortDirection": {
1346
- "type": "string",
1347
- "enum": [
1348
- "ASC",
1349
- "DESC"
1350
- ],
1351
- "description": "Sort direction"
1352
- },
1353
- "metricType": {
1354
- "type": "string",
1355
- "enum": [
1356
- "uniqueUsers",
1357
- "duration",
1358
- "interactions",
1359
- "cost"
1360
- ],
1361
- "description": "Type of metric to retrieve"
1362
- }
1363
- },
1364
- "required": [
1365
- "query",
1366
- "averagingPeriod",
1367
- "averagingType",
1368
- "startDate",
1369
- "metricType"
1370
- ]
1371
- },
1372
- "AppCategoryDto": {
1373
- "type": "object",
1374
- "properties": {
1375
- "id": {
1376
- "type": "string",
1377
- "format": "uuid",
1378
- "description": "App category ID"
1379
- },
1380
- "name": {
1381
- "type": "string",
1382
- "description": "App category name"
1383
- },
1384
- "displayName": {
1385
- "type": "string",
1386
- "description": "App category display name"
1387
- },
1388
- "color": {
1389
- "type": "string",
1390
- "description": "App category color"
1391
- },
1392
- "createdAt": {
1393
- "type": "string",
1394
- "format": "date-time",
1395
- "description": "Creation timestamp"
1396
- },
1397
- "updatedAt": {
1398
- "type": "string",
1399
- "format": "date-time",
1400
- "description": "Last update timestamp"
1401
- },
1402
- "deletedAt": {
1403
- "type": "string",
1404
- "format": "date-time",
1405
- "nullable": true,
1406
- "description": "Deletion timestamp"
1407
- }
1408
- },
1409
- "required": [
1410
- "id",
1411
- "name",
1412
- "displayName",
1413
- "color",
1414
- "createdAt",
1415
- "updatedAt"
1416
- ]
1417
- },
1418
- "AppDto": {
1419
- "type": "object",
1420
- "properties": {
1421
- "id": {
1422
- "type": "string",
1423
- "format": "uuid",
1424
- "description": "App ID"
1425
- },
1426
- "appCategoryId": {
1427
- "type": "string",
1428
- "description": "App name"
1429
- },
1430
- "displayColor": {
1431
- "type": "string",
1432
- "description": "App display color"
1433
- },
1434
- "logoUrl": {
1435
- "type": "string",
1436
- "description": "App logo URL"
1437
- },
1438
- "logoBackgroundColor": {
1439
- "type": "string",
1440
- "description": "App logo background color"
1441
- },
1442
- "status": {
1443
- "type": "string",
1444
- "enum": [
1445
- "ACTIVE",
1446
- "PENDING",
1447
- "INACTIVE"
1448
- ],
1449
- "description": "App status"
1450
- },
1451
- "appCategory": {
1452
- "description": "App category information",
1453
- "allOf": [
1454
- {
1455
- "$ref": "#/components/schemas/AppCategoryDto"
1456
- }
1457
- ]
1458
- },
1459
- "createdAt": {
1460
- "type": "string",
1461
- "format": "date-time",
1462
- "description": "Creation timestamp"
1463
- },
1464
- "updatedAt": {
1465
- "type": "string",
1466
- "format": "date-time",
1467
- "description": "Last update timestamp"
1468
- },
1469
- "deletedAt": {
1470
- "type": "string",
1471
- "format": "date-time",
1472
- "nullable": true,
1473
- "description": "Deletion timestamp"
1474
- }
1475
- },
1476
- "required": [
1477
- "id",
1478
- "appCategoryId",
1479
- "displayColor",
1480
- "logoUrl",
1481
- "logoBackgroundColor",
1482
- "status",
1483
- "appCategory",
1484
- "createdAt",
1485
- "updatedAt"
1486
- ]
1487
- },
1488
- "MetricWithDeviationDto": {
1489
- "type": "object",
1490
- "properties": {
1491
- "value": {
1492
- "type": "number",
1493
- "description": "Metric value"
1494
- },
1495
- "comparisonValue": {
1496
- "type": "number",
1497
- "description": "Comparison value from previous period"
1498
- },
1499
- "deviation": {
1500
- "type": "number",
1501
- "description": "Deviation from comparison value"
1502
- }
1503
- },
1504
- "required": [
1505
- "value"
1506
- ]
1507
- },
1508
- "AppUsageMetricsDto": {
1509
- "type": "object",
1510
- "properties": {
1511
- "app": {
1512
- "description": "App information",
1513
- "allOf": [
1514
- {
1515
- "$ref": "#/components/schemas/AppDto"
1516
- }
1517
- ]
1518
- },
1519
- "uniqueUsers": {
1520
- "description": "Unique users metric",
1521
- "allOf": [
1522
- {
1523
- "$ref": "#/components/schemas/MetricWithDeviationDto"
1524
- }
1525
- ]
1526
- },
1527
- "duration": {
1528
- "description": "Duration metric (in seconds)",
1529
- "allOf": [
1530
- {
1531
- "$ref": "#/components/schemas/MetricWithDeviationDto"
1532
- }
1533
- ]
1534
- },
1535
- "interactions": {
1536
- "description": "Interactions metric",
1537
- "allOf": [
1538
- {
1539
- "$ref": "#/components/schemas/MetricWithDeviationDto"
1540
- }
1541
- ]
1542
- },
1543
- "cost": {
1544
- "description": "Cost metric (in cents)",
1545
- "allOf": [
1546
- {
1547
- "$ref": "#/components/schemas/MetricWithDeviationDto"
1548
- }
1549
- ]
1550
- }
1551
- },
1552
- "required": [
1553
- "app",
1554
- "uniqueUsers",
1555
- "duration",
1556
- "interactions"
1557
- ]
1558
- },
1559
- "AppUsageMetricsListResponseDto": {
1560
- "type": "object",
1561
- "properties": {
1562
- "data": {
1563
- "description": "Array of app usage metrics",
1564
- "type": "array",
1565
- "items": {
1566
- "$ref": "#/components/schemas/AppUsageMetricsDto"
1567
- }
1568
- },
1569
- "averagingType": {
1570
- "type": "string",
1571
- "enum": [
1572
- "total",
1573
- "perUser"
1574
- ],
1575
- "description": "Averaging type used for the metrics"
1576
- },
1577
- "limit": {
1578
- "type": "number",
1579
- "description": "Number of items returned"
1580
- },
1581
- "has_more": {
1582
- "type": "boolean",
1583
- "description": "Whether there are more items available"
1584
- },
1585
- "total_count": {
1586
- "type": "number",
1587
- "description": "Total count of items"
1588
- }
1589
- },
1590
- "required": [
1591
- "data",
1592
- "averagingType",
1593
- "limit",
1594
- "has_more",
1595
- "total_count"
1596
- ]
1597
- },
1598
- "AppUsageMetricsHighlightsDataDto": {
1599
- "type": "object",
1600
- "properties": {
1601
- "topApp": {
1602
- "nullable": true,
1603
- "description": "Top app by metric value",
1604
- "allOf": [
1605
- {
1606
- "$ref": "#/components/schemas/AppUsageMetricsDto"
1607
- }
1608
- ]
1609
- },
1610
- "biggestIncrease": {
1611
- "nullable": true,
1612
- "description": "App with biggest increase",
1613
- "allOf": [
1614
- {
1615
- "$ref": "#/components/schemas/AppUsageMetricsDto"
1616
- }
1617
- ]
1618
- },
1619
- "biggestDecrease": {
1620
- "nullable": true,
1621
- "description": "App with biggest decrease",
1622
- "allOf": [
1623
- {
1624
- "$ref": "#/components/schemas/AppUsageMetricsDto"
1625
- }
1626
- ]
1627
- }
1628
- }
1629
- },
1630
- "AppUsageMetricsHighlightsResponseDto": {
1631
- "type": "object",
1632
- "properties": {
1633
- "averagingType": {
1634
- "type": "string",
1635
- "enum": [
1636
- "total",
1637
- "perUser"
1638
- ],
1639
- "description": "Averaging type used for the metrics"
1640
- },
1641
- "metricType": {
1642
- "type": "string",
1643
- "enum": [
1644
- "uniqueUsers",
1645
- "duration",
1646
- "interactions",
1647
- "cost"
1648
- ],
1649
- "description": "Type of metric used for highlights"
1650
- },
1651
- "data": {
1652
- "description": "Highlights data",
1653
- "allOf": [
1654
- {
1655
- "$ref": "#/components/schemas/AppUsageMetricsHighlightsDataDto"
1656
- }
1657
- ]
1658
- }
1659
- },
1660
- "required": [
1661
- "averagingType",
1662
- "metricType",
1663
- "data"
1664
- ]
1665
- },
1666
- "CatalogApplicationDto": {
1667
- "type": "object",
1668
- "properties": {}
1669
- }
1670
- }
1671
- }
1672
- }