Get revenue by organization

get

https://api.revenium.ai/profitstream/v2/api/sources/metrics/ai/revenue-metric-by-organization

Returns the revenue billed to each customer organization over the whole window, with no time buckets, taken from billed line items. Amounts are summed as billed, with no currency conversion. group chooses TOTAL (the sum of line-item charges, the default) or the MEAN, MEDIAN, MAXIMUM or MINIMUM single charge. Pass organizations to return only the listed organizations; omit it to list every organization with usage in the window.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

required

ID of the team that owns this data.

period

string

enum

Predefined time window to aggregate results (e.g., TWELVE_MONTHS). Ignored if both startDate and endDate are provided. Defaults to TWELVE_MONTHS when no custom date range is specified.

startDate

string

Start of a custom date range in ISO 8601 format (e.g., 2025-09-01T00:00:00Z). Must be provided together with endDate. When both are provided, the period parameter is ignored and this custom range is used instead.

endDate

string

End of a custom date range in ISO 8601 format (e.g., 2025-09-30T23:59:59Z). Must be provided together with startDate. When both are provided, the period parameter is ignored and this custom range is used instead.

group

string

enum

Aggregation group for the metric.

Allowed:

organizations

array of strings

Optional list of organization identifiers to include. Omit to include all organizations with usage in the window.

organizations

products

array of strings

deprecated

Deprecated: use organizations. Takes organization identifiers and is ignored when organizations has at least one non-blank value; an empty or all-blank organizations value falls back to products.

products

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

*/*

200Returns organization revenue metrics for the requested range.

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

409Conflict

422Unprocessable Content

429Too Many Requests

504Gateway Timeout