Skip to content
Authrim

List Usage Summary.

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

List Usage Summary in the Logging - Policies area. Use this operation to retrieve usage summary data without mutating tenant state.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Logging usage summary.

Media type application/json
object
data
required
object
window_start_at
integer format: int64
window_end_at
Any of:
integer format: int64
tenant_key
Any of:
string
tenant_id
Any of:
string
delivery
Array<object>
object
tenant_key
string
log_type
string
plane
string
lane
string
status
string
batch_count
integer format: int64
record_count
integer format: int64
byte_count
integer format: int64
attempt_count_sum
integer format: int64
catalog
Array<object>
object
tenant_key
string
log_type
string
plane
string
object_kind
string
status
string
object_count
integer format: int64
record_count
integer format: int64
byte_count
integer format: int64
dlq
Array<object>
object
tenant_key
string
lane
string
status
string
payload_type
string
item_count
integer format: int64
attempt_count_sum
integer format: int64
sensitive_detail
Array<object>
object
tenant_id
string
object_class
string
chunk_index_count
integer format: int64
byte_count
integer format: int64
last_created_at
integer format: int64
Example 
{
  "data": {
    "window_start_at": 1770000000000,
    "window_end_at": 1770003600000,
    "tenant_key": "tenant_123",
    "tenant_id": "tenant_123",
    "delivery": [
      {
        "tenant_key": "tenant_123",
        "log_type": "audit",
        "plane": "control",
        "lane": "default",
        "status": "delivered",
        "batch_count": 4,
        "record_count": 250,
        "byte_count": 8192,
        "attempt_count_sum": 4
      }
    ],
    "catalog": [],
    "dlq": [],
    "sensitive_detail": []
  }
}

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