Sign in
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

Changes

Changed in 2 of the 10 revisions of this API.232

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b513See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      for the query request parameter productId, the type/format of property items/ was changed from object/ to string/

      request-parameter-property-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog