Get
/api/v1/statistics.list
Get 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
Example50
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
sort
List of fields to order by, and in which direction. JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}. Refer to the official documentation to learn more.
fields
This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }. Refer to the official documentation to learn more.
query
This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }. Refer to the official documentation to learn more.
Responses
200
OK
Success Example
{
"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
}object
statistics
Array of object
object
_id
string
wizard
object
organizationType
string
industry
string
size
string
country
string
language
string
serverType
string
registerServer
boolean
uniqueId
string
installedAt
string
version
string
totalUsers
integer
activeUsers
integer
activeGuests
integer
nonActiveUsers
integer
appUsers
integer
onlineUsers
integer
awayUsers
integer
busyUsers
integer
totalConnectedUsers
integer
offlineUsers
integer
totalRooms
integer
userLanguages
object
none
integer
totalChannels
integer
totalPrivateGroups
integer
totalDirect
integer
totalLivechat
integer
totalDiscussions
integer
totalThreads
integer
totalLivechatVisitors
integer
totalLivechatAgents
integer
voipEnabled
boolean
omnichannelSources
Array of object
object
BusinessHours
object
total
integer
strategy
string
chatsOnHold
integer
departments
integer
emailInboxes
integer
voipCalls
integer
voipExtensions
integer
voipErrorCalls
integer
voipSuccessfulCalls
integer
totalChannelMessages
integer
voipOnHoldCalls
integer
totalPrivateGroupMessages
integer
totalDirectMessages
integer
totalLivechatMessages
integer
totalMessages
integer
federatedServers
integer
federatedUsers
integer
os
object
type
string
platform
string
arch
string
release
string
uptime
number
loadavg
Array of number
number
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
uploadsTotalSize
integer
migration
object
_id
string
locked
boolean
version
integer
instanceCount
integer
msEnabled
boolean
oplogEnabled
boolean
mongoVersion
string
mongoStorageEngine
string
apps
object
engineVersion
string
enabled
boolean
totalInstalled
boolean
totalActive
boolean
totalFailed
boolean
uniqueUsersOfYesterday
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueDevicesOfLastWeek
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueOSOfLastWeek
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
uniqueOSOfYesterday
object
year
integer
month
integer
day
integer
data
Array of object
object
uniqueOSOfLastMonth
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
uniqueUsersOfLastMonth
object
year
integer
month
integer
day
integer
data
Array of object
object
services
object
ldap
object
users
integer
enabled
boolean
loginFallback
boolean
encryption
string
backgroundSync
object
ee
object
saml
object
users
integer
cas
object
users
integer
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
dashboardCount
integer
messageAuditApply
integer
messageAuditLoad
integer
settings
object
integrations
object
totalIntegrations
integer
totalIncoming
integer
totalIncomingActive
integer
totalOutgoing
integer
totalOutgoingActive
integer
totalWithScriptEnabled
integer
pushQueue
integer
enterprise
object
modules
Array of object
object
tags
Array of object
object
seatRequests
integer
totalOTRRooms
integer
totalOTR
integer
totalBroadcastRooms
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
totalWebRTCCalls
integer
matrixBridgeEnabled
boolean
uncaughtExceptionsCount
integer
homeTitleChanged
boolean
homeBodyChanged
boolean
customCSSChanged
boolean
onLogoutCustomScriptChanged
boolean
loggedOutCustomScriptChanged
boolean
loggedInCustomScriptChanged
boolean
createdAt
string
_updatedAt
string
count
integer
offset
integer
total
integer
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