Skip to content
Authrim

Get geographic authentication statistics

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

Returns country and region aggregations derived from audit-log geolocation details. 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.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Geographic authentication statistics grouped by country and region.

Media type application/json
object
by_country
Array<object>
object
country_code
string
country_name
string
total_requests
integer
successful
integer
failed
integer
unique_users
integer
last_activity
string | null format: date-time
key
additional properties
by_region
Array<object>
object
region
string
total_requests
integer
countries
integer
top_country
string | null
key
additional properties
top_countries
Array<object>
object
country_code
string
country_name
string
requests
integer
key
additional properties
period
object
from
string format: date-time
to
string format: date-time
key
additional properties
summary
object
total_countries
integer
total_requests
integer
unique_users
integer
key
additional properties
key
additional properties
Example 
{
  "by_country": [
    {
      "country_code": "JP",
      "country_name": "Japan",
      "total_requests": 800,
      "successful": 780,
      "failed": 20,
      "unique_users": 120,
      "last_activity": "2026-06-01T23:50:00.000Z"
    }
  ],
  "by_region": [
    {
      "region": "Asia Pacific",
      "total_requests": 800,
      "countries": 1,
      "top_country": "JP"
    }
  ],
  "top_countries": [
    {
      "country_code": "JP",
      "country_name": "Japan",
      "requests": 800
    }
  ],
  "period": {
    "from": "2026-06-01T00:00:00.000Z",
    "to": "2026-06-02T00:00:00.000Z"
  },
  "summary": {
    "total_countries": 1,
    "total_requests": 800,
    "unique_users": 120
  }
}

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
}