-
Notifications
You must be signed in to change notification settings - Fork 1
/
statistics.yaml
3603 lines (3569 loc) · 133 KB
/
statistics.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: 1.0.0
title: Statistics
# description: |-
# * View your Rocket.Chat workspace **statistics**.
# * Get the following workspace [engagement](https://docs.rocket.chat/use-rocket.chat/workspace-administration/engagement) details:
# * **Channels**
# * **Messages**
# * **Users**
# * View and manage channel **subscription** information.
servers:
- url: https://apiexplorer.support.rocket.chat
paths:
/api/v1/statistics.list:
get:
tags:
- Statistics
summary: Get Statistics List
description: |-
Get statistics about the Rocket.Chat workspace.
Permission required: `view-statistics`
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.51.0 | Added |
operationId: get-api-v1-statistics.list
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/query'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
statistics:
type: array
items:
type: object
properties:
_id:
type: string
wizard:
type: object
properties:
organizationType:
type: string
industry:
type: string
size:
type: string
country:
type: string
language:
type: string
serverType:
type: string
registerServer:
type: boolean
uniqueId:
type: string
installedAt:
type: string
version:
type: string
totalUsers:
type: integer
activeUsers:
type: integer
activeGuests:
type: integer
nonActiveUsers:
type: integer
appUsers:
type: integer
onlineUsers:
type: integer
awayUsers:
type: integer
busyUsers:
type: integer
totalConnectedUsers:
type: integer
offlineUsers:
type: integer
totalRooms:
type: integer
userLanguages:
type: object
properties:
none:
type: integer
totalChannels:
type: integer
totalPrivateGroups:
type: integer
totalDirect:
type: integer
totalLivechat:
type: integer
totalDiscussions:
type: integer
totalThreads:
type: integer
totalLivechatVisitors:
type: integer
totalLivechatAgents:
type: integer
voipEnabled:
type: boolean
omnichannelSources:
type: array
items:
type: object
BusinessHours:
type: object
properties:
total:
type: integer
strategy:
type: string
chatsOnHold:
type: integer
departments:
type: integer
emailInboxes:
type: integer
voipCalls:
type: integer
voipExtensions:
type: integer
voipErrorCalls:
type: integer
voipSuccessfulCalls:
type: integer
totalChannelMessages:
type: integer
voipOnHoldCalls:
type: integer
totalPrivateGroupMessages:
type: integer
totalDirectMessages:
type: integer
totalLivechatMessages:
type: integer
totalMessages:
type: integer
federatedServers:
type: integer
federatedUsers:
type: integer
os:
type: object
properties:
type:
type: string
platform:
type: string
arch:
type: string
release:
type: string
uptime:
type: number
loadavg:
type: array
items:
type: number
totalmem:
type: integer
freemem:
type: integer
cpus:
type: array
items:
type: object
properties:
model:
type: string
speed:
type: integer
times:
type: object
properties:
user:
type: integer
nice:
type: integer
sys:
type: integer
idle:
type: integer
irq:
type: integer
process:
type: object
properties:
nodeVersion:
type: string
pid:
type: integer
uptime:
type: number
deploy:
type: object
properties:
method:
type: string
platform:
type: string
readReceiptsEnabled:
type: boolean
readReceiptsDetailed:
type: boolean
enterpriseReady:
type: boolean
uploadsTotal:
type: integer
uploadsTotalSize:
type: integer
migration:
type: object
properties:
_id:
type: string
locked:
type: boolean
version:
type: integer
instanceCount:
type: integer
msEnabled:
type: boolean
oplogEnabled:
type: boolean
mongoVersion:
type: string
mongoStorageEngine:
type: string
apps:
type: object
properties:
engineVersion:
type: string
enabled:
type: boolean
totalInstalled:
type: boolean
totalActive:
type: boolean
totalFailed:
type: boolean
uniqueUsersOfYesterday:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueDevicesOfLastWeek:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueOSOfLastWeek:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueDevicesOfLastMonth:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueOSOfYesterday:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueOSOfLastMonth:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueDevicesOfYesterday:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueUsersOfLastWeek:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
uniqueUsersOfLastMonth:
type: object
properties:
year:
type: integer
month:
type: integer
day:
type: integer
data:
type: array
items:
type: object
services:
type: object
properties:
ldap:
type: object
properties:
users:
type: integer
enabled:
type: boolean
loginFallback:
type: boolean
encryption:
type: string
backgroundSync:
type: object
ee:
type: object
saml:
type: object
properties:
users:
type: integer
cas:
type: object
properties:
users:
type: integer
oauth:
type: object
properties:
apple:
type: object
properties:
enabled:
type: boolean
users:
type: integer
dolphin:
type: object
properties:
enabled:
type: boolean
users:
type: integer
drupal:
type: object
properties:
enabled:
type: boolean
users:
type: integer
facebook:
type: object
properties:
enabled:
type: boolean
users:
type: integer
github:
type: object
properties:
enabled:
type: boolean
users:
type: integer
githubEnterprise:
type: object
properties:
enabled:
type: boolean
users:
type: integer
gitlab:
type: object
properties:
enabled:
type: boolean
users:
type: integer
google:
type: object
properties:
enabled:
type: boolean
users:
type: integer
linkedin:
type: object
properties:
enabled:
type: boolean
users:
type: integer
meteor:
type: object
properties:
enabled:
type: boolean
users:
type: integer
nextcloud:
type: object
properties:
enabled:
type: boolean
users:
type: integer
tokenpass:
type: object
properties:
enabled:
type: boolean
users:
type: integer
twitter:
type: object
properties:
enabled:
type: boolean
users:
type: integer
wordpress:
type: object
properties:
enabled:
type: boolean
users:
type: integer
custom:
type: object
importer:
type: object
properties:
totalCSVImportedUsers:
type: integer
totalHipchatEnterpriseImportedUsers:
type: integer
totalSlackImportedUsers:
type: integer
totalSlackUsersImportedUsers:
type: integer
videoConf:
type: object
properties:
videoConference:
type: object
properties:
started:
type: integer
ended:
type: integer
direct:
type: object
properties:
calling:
type: integer
started:
type: integer
ended:
type: integer
livechat:
type: object
properties:
started:
type: integer
ended:
type: integer
settings:
type: object
dashboardCount:
type: integer
messageAuditApply:
type: integer
messageAuditLoad:
type: integer
settings:
type: object
integrations:
type: object
properties:
totalIntegrations:
type: integer
totalIncoming:
type: integer
totalIncomingActive:
type: integer
totalOutgoing:
type: integer
totalOutgoingActive:
type: integer
totalWithScriptEnabled:
type: integer
pushQueue:
type: integer
enterprise:
type: object
properties:
modules:
type: array
items:
type: object
tags:
type: array
items:
type: object
seatRequests:
type: integer
totalOTRRooms:
type: integer
totalOTR:
type: integer
totalBroadcastRooms:
type: integer
teams:
type: object
properties:
totalTeams:
type: integer
totalRoomsInsideTeams:
type: integer
totalDefaultRoomsInsideTeams:
type: integer
totalRoomsWithActiveLivestream:
type: integer
totalTriggeredEmails:
type: integer
totalRoomsWithStarred:
type: integer
totalRoomsWithPinned:
type: integer
totalUserTOTP:
type: integer
totalUserEmail2fa:
type: integer
totalPinned:
type: integer
totalStarred:
type: integer
totalLinkInvitation:
type: integer
totalLinkInvitationUses:
type: integer
totalEmailInvitation:
type: integer
totalE2ERooms:
type: integer
logoChange:
type: boolean
showHomeButton:
type: boolean
totalEncryptedMessages:
type: integer
totalManuallyAddedUsers:
type: integer
totalSubscriptionRoles:
type: integer
totalUserRoles:
type: integer
totalWebRTCCalls:
type: integer
matrixBridgeEnabled:
type: boolean
uncaughtExceptionsCount:
type: integer
homeTitleChanged:
type: boolean
homeBodyChanged:
type: boolean
customCSSChanged:
type: boolean
onLogoutCustomScriptChanged:
type: boolean
loggedOutCustomScriptChanged:
type: boolean
loggedInCustomScriptChanged:
type: boolean
createdAt:
type: string
_updatedAt:
type: string
count:
type: integer
offset:
type: integer
total:
type: integer
success:
type: boolean
examples:
Success Example:
value:
statistics:
- _id: v3D4mvobwfznKozH8
uniqueId: wD4EP3M7FeFzJZgk9
installedAt: '2018-02-18T19:40:45.369Z'
version: 0.61.0-develop
totalUsers: 88
activeUsers: 88
nonActiveUsers: 0
onlineUsers: 0
awayUsers: 1
offlineUsers: 87
totalRooms: 81
totalChannels: 41
totalPrivateGroups: 37
totalDirect: 3
totlalLivechat: 0
totalMessages: 2408
totalChannelMessages: 730
totalPrivateGroupMessages: 1869
totalDirectMessages: 25
totalLivechatMessages: 0
lastLogin: '2018-02-24T12:44:45.045Z'
lastMessageSentAt: '2018-02-23T18:14:03.490Z'
lastSeenSubscription: '2018-02-23T17:58:54.779Z'
instanceCount: 1
createdAt: '2018-02-24T15:13:00.312Z'
_updatedAt: '2018-02-24T15:13:00.312Z'
count: 1
offset: 0
total: 1
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
examples:
Permission Error:
value:
success: false
error: error-not-allowed
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/statistics:
get:
tags:
- Statistics
summary: Get Last Statistics
description: |-
Statistics about the Rocket.Chat workspace.
Permission required: `view-statistics`
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.51.0 | Added |
operationId: get-api-v1-statistics
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
- name: refresh
in: query
description: Refresh the statistics.
schema:
type: boolean
example: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
_id:
type: string
wizard:
type: object
properties:
organizationType:
type: string
industry:
type: string
size:
type: string
country:
type: string
language:
type: string
serverType:
type: string
registerServer:
type: boolean
uniqueId:
type: string
installedAt:
type: string
deploymentFingerprintHash:
type: string
deploymentFingerprintVerified:
type: boolean
version:
type: string
totalUsers:
type: integer
activeUsers:
type: integer
activeGuests:
type: integer
nonActiveUsers:
type: integer
appUsers:
type: integer
onlineUsers:
type: integer
awayUsers:
type: integer
busyUsers:
type: integer
totalConnectedUsers:
type: integer
offlineUsers:
type: integer
userLanguages:
type: object
properties:
none:
type: integer
totalRooms:
type: integer
totalChannels:
type: integer
totalPrivateGroups:
type: integer
totalDirect:
type: integer
totalLivechat:
type: integer
totalDiscussions:
type: integer
totalThreads:
type: integer
totalLivechatVisitors:
type: integer
totalLivechatAgents:
type: integer
totalLivechatManagers:
type: integer
livechatEnabled:
type: boolean
isDepartmentRemovalEnabled:
type: boolean
totalTriggers:
type: integer
archivedDepartments:
type: integer
departments:
type: integer
totalCustomFields:
type: integer
omnichannelSources:
type: array
items:
type: object
properties: {}
totalLivechatPublicCustomFields:
type: integer
livechatAutomaticForwardingUnansweredChats:
type: boolean
routingAlgorithm:
type: string
onHoldEnabled:
type: boolean
lastChattedAgentPreferred:
type: boolean
assignNewConversationsToContactManager:
type: boolean
visitorAbandonment:
type: string
voipEnabled:
type: boolean
emailInboxes:
type: integer
BusinessHours:
type: object
properties:
total:
type: integer
strategy:
type: string
voipCalls:
type: integer
voipExtensions:
type: integer
chatsOnHold:
type: integer
voipSuccessfulCalls:
type: integer
voipErrorCalls:
type: integer
voipOnHoldCalls:
type: integer
omnichannelContactsBySource:
type: object
properties:
contactsCount:
type: integer
conversationsCount:
type: integer
sources:
type: array
items:
type: object
properties: {}
uniqueContactsOfLastWeek:
type: object
properties:
contactsCount:
type: integer
conversationsCount:
type: integer
sources:
type: array
items:
type: object
properties: {}
uniqueContactsOfLastMonth:
type: object
properties:
contactsCount:
type: integer
conversationsCount:
type: integer
sources:
type: array
items:
type: object
properties: {}
uniqueContactsOfYesterday:
type: object
properties:
contactsCount:
type: integer
conversationsCount:
type: integer
sources:
type: array
items:
type: object
properties: {}
totalChannelMessages:
type: integer
totalPrivateGroupMessages:
type: integer
totalDiscussionsMessages:
type: integer
totalDirectMessages:
type: integer
totalLivechatMessages:
type: integer
totalMessages:
type: integer
lastLogin:
type: string
lastMessageSentAt:
type: string
federatedServers:
type: integer
federatedUsers:
type: integer
lastSeenSubscription:
type: string
os:
type: object
properties:
type:
type: string
platform:
type: string
arch:
type: string
release:
type: string
uptime:
type: number
loadavg:
type: array
items:
type: integer
totalmem:
type: integer
freemem:
type: integer
cpus:
type: array
items:
type: object
properties:
model:
type: string
speed:
type: integer
times:
type: object
properties:
user:
type: integer
nice:
type: integer
sys:
type: integer
idle:
type: integer
irq:
type: integer
process:
type: object
properties:
nodeVersion:
type: string
pid:
type: integer