Skip to content
Authrim

Get authentication statistics

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

Returns authentication and token audit counts for a required time period, optionally filtered by client ID. 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 ”

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.

client_id
string

Optional client ID filter.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Authentication and token audit statistics for the requested period.

Media type application/json
object
total_attempts
integer
successful
integer
failed
integer
success_rate
number
mfa_used
integer
by_grant_type
object
key
additional properties
object
successful
integer
failed
integer
key
additional properties
period
object
from
string format: date-time
to
string format: date-time
key
additional properties
key
additional properties
Example 
{
  "total_attempts": 1280,
  "successful": 1236,
  "failed": 44,
  "success_rate": 96.56,
  "mfa_used": 312,
  "by_grant_type": {
    "authorization_code": {
      "successful": 900,
      "failed": 20
    },
    "client_credentials": {
      "successful": 336,
      "failed": 24
    }
  },
  "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
}