Get User Counts
3/8/26About 1 min
Get User Counts
Get user statistics including total users, total checks, and failed checks. This endpoint requires administrator privileges.
Endpoint: GET /user/info/get_user_counts
Request Headers
| Parameter | Required | Description |
|---|---|---|
| Content-Type | Yes | Fixed value: application/json |
| Authorization | Yes | Bearer token, user authentication token |
Request Parameters
None
Response Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | int | Yes | HTTP status code |
| code | string | Yes | Query result code |
| result | string | Yes | Query result |
| data | dict | Yes | Query result data |
data Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| total_users | int | Yes | Total number of registered users (distinct count) |
| total_checks | int | Yes | Total number of check records |
| failed_checks | int | Yes | Total number of failed check records |
Success Response Example
{
"status": 200,
"code": "10000",
"result": "获取统计信息成功",
"data": {
"total_users": 150,
"total_checks": 320,
"failed_checks": 15
}
}Error Response Examples
Endpoint Not Open
{
"status": 403,
"code": "10002",
"result": "服务器未开放此接口",
"data": {}
}Token Expired or Invalid
{
"status": 401,
"code": "10001",
"result": "token 已过期或无效",
"data": {}
}Account Is Not Administrator
{
"status": 401,
"code": "10004",
"result": "该账号不是管理员账号",
"data": {}
}Failed to Get Statistics, Server Internal Error
{
"status": 500,
"code": "10003",
"result": "获取统计信息失败,服务器内部错误",
"data": {}
}Error Code Description
| Code | Description |
|---|---|
| 10000 | Statistics retrieved successfully |
| 10001 | Token expired or invalid |
| 10002 | Server has not opened this endpoint |
| 10003 | Failed to get statistics, server internal error |
| 10004 | Account is not an administrator account |
Permission Requirements
This endpoint requires the user to have one of the following roles:
管理员(Administrator)超级管理员(Super Administrator)组织管理员(Organization Administrator)
Tip
This endpoint requires the user to be logged in and have administrator privileges. A valid Authorization token must be carried in the request header.
← Back to API Documentation | ← Get User Check Information | ← Get User Information Modification Log