Skip to content

Get Platform Stats

GET
/api/superadmin/stats
curl --request GET \
--url https://example.com/api/superadmin/stats \
--header 'Authorization: Bearer <token>'

Platform-wide aggregate stats.

Successful Response

Media type application/json
PlatformStatsResponse
object
total_users
required
Total Users
integer
active_users
required
Active Users
integer
suspended_users
required
Suspended Users
integer
deactivated_users
required
Deactivated Users
integer
total_superadmins
required
Total Superadmins
integer
total_orgs
required
Total Orgs
integer
total_deals
required
Total Deals
integer
Example generated
{
"total_users": 1,
"active_users": 1,
"suspended_users": 1,
"deactivated_users": 1,
"total_superadmins": 1,
"total_orgs": 1,
"total_deals": 1
}