Skip to main content
GET
cURL

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Query Parameters

days
integer
default:30

Window length in days (1–90).

Required range: 1 <= x <= 90
search
string | null

Keyword filter across endpoint, model, action code, key id, key name, and key prefix.

method
string | null

Filter by HTTP method.

api_key_id
string | null

Filter by public API key identifier (key_...).

status_class
string | null

Filter by HTTP status class: 2xx, 4xx, 5xx, or other.

client_type
string | null

Filter by client type: api, sdk, or cli.

from
string | null

Inclusive start date (YYYY-MM-DD).

to
string | null

Inclusive end date (YYYY-MM-DD).

page
integer
default:1

Page number for the request log.

Required range: x >= 1
page_size
integer
default:20

Rows per page.

Required range: 1 <= x <= 100

Response

Aggregated usage.

summary
UsageSummaryResponse · object
required
total
integer
required
page
integer
required
page_size
integer
required
window_days
integer | null
daily
UsageDailyBucketResponse · object[]
items
UsageItemResponse · object[]