Skip to main content
GET
/
v1
/
usage
cURL
curl \
  --request GET \
  --url "https://api.breeze.blue/v1/usage" \
  --header "xi-api-key: $BREEZE_API_KEY"
{
  "summary": {
    "request_count": 0,
    "total_text_characters": 0,
    "total_billable_units": 0,
    "total_cost": 0,
    "total_cost_millicredits": 0
  },
  "total": 123,
  "page": 123,
  "page_size": 123,
  "window_days": 123,
  "daily": [
    {
      "date": "<string>",
      "request_count": 123
    }
  ],
  "items": [
    {
      "id": "<string>",
      "endpoint": "<string>",
      "method": "<string>",
      "status": 123,
      "api_key_id": "<string>",
      "api_key_name": "<string>",
      "api_key_prefix": "<string>",
      "model": "<string>",
      "billable_units": 123,
      "cost": 123,
      "cost_millicredits": 123,
      "latency_ms": 123,
      "duration_ms": 123,
      "first_audio_chunk_ms": 123,
      "request_duration_ms": 123,
      "trace_id": "<string>",
      "request_id": "<string>",
      "text_characters": 123,
      "action_code": "<string>",
      "client_type": "<string>",
      "client_name": "<string>",
      "client_version": "<string>",
      "created_at": "<string>"
    }
  ]
}

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[]