API Reference
Log In
API Reference

List Model Efficiency Metrics

Retrieves AI model efficiency and cost metrics for the authenticated user's organization.

Returns paginated model-level metrics

includePopulationAggregates: when true, the envelope adds mostEfficientModel,
the model with the lowest positive cost per 1M tokens among every model the filters
match (the set page.totalElements counts), not only this page. Attribution buckets
such as __organization_discount__ are never chosen. Omitted when false (default).

sort: totalCost (default, descending), provider, model, usageType,
percentage, requestCount, totalTokens, uncachedInputTokens,
cachedInputTokens, cacheWriteTokens, outputTokens, imageCount, costPer1M,
avgTokensPerRequest, creditsApplied. These are the aggregate names, not the
response field names, and an unknown key fails the request with 400.

All costs are in USD. Token counts include all token types (input, output, cache).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

ID of the team that owns this data.

string
enum
required

Time period for analytics

Allowed:
string

Filter start date/time in ISO 8601 format.

string

Filter end date/time in ISO 8601 format.

string
enum

Filter results by AI provider. Omit to include all providers.

string
enum

Filter by usage type. Omit to include all types.

Allowed:
string

Narrow results to a single API key id within the caller's organization, matched exactly. Honoured by /billing/chart, /billing/models, /billing/api-keys and /billing/users; other billing endpoints ignore it. On those four, rows and totals cover only charges stored under that id, so a value that matches no stored charge returns a zero total, never the organization total.

number
≥ 0

Filter by a starting cost (inclusive).

number
≥ 0

Filter by an ending cost (inclusive).

string

Search query to filter models by name

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 20

The size of the page to be returned

sort
array of strings
Defaults to totalCost,DESC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
boolean
Defaults to false

When true, the envelope also carries mostEfficientModel computed over every model the filters match, not only this page. Costs extra full-population queries, so send it only when those fields are read.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*