Skip to content
Authrim

Return tenant administration dashboard statistics.

GET
/api/admin/stats
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/stats \
  --header 'Authorization: Bearer <token>'

Return the Admin UI dashboard summary for users, clients, logins, PII health, and recent user registrations, logins, and client registrations in the current tenant. Active users are distinct users whose canonical account records a login in the preceding 30 days, while loginsToday is the number of distinct users whose latest recorded login is today. The response aggregates all active routed user shards assigned to the tenant.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin dashboard statistics response.

Media type application/json
object
stats
required
object
activeUsers
required
integer
totalUsers
required
integer
registeredClients
required
integer
newUsersToday
required
integer
loginsToday
required
integer
piiHealth
required
object
statusCounts
required
object
none
required
integer
pending
required
integer
active
required
integer
failed
required
integer
deleted
required
integer
key
additional properties
repairNeeded
required
integer
partialPIIUsers
required
integer
key
additional properties
key
additional properties
recentActivity
required
Array<object>
object
type
required
string
Allowed values: user_registration login client_registration
userId
required
string
email
required
string | null format: email
name
required
string | null
timestamp
required

Unix timestamp in milliseconds.

integer format: int64
key
additional properties
key
additional properties
Example 
{
  "stats": {
    "activeUsers": 18,
    "totalUsers": 42,
    "registeredClients": 7,
    "newUsersToday": 3,
    "loginsToday": 9,
    "piiHealth": {
      "statusCounts": {
        "none": 0,
        "pending": 0,
        "active": 42,
        "failed": 0,
        "deleted": 0
      },
      "repairNeeded": 0,
      "partialPIIUsers": 0
    }
  },
  "recentActivity": [
    {
      "type": "user_registration",
      "userId": "user_123",
      "email": "user@example.com",
      "name": "Example User",
      "timestamp": 1770000000000
    }
  ]
}