Get statistics about the Rocket.Chat workspace.
Permission required: view-statistics
Changelog
| Version | Description |
|---|---|
| 8.7.0 | Added the fips field to statistics records. |
| 0.51.0 | Added |
The token of the authenticated user.
The user ID of the authenticated user.
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.
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.
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.
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.
OK
{
"statistics": [
{
"_id": "6a708537c8fc3c65b1808baf",
"wizard": {
"organizationType": "",
"industry": "",
"size": "",
"country": "",
"language": "",
"serverType": "",
"registerServer": false
},
"uniqueId": "2d3ad4fb-d515-4f09-8f02-0f186c8cc929",
"installedAt": "2026-08-03T12:10:10.817Z",
"deploymentFingerprintHash": "",
"deploymentFingerprintVerified": true,
"version": "8.7.0-rc.3",
"tag": null,
"branch": null,
"totalUsers": 0,
"activeUsers": 0,
"activeGuests": 0,
"nonActiveUsers": 0,
"appUsers": 0,
"onlineUsers": 0,
"awayUsers": 0,
"busyUsers": 0,
"totalConnectedUsers": 0,
"offlineUsers": 0,
"userLanguages": {
"none": 0
},
"totalRooms": 0,
"totalChannels": 0,
"totalPrivateGroups": 0,
"totalDirect": 0,
"totalLivechat": 0,
"totalDiscussions": 0,
"totalThreads": 0,
"totalLivechatVisitors": 0,
"totalLivechatAgents": 0,
"totalLivechatManagers": 0,
"livechatEnabled": true,
"isDepartmentRemovalEnabled": false,
"omnichannelSources": [],
"totalLivechatRoomsWithDepartment": 0,
"departments": 0,
"totalTriggers": 0,
"archivedDepartments": 0,
"totalCustomFields": 0,
"totalLivechatPublicCustomFields": 0,
"livechatAutomaticForwardingUnansweredChats": true,
"routingAlgorithm": "Auto_Selection",
"onHoldEnabled": null,
"lastChattedAgentPreferred": null,
"assignNewConversationsToContactManager": null,
"visitorAbandonment": null,
"emailInboxes": 0,
"BusinessHours": {
"total": 0,
"strategy": ""
},
"chatsOnHold": 0,
"uniqueContactsOfLastMonth": {
"contactsCount": 0,
"conversationsCount": 0,
"sources": []
},
"omnichannelContactsBySource": {
"contactsCount": 0,
"conversationsCount": 0,
"sources": []
},
"totalChannelMessages": 0,
"uniqueContactsOfYesterday": {
"contactsCount": 0,
"conversationsCount": 0,
"sources": []
},
"uniqueContactsOfLastWeek": {
"contactsCount": 0,
"conversationsCount": 0,
"sources": []
},
"totalPrivateGroupMessages": 0,
"totalDiscussionsMessages": 0,
"totalDirectMessages": 0,
"totalLivechatMessages": 0,
"totalMessages": 0,
"lastLogin": "",
"lastMessageSentAt": null,
"lastSeenSubscription": "",
"os": {
"type": "Linux",
"platform": "linux",
"arch": "x64",
"release": "6.17.0-1017-aws",
"uptime": 2119.94,
"loadavg": [
6.92,
5.81,
3.52
],
"totalmem": "8220839936",
"freemem": "3768729600",
"cpus": [
{
"model": "AMD EPYC 7571",
"speed": 0,
"times": {
"user": 404110,
"nice": 0,
"sys": 206780,
"idle": 1425940,
"irq": 0
}
},
{
"model": "AMD EPYC 7571",
"speed": 0,
"times": {
"user": 416850,
"nice": 0,
"sys": 203030,
"idle": 1418740,
"irq": 0
}
}
]
},
"process": {
"nodeVersion": "v22.22.3",
"pid": 1,
"uptime": 74.175831587
},
"deploy": {
"method": "docker",
"platform": "helm-chart"
},
"fips": true,
"readReceiptsEnabled": false,
"readReceiptsDetailed": false,
"enterpriseReady": true,
"fileStoreType": "GridFS",
"uploadsTotal": 0,
"uploadsTotalSize": 0,
"migration": {
"_id": "control",
"_updatedAt": "2026-08-03T12:10:13.492Z",
"locked": false,
"version": 335
},
"instanceCount": 0,
"msEnabled": true,
"oplogEnabled": false,
"mongoVersion": "8.0.0",
"mongoStorageEngine": "unknown",
"apps": {
"engineVersion": "1.65.1-rc.0",
"totalInstalled": 0,
"totalActive": 0,
"totalFailed": 0,
"totalPrivateApps": 0,
"totalPrivateAppsEnabled": 0
},
"uniqueUsersOfYesterday": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueDevicesOfYesterday": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueUsersOfLastMonth": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueUsersOfLastWeek": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueOSOfYesterday": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueDevicesOfLastMonth": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueOSOfLastMonth": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueDevicesOfLastWeek": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"uniqueOSOfLastWeek": {
"year": 2026,
"month": 8,
"day": 2,
"data": []
},
"services": {
"ldap": {
"users": 0,
"enabled": false,
"loginFallback": false,
"encryption": "plain",
"mergeUsers": false,
"syncRoles": null,
"syncRolesAutoRemove": null,
"syncData": null,
"syncChannels": null,
"syncAvatar": true,
"groupFilter": false,
"backgroundSync": {
"enabled": null,
"interval": null,
"newUsers": null,
"existingUsers": null
},
"ee": {
"syncActiveState": null,
"syncTeams": null,
"syncRoles": null
}
},
"saml": {
"enabled": null,
"users": 0,
"signatureValidationType": null,
"generateUsername": null,
"updateSubscriptionsOnLogin": null,
"syncRoles": null,
"userDataCustomFieldMap": false
},
"cas": {
"enabled": false,
"users": 0,
"allowUserCreation": true,
"alwaysSyncUserData": true
},
"oauth": {
"apple": {
"enabled": false,
"users": 0
},
"dolphin": {
"enabled": false,
"users": 0
},
"drupal": {
"enabled": false,
"users": 0
},
"facebook": {
"enabled": false,
"users": 0
},
"github": {
"enabled": false,
"users": 0
},
"githubEnterprise": {
"enabled": false,
"users": 0
},
"gitlab": {
"enabled": false,
"users": 0
},
"google": {
"enabled": false,
"users": 0
},
"linkedin": {
"enabled": false,
"users": 0
},
"meteor": {
"enabled": false,
"users": 0
},
"nextcloud": {
"enabled": false,
"users": 0
},
"twitter": {
"enabled": false,
"users": 0
},
"wordpress": {
"enabled": false,
"users": 0
},
"custom": {}
}
},
"importer": {
"totalCSVImportedUsers": 0,
"totalHipchatEnterpriseImportedUsers": 0,
"totalSlackImportedUsers": 0,
"totalSlackUsersImportedUsers": 0
},
"videoConf": {
"videoConference": {
"started": 0,
"ended": 0
},
"direct": {
"calling": 0,
"started": 0,
"ended": 0
},
"livechat": {
"started": 0,
"ended": 0
},
"settings": {
"provider": "",
"dms": null,
"channels": null,
"groups": null,
"teams": null
}
},
"contactVerification": {
"totalContacts": 0,
"totalUnknownContacts": 0,
"totalMergedContacts": null,
"totalConflicts": 0,
"totalResolvedConflicts": null,
"totalBlockedContacts": 0,
"totalPartiallyBlockedContacts": 0,
"totalFullyBlockedContacts": 0,
"totalVerifiedContacts": 0,
"avgChannelsPerContact": 0,
"totalContactsWithoutChannels": 0,
"totalImportedContacts": null,
"totalUpsellViews": null,
"totalUpsellClicks": null
},
"dashboardCount": 0,
"messageAuditApply": 0,
"messageAuditLoad": 0,
"joinJitsiButton": 0,
"slashCommandsJitsi": 0,
"settings": {
"accounts": {
"account2fa": true
},
"cannedResponses": {
"cannedResponsesEnabled": true
},
"e2ee": {
"e2e": false,
"e2eDefaultDirectRoom": false,
"e2eDefaultPrivateRoom": false
},
"email": {
"smtp": {
"smtpHost": "",
"smtpPort": "",
"fromEmail": ""
}
},
"fileUpload": {
"fileUploadEnable": true
},
"general": {
"apps": {
"frameworkDevMode": null,
"frameworkEnable": null
},
"nps": {
"surveyEnabled": true
},
"update": {
"updateChecker": true
}
},
"liveStreamAndBroadcasting": {
"liveStream": null,
"broadcasting": null
},
"message": {
"allowEditing": true,
"allowDeleting": true,
"allowUnrecognizedSlashCommand": false,
"allowBadWordsFilter": false,
"readReceiptEnabled": false,
"readReceiptStoreUsers": false
},
"push": {
"pushEnable": true
},
"search": {
"defaultProvider": {
"globalSearchEnabled": null
}
},
"threads": {
"threadsEnabled": true
},
"webRTC": {
"webRTCEnableChannel": null,
"webRTCEnablePrivate": null,
"webRTCEnableDirect": null
}
},
"totalBroadcastRooms": 0,
"totalTriggeredEmails": 0,
"pushQueue": 0,
"integrations": {
"totalIntegrations": 0,
"totalIncoming": 0,
"totalIncomingActive": 0,
"totalOutgoing": 0,
"totalOutgoingActive": 0,
"totalWithScriptEnabled": 0
},
"enterprise": {
"modules": [
"auditing",
"canned-responses",
"ldap-enterprise",
"livechat-enterprise",
"voip-enterprise",
"omnichannel-mobile-enterprise",
"engagement-dashboard",
"push-privacy",
"scalability",
"teams-mention",
"saml-enterprise",
"oauth-enterprise",
"device-management",
"federation",
"videoconference-enterprise",
"message-read-receipt",
"outlook-calendar",
"hide-watermark",
"custom-roles",
"accessibility-certification",
"fips"
],
"tags": [
"Commercial"
],
"seatRequests": 0,
"livechatTags": 0,
"cannedResponses": 0,
"slas": 0,
"omnichannelRoomsWithPriorities": 0,
"omnichannelRoomsWithSlas": 0,
"businessUnits": 0,
"omnichannelPdfTranscriptSucceeded": 0,
"livechatMonitors": 0
},
"teams": {
"totalTeams": 0,
"totalRoomsInsideTeams": 0,
"totalDefaultRoomsInsideTeams": 0
},
"totalRoomsWithStarred": 0,
"totalRoomsWithPinned": 0,
"totalUserTOTP": 0,
"totalUserEmail2fa": 0,
"totalPinned": 0,
"totalStarred": 0,
"totalLinkInvitation": 0,
"totalLinkInvitationUses": 0,
"totalEmailInvitation": 0,
"totalE2ERooms": 0,
"logoChange": false,
"showHomeButton": true,
"totalEncryptedMessages": 0,
"totalManuallyAddedUsers": 0,
"totalSubscriptionRoles": 3,
"totalUserRoles": 11,
"totalCustomRoles": 0,
"totalWebRTCCalls": null,
"uncaughtExceptionsCount": 0,
"push": 3,
"pushSecured": false,
"homeTitleChanged": false,
"homeBodyChanged": false,
"customCSSChanged": false,
"onLogoutCustomScriptChanged": false,
"loggedOutCustomScriptChanged": false,
"loggedInCustomScriptChanged": false,
"dailyPeakConnections": 0,
"maxMonthlyPeakConnections": 0,
"matrixFederation": {
"enabled": false,
"maximumSizeOfPublicRoomsUsers": false,
"biggestRoom": null,
"smallestRoom": null,
"amountOfExternalUsers": 0,
"amountOfFederatedRooms": 0,
"externalConnectedServers": {
"quantity": 0,
"servers": []
}
},
"allowUnsafeQueryAndFieldsApiParamsEnabled": false,
"createdAt": "2026-08-03T12:10:31.265Z",
"_updatedAt": "2026-08-03T12:10:31.426Z",
"statsToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2VJZCI6IiIsInVuaXF1ZUlkIjoiMmQzYWQ0ZmItZDUxNS00ZjA5LThmMDItMGYxODZjOGNjOTI5IiwicmVjb3JkSWQiOiI2YTcwODUzN2M4ZmMzYzY1YjE4MDhiYWYiLCJ0aW1lc3RhbXAiOiIyMDI2LTA4LTAzVDEyOjEwOjMxLjQwNzk5NzEyOFoiLCJpbmZvIjp7InRvdGFsVXNlcnMiOjAsImFjdGl2ZVVzZXJzIjowLCJ0b3RhbENvbm5lY3RlZFVzZXJzIjowLCJvbW5pQ2hhbm5lbENvbnZlcnNhdGlvbnMiOjAsInRvdGFsUm9vbXMiOjAsInRvdGFsTWVzc2FnZXMiOjAsInVwbG9hZHNUb3RhbFNpemUiOjAsIm1pY3Jvc2VydmljZUVuYWJsZWQiOnRydWUsImZpbGVTdG9yZVR5cGUiOiJHcmlkRlMifX0.JnBb7z--brY2k00kIkC_Rp502P8wdKVcC2kAxEKK0OBFJlAgLM4ezZ5m_xG2w1wX3wCTNKnrjO3D5Mi-bzYNmNNBcJQbujP2uUGWMnr42UUAbyPY9VWKCf4L3H9cgzB9WjJX94KiVlwLjnbqle9TE0wAubP-NR1lzZn06GrnD9bAFSdz2E5lI4s6qozfUW5z8ZmSgXs5MBSbhBQczUbmQkQoj2XjKs5Mkqow0qLeBsCrc0F2m_92YeO1S6StRGvLIVyce-qvm0DLT8hXhpoJyRRgLz_3JyOzOE6hfxcgWI43YUZ4o4n7QruSYDhSFnAjuAlZjHasBCKPfs9ht9vRtQ"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}Bad Request
{
"success": false,
"error": "error-not-allowed"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}