Skip to content
Authrim

List logging usage aggregates

GET
/api/admin/logging-policies/usage-aggregates
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/logging-policies/usage-aggregates?window_kind=minute' \
  --header 'Authorization: Bearer <token>'

List usage aggregate rows by tenant, metric, window kind, and window bounds.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tenant_id
string

Tenant id filter. Platform admins can supply another tenant; tenant-scoped admins are constrained to their current tenant.

filter[tenant_id]
string

Alternative tenant id filter syntax.

tenant_key
string

Tenant key filter.

metric_name
string

Usage metric name filter.

window_kind
string
Allowed values: minute hour day month

Usage window kind.

since
integer format: int64

Lower window_start_at bound as epoch milliseconds.

until
integer format: int64

Upper window_start_at bound as epoch milliseconds.

limit
integer format: int64
>= 1 <= 500

Maximum number of items to return.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Logging usage aggregate list.

Media type application/json
object
items
required
Array<object>
object
id
string
tenant_id
Any of:
string
tenant_key
Any of:
string
log_type
string
plane
string
lane
string
metric_name
string
window_kind
string
Allowed values: hour day month
window_start_at
integer format: int64
window_end_at
integer format: int64
value
integer format: int64
source_table
string
metadata_json
Any of:
string
refreshed_at
integer format: int64
created_at
integer format: int64
updated_at
integer format: int64
Example 
{
  "items": [
    {
      "id": "lua_123",
      "tenant_id": "tenant_123",
      "tenant_key": "tenant_123",
      "log_type": "audit",
      "plane": "control",
      "lane": "default",
      "metric_name": "byte_count",
      "window_kind": "hour",
      "window_start_at": 1770000000000,
      "window_end_at": 1770003600000,
      "value": 8192,
      "source_table": "logging_delivery_event_aggregates",
      "metadata_json": "{}",
      "refreshed_at": 1770000100000,
      "created_at": 1770000000000,
      "updated_at": 1770000100000
    }
  ]
}

default

Section titled “default ”

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"
}