Get Provider Coverage Ratio

get

https://api.revenium.ai/profitstream/v2/api/billing/coverage

Returns aggregate coverage ratio (metered cost divided by billed cost; above 1 when Revenium metered more than the provider billed) and per-provider breakdown. For a custom period, startDate may be at most 366 days before endDate; a wider range is rejected with 400.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

period

string

enum

required

Time period for analytics

Allowed:

startDate

string

Filter start date/time in ISO 8601 format.

endDate

string

Filter end date/time in ISO 8601 format.

provider

string

enum

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

usageType

string

enum

Filter by usage type. Omit to include all types.

Allowed:

apiKey

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.

minCost

number

≥ 0

Filter by a starting cost (inclusive).

maxCost

number

≥ 0

Filter by an ending cost (inclusive).

teamId

string

required

ID of the team that owns this data.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/hal+json

*/*

200Coverage ratio retrieved successfully

400Invalid request parameters, including a custom startDate more than 366 days before endDate

401Unauthorized - authentication required

403Forbidden - insufficient permissions

404Not Found

409Conflict

422Unprocessable Content

429Too Many Requests

500Internal server error

504Gateway Timeout