Skip to content
Authrim

Get client statistics

GET
/api/admin/stats/clients/{id}
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/stats/clients/example?from=2026-04-15T12%3A00%3A00Z&to=2026-04-15T12%3A00%3A00Z' \
  --header 'Authorization: Bearer <token>'

Returns token, authentication, and usage statistics for a specific client in the requested period. Retained whole-row archives are included in supported log queries. A bounded query that cannot read its required rows returns log_query_incomplete instead of partial statistics or an empty success.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
from
required
string format: date-time

Inclusive start of the statistics period.

to
required
string format: date-time

Inclusive end of the statistics period.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Per-client authentication, token, and usage statistics.

Media type application/json
object
client_id
string
client_name
string | null
tokens
object
active_access_tokens
integer
active_refresh_tokens
integer
issued_today
integer
revoked_today
integer
key
additional properties
auth
object
total_attempts
integer
successful
integer
failed
integer
success_rate
number
key
additional properties
usage
object
api_calls_today
integer
api_calls_this_month
integer
unique_users
integer
last_activity
string | null format: date-time
key
additional properties
period
object
from
string format: date-time
to
string format: date-time
key
additional properties
key
additional properties
Example 
{
  "client_id": "client_123",
  "client_name": "Admin Console",
  "tokens": {
    "active_access_tokens": 18,
    "active_refresh_tokens": 18,
    "issued_today": 240,
    "revoked_today": 3
  },
  "auth": {
    "total_attempts": 260,
    "successful": 252,
    "failed": 8,
    "success_rate": 96.92
  },
  "usage": {
    "api_calls_today": 860,
    "api_calls_this_month": 24000,
    "unique_users": 85,
    "last_activity": "2026-06-01T23:58:00.000Z"
  },
  "period": {
    "from": "2026-06-01T00:00:00.000Z",
    "to": "2026-06-02T00:00:00.000Z"
  }
}

Headers

Section titled “Headers ”
X-Authrim-Log-Consistency
string
Allowed values: snapshot eventual local_hot_only

Snapshot for the remote scheduled view; eventual when Pipeline visibility can lag ingestion; local_hot_only for local scheduled staging without a remote Catalog.

X-Authrim-Log-Pending-Deliveries
integer

Tenant deliveries not yet confirmed visible. Omitted for self-service subjects. Zero does not guarantee immediate Pipeline visibility.

X-Authrim-Log-Complete
boolean

True only for a complete bounded snapshot query. Pipeline responses remain false; incomplete reads return 503.

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

The retained log query is incomplete. No partial entries or statistics are returned as a successful result. Narrow the period or retry.

Media type application/json
object
error
required
string
Allowed value: log_query_incomplete
error_description
required
string
complete
required
boolean
key
additional properties
Example 
{
  "error": "log_query_incomplete",
  "complete": false
}