A valid request URL is required to generate request examples{
"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
}
}
]
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}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.
A valid request URL is required to generate request examples{
"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
}
}
]
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "anthropic",
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
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
Comma-separated list of providers to filter by
Comma-separated list of models to filter by
Comma-separated list of model aliases to filter by
Comma-separated list of statuses to filter by
Comma-separated list of object types to filter by
Comma-separated list of selected key IDs to filter by
Comma-separated list of virtual key IDs to filter by
Comma-separated list of routing rule IDs to filter by
Comma-separated list of team IDs to filter by
Comma-separated list of customer IDs to filter by
Comma-separated list of user IDs to filter by
Comma-separated list of business unit IDs to filter by
Comma-separated list of project IDs to filter by
Start time filter (RFC3339 format)
End time filter (RFC3339 format)
Relative time period filter
Maximum number of ranked rows to return. Defaults to 100. Ignored when
all=true.
x >= 1When true, returns every ranked entity with no row cap. Intended for exports (CSV / PDF), which must not be truncated.
Response
User rankings retrieved successfully
Show child attributes
Show child attributes
Was this page helpful?