v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
CompoundAggregation

List CompoundAggregations

Retrieve a list of all CompoundAggregations.

This endpoint retrieves a list of CompoundAggregations associated with a specific organization. CompoundAggregations enable you to define numerical measures based on simple Aggregations of usage data. It supports pagination, and includes various query parameters to filter the CompoundAggregations based on Product, CompoundAggregation IDs or short codes.

get/organizations/{orgId}/compoundaggregations

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of CompoundAggregations to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of CompoundAggregations in a paginated list.

productIdstring[]

An optional parameter to filter the CompoundAggregations based on specific Product unique identifiers (UUIDs).

idsstring[]

An optional parameter to retrieve specific CompoundAggregations based on their unique identifiers (UUIDs).

codesstring[]

An optional parameter to retrieve specific CompoundAggregations based on their short codes.

Response

Returns the list of CompoundAggregations

nextTokenstring