Ctrlk
Page cover
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Usage

Get Usage Stats

get

Get daily usage statistics for the API key's organization.

Returns paginated daily usage statistics with optional filtering by date range, model, provider, and source. Each record represents aggregated usage for a specific user/model/provider/source combination on a given date.

Query parameters
start_datestring · date-timeOptional

Start date for filtering (ISO format)

end_datestring · date-timeOptional

End date for filtering (ISO format)

modelstringOptional

Filter by specific model

model_providerstringOptional

Filter by model provider

sourcestringOptional

Filter by source (api or app)

limitinteger · min: 1 · max: 1000Optional

Number of records to return

Default: 100
offsetintegerOptional

Number of records to skip

Default: 0
Responses
200

Successful Response

application/json

API response model for daily usage statistics.

idstring · uuidRequired
user_idstring · uuidRequired
org_idstring · uuidRequired
emailstringRequired
modelstringRequired
sourcestringRequired
input_tokensintegerRequired
output_tokensintegerRequired
total_tokensintegerRequired
total_requestsintegerRequired
datestring · date-timeRequired
created_atstring · date-timeRequired
get/api/v1/usage/stats
GET /api/v1/usage/stats HTTP/1.1
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "org_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "model": "text",
    "source": "text",
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1,
    "total_requests": 1,
    "date": "2026-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z"
  }
]

Get Usage Summary

get

Get aggregated usage summary statistics for the API key's organization.

Returns high-level metrics including total tokens, requests, unique users, models, providers, and breakdown by API vs app usage.

Query parameters
start_datestring · date-timeOptional

Start date for summary (ISO format)

end_datestring · date-timeOptional

End date for summary (ISO format)

Responses
200

Successful Response

application/json

API response model for aggregated usage summary.

total_input_tokensintegerRequired
total_output_tokensintegerRequired
total_tokensintegerRequired
total_requestsintegerRequired
unique_usersintegerRequired
unique_modelsintegerRequired
unique_providersintegerRequired
api_usageintegerRequired
app_usageintegerRequired
date_range_daysintegerRequired
get/api/v1/usage/summary
GET /api/v1/usage/summary HTTP/1.1
Accept: */*

{
  "total_input_tokens": 1,
  "total_output_tokens": 1,
  "total_tokens": 1,
  "total_requests": 1,
  "unique_users": 1,
  "unique_models": 1,
  "unique_providers": 1,
  "api_usage": 1,
  "app_usage": 1,
  "date_range_days": 1
}
PreviousChat Completion
NextModels

Last updated