admin

Get a two-dimension usage breakdown

Changed on

Pivots the filtered usage by a row and an optional column dimension. Keys rank by the metric; those past limit fold into a trailing "other" key. Period keys follow interval and are never folded. A request with several labels counts once per label.

get/admin/usage/breakdown

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/admin/usage/breakdown
  • Auth
    HTTP bearer

Query parameters

rowsstring required

Row dimension: model, provider, user_path, label, endpoint, auth_key, period

columnsstring

Column dimension (same values, different from rows); omit or none for one column

metricstring

Ranking metric for the top-N cut: cost, tokens, requests (default cost)

limitinteger

Keys kept per dimension before the rest fold into other (default 10, max 50)

user_path_depthinteger

Group user paths by their first N segments (0 keeps full paths, max 16)

daysinteger

Number of days (default 30)

start_datestring

Start date (YYYY-MM-DD)

end_datestring

End date (YYYY-MM-DD)

intervalstring

Period grouping: daily, weekly, monthly, yearly (default daily)

modelstring[]

Filter by exact model names; repeat or comma-separate for several

providerstring[]

Filter by provider names or types; repeat or comma-separate for several

labelstring[]

Filter by request labels (exact match); repeat for several

endpointstring[]

Filter by exact request endpoints, e.g. /v1/chat/completions,/v1/messages; repeat or comma-separate for several

operationstring

Filter by comma-separated operations, e.g. chat_completions,embeddings

session_idstring

Filter by exact detected session ID

auth_key_idstring[]

Filter by managed auth key IDs; repeat or comma-separate for several

user_pathstring[]

Filter by tracked user path subtrees; repeat for several

cache_modestring

Cache mode filter: uncached, cached, all (default uncached)

Response

OK

column_dimension'' | 'model' | 'provider' | 'user_path' | 'label' | 'endpoint' | 'auth_key' | 'period'
metric'cost' | 'tokens' | 'requests'
row_dimension'' | 'model' | 'provider' | 'user_path' | 'label' | 'endpoint' | 'auth_key' | 'period'

Changes