Skip to content
Authrim

Get access trace statistics.

GET
/api/admin/access-trace/stats
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/access-trace/stats?period=1h' \
  --header 'Authorization: Bearer <token>'

Returns access trace totals, allow rate, top denied permissions, top denied subjects, and resolution-method distribution for a selected 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 ”

Query Parameters

Section titled “Query Parameters ”
period
string
default: 24h
Allowed values: 1h 6h 24h 7d 30d

Aggregation period.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Access trace statistics response.

Media type application/json
object
period
required
string
total
required
integer
allowed
required
integer
denied
required
integer
allow_rate
required
integer
<= 100
top_denied_permissions
required
Array<object>
object
permission
required
string
count
required
integer
key
additional properties
top_denied_subjects
required
Array<object>
object
subject_id
required
string
count
required
integer
key
additional properties
resolution_distribution
required
Array<object>
object
resolved_via
required
string
count
required
integer
key
additional properties
key
additional properties
Example generated
{
  "period": "example",
  "total": 1,
  "allowed": 1,
  "denied": 1,
  "allow_rate": 1,
  "top_denied_permissions": [
    {
      "permission": "example",
      "count": 1
    }
  ],
  "top_denied_subjects": [
    {
      "subject_id": "example",
      "count": 1
    }
  ],
  "resolution_distribution": [
    {
      "resolved_via": "example",
      "count": 1
    }
  ]
}

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
}