Get
/api/v1/statistics
Statistics about the Rocket.Chat workspace.
Permission required: view-statistics
Changelog
| Version | Description |
|---|---|
| 0.51.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The token of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The user ID of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
refresh
boolean
Refresh the statistics.
ExampleTrue
Responses
200
OK
Success Example
{
"result": [
{
"_id": "jRca8kibJx8NkLJxt",
"createdAt": "2018-04-13T12:46:26.517Z",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"name": "EditedRealNameuser.test.1523623548558",
"username": "editedusernameuser.test.1523623548558",
"avatarETag": "6YbLtc4v9b4conXon"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
_id
string
wizard
object
organizationType
string
industry
string
size
string
country
string
language
string
serverType
string
registerServer
boolean
uniqueId
string
installedAt
string
deploymentFingerprintHash
string
deploymentFingerprintVerified
boolean
version
string
totalUsers
integer
activeUsers
integer
activeGuests
integer
nonActiveUsers
integer
appUsers
integer
onlineUsers
integer
awayUsers
integer
busyUsers
integer
totalConnectedUsers
integer
offlineUsers
integer
userLanguages
object
none
integer
totalRooms
integer
totalChannels
integer
totalPrivateGroups
integer
totalDirect
integer
totalLivechat
integer
totalDiscussions
integer
totalThreads
integer
totalLivechatVisitors
integer
totalLivechatAgents
integer
totalLivechatManagers
integer
livechatEnabled
boolean
isDepartmentRemovalEnabled
boolean
totalTriggers
integer
archivedDepartments
integer
departments
integer
totalCustomFields
integer
omnichannelSources
Array of object
object
totalLivechatPublicCustomFields
integer
livechatAutomaticForwardingUnansweredChats
boolean
routingAlgorithm
string
onHoldEnabled
boolean
lastChattedAgentPreferred
boolean
assignNewConversationsToContactManager
boolean
visitorAbandonment
string
voipEnabled
boolean
emailInboxes
integer
BusinessHours
object
total
integer
strategy
string
voipCalls
integer
voipExtensions
integer
chatsOnHold
integer
voipSuccessfulCalls
integer
voipErrorCalls
integer
voipOnHoldCalls
integer
omnichannelContactsBySource
object
contactsCount
integer
conversationsCount
integer
sources
Array of object
object
uniqueContactsOfLastWeek
object
contactsCount
integer
conversationsCount
integer
sources
Array of object
object
uniqueContactsOfLastMonth
object
contactsCount
integer
conversationsCount
integer
sources
Array of object
object
uniqueContactsOfYesterday
object
contactsCount
integer
conversationsCount
integer
sources
Array of object
object
totalChannelMessages
integer
totalPrivateGroupMessages
integer
totalDiscussionsMessages
integer
totalDirectMessages
integer
totalLivechatMessages
integer
totalMessages
integer
lastLogin
string
lastMessageSentAt
string
federatedServers
integer
federatedUsers
integer
lastSeenSubscription
string
os
object
type
string
platform
string
arch
string
release
string
uptime
number
loadavg
Array of integer
integer
totalmem
integer
freemem
integer
cpus
Array of object
object
model
string
speed
integer
times
object
user
integer
nice
integer
sys
integer
idle
integer
irq
integer
process
object
nodeVersion
string
pid
integer
uptime
number
deploy
object
method
string
platform
string
readReceiptsEnabled
boolean
readReceiptsDetailed
boolean
enterpriseReady
boolean
uploadsTotal
integer
migration
object
_id
string
_updatedAt
string
locked
boolean
version
integer
buildAt
string
lockedAt
string
uploadsTotalSize
integer
instanceCount
integer
msEnabled
boolean
oplogEnabled
boolean
mongoVersion
string
mongoStorageEngine
string
apps
object
engineVersion
string
totalInstalled
integer
totalActive
integer
totalFailed
integer
uniqueUsersOfYesterday
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueDevicesOfYesterday
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueUsersOfLastWeek
object
year
integer
month
integer
day
integer
data
Array of object
object
roles
Array of object
object
role
string
count
integer
sessions
integer
time
integer
count
integer
sessions
integer
time
integer
uniqueOSOfYesterday
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueDevicesOfLastMonth
object
year
integer
month
integer
day
integer
data
Array of object
object
count
integer
time
integer
type
string
name
string
version
string
uniqueOSOfLastWeek
object
year
integer
month
integer
day
integer
data
Array of object
object
count
integer
time
integer
name
string
version
string
uniqueDevicesOfLastWeek
object
year
integer
month
integer
day
integer
data
Array of object
object
count
integer
time
integer
type
string
name
string
version
string
uniqueUsersOfLastMonth
object
year
integer
month
integer
day
integer
data
Array of object
object
roles
Array of object
object
role
string
count
integer
sessions
integer
time
integer
count
integer
sessions
integer
time
integer
uniqueOSOfLastMonth
object
year
integer
month
integer
day
integer
data
Array of object
object
count
integer
time
integer
name
string
version
string
services
object
ldap
object
users
integer
enabled
boolean
loginFallback
boolean
encryption
string
mergeUsers
boolean
syncRoles
boolean
syncRolesAutoRemove
boolean
syncData
boolean
syncChannels
boolean
syncAvatar
boolean
groupFilter
boolean
backgroundSync
object
enabled
boolean
interval
string
newUsers
boolean
existingUsers
boolean
ee
object
syncActiveState
string
syncTeams
boolean
syncRoles
boolean
saml
object
enabled
boolean
users
integer
signatureValidationType
string
generateUsername
boolean
updateSubscriptionsOnLogin
boolean
syncRoles
boolean
userDataCustomFieldMap
boolean
cas
object
enabled
boolean
users
integer
allowUserCreation
boolean
alwaysSyncUserData
boolean
oauth
object
apple
object
enabled
boolean
users
integer
dolphin
object
enabled
boolean
users
integer
drupal
object
enabled
boolean
users
integer
facebook
object
enabled
boolean
users
integer
github
object
enabled
boolean
users
integer
githubEnterprise
object
enabled
boolean
users
integer
gitlab
object
enabled
boolean
users
integer
google
object
enabled
boolean
users
integer
linkedin
object
enabled
boolean
users
integer
meteor
object
enabled
boolean
users
integer
nextcloud
object
enabled
boolean
users
integer
tokenpass
object
enabled
boolean
users
integer
twitter
object
enabled
boolean
users
integer
wordpress
object
enabled
boolean
users
integer
custom
object
importer
object
totalCSVImportedUsers
integer
totalHipchatEnterpriseImportedUsers
integer
totalSlackImportedUsers
integer
totalSlackUsersImportedUsers
integer
videoConf
object
videoConference
object
started
integer
ended
integer
direct
object
calling
integer
started
integer
ended
integer
livechat
object
started
integer
ended
integer
settings
object
provider
string
dms
boolean
channels
boolean
groups
boolean
teams
boolean
dashboardCount
integer
messageAuditApply
integer
messageAuditLoad
integer
joinJitsiButton
integer
slashCommandsJitsi
integer
settings
object
accounts
object
account2fa
boolean
cannedResponses
object
cannedResponsesEnabled
boolean
e2ee
object
e2e
boolean
e2eDefaultDirectRoom
boolean
e2eDefaultPrivateRoom
boolean
email
object
smtp
object
smtpHost
string
smtpPort
string
fromEmail
string
fileUpload
object
fileUploadEnable
boolean
general
object
apps
object
nps
object
surveyEnabled
boolean
update
object
updateChecker
boolean
liveStreamAndBroadcasting
object
message
object
allowEditing
boolean
allowDeleting
boolean
allowUnrecognizedSlashCommand
boolean
allowBadWordsFilter
boolean
readReceiptEnabled
boolean
readReceiptStoreUsers
boolean
otr
object
otrEnable
boolean
push
object
pushEnable
boolean
search
object
defaultProvider
object
globalSearchEnabled
boolean
threads
object
threadsEnabled
boolean
webRTC
object
webRTCEnableChannel
boolean
webRTCEnablePrivate
boolean
webRTCEnableDirect
boolean
pushQueue
integer
totalOTRRooms
integer
totalOTR
integer
integrations
object
totalIntegrations
integer
totalIncoming
integer
totalIncomingActive
integer
totalOutgoing
integer
totalOutgoingActive
integer
totalWithScriptEnabled
integer
totalBroadcastRooms
integer
enterprise
object
modules
Array of string
string
tags
Array of string
string
seatRequests
integer
cannedResponses
integer
livechatTags
integer
slas
integer
omnichannelRoomsWithPriorities
integer
omnichannelRoomsWithSlas
integer
businessUnits
integer
livechatMonitors
integer
omnichannelPdfTranscriptSucceeded
integer
omnichannelPdfTranscriptRequested
integer
teams
object
totalTeams
integer
totalRoomsInsideTeams
integer
totalDefaultRoomsInsideTeams
integer
totalRoomsWithActiveLivestream
integer
totalTriggeredEmails
integer
totalRoomsWithStarred
integer
totalRoomsWithPinned
integer
totalUserTOTP
integer
totalUserEmail2fa
integer
totalPinned
integer
totalStarred
integer
totalLinkInvitation
integer
totalLinkInvitationUses
integer
totalEmailInvitation
integer
totalE2ERooms
integer
logoChange
boolean
showHomeButton
boolean
totalEncryptedMessages
integer
totalManuallyAddedUsers
integer
totalSubscriptionRoles
integer
totalUserRoles
integer
totalCustomRoles
integer
totalWebRTCCalls
integer
uncaughtExceptionsCount
integer
push
integer
pushSecured
boolean
homeTitleChanged
boolean
homeBodyChanged
boolean
customCSSChanged
boolean
onLogoutCustomScriptChanged
boolean
loggedOutCustomScriptChanged
boolean
loggedInCustomScriptChanged
boolean
dailyPeakConnections
integer
maxMonthlyPeakConnections
integer
matrixFederation
object
enabled
boolean
maximumSizeOfPublicRoomsUsers
integer
biggestRoom
string
smallestRoom
string
amountOfExternalUsers
integer
amountOfFederatedRooms
integer
externalConnectedServers
object
quantity
integer
servers
Array of object
object
webRTCEnabled
boolean
webRTCEnabledForOmnichannel
boolean
omnichannelWebRTCCalls
integer
createdAt
string
_updatedAt
string
statsToken
string
success
boolean
400
Bad Request
Permission Error
{
"success": false,
"error": "error-not-allowed"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string