Get Revenue Metric By Product

get

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

Get revenue metric by product

Query Params

teamId

string

required

Unique identifier of the team (organization). Format: Revenium hashid (URL-safe encoded string).

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.

Allowed:

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:

products

array of strings

Optional list of product identifiers to include. Omit to include all products.

products

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Response

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

application/json

*/*

200Returns product revenue metrics for the requested range.

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

409Conflict

422Unprocessable Entity