Get user usage rankings

Returns users ranked by spend, tokens and request volume, with trend percentages versus the previous comparable period. Only requests that resolved to a user are counted.

GET /api/logs/rankings/users

Error

A valid request URL is required to generate request examples

200

{
  "rankings": [
    {
      "user_id": "<string>",
      "total_requests": 123,
      "total_tokens": 123,
      "total_cost": 123,
      "trend": {
        "has_previous_period": true,
        "requests_trend": 123,
        "tokens_trend": 123,
        "cost_trend": 123
      }
    }
  ]
}

This endpoint is available in Bifrost Enterprise only.

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

providers · string

Comma-separated list of providers to filter by

models · string

Comma-separated list of models to filter by

aliases · string

Comma-separated list of model aliases to filter by

status · string

Comma-separated list of statuses to filter by

objects · string

Comma-separated list of object types to filter by

selected_key_ids · string

Comma-separated list of selected key IDs to filter by

virtual_key_ids · string

Comma-separated list of virtual key IDs to filter by

routing_rule_ids · string

Comma-separated list of routing rule IDs to filter by

team_ids · string

Comma-separated list of team IDs to filter by

customer_ids · string

Comma-separated list of customer IDs to filter by

user_ids · string

Comma-separated list of user IDs to filter by

business_unit_ids · string

Comma-separated list of business unit IDs to filter by

project_ids · string

Comma-separated list of project IDs to filter by

start_time · string<date-time>

Start time filter (RFC3339 format)

end_time · string<date-time>

End time filter (RFC3339 format)

period · string

Relative time period filter

limit · integer · default: 100

Maximum number of ranked rows to return. Defaults to 100. Ignored when all=true.

Required range: x >= 1

all · boolean · default: false

When true, returns every ranked entity with no row cap. Intended for exports (CSV / PDF), which must not be truncated.

Response

200

application/json

User rankings retrieved successfully

rankings · object[]

Show child attributes