Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

CompoundAggregation

List Compound Aggregations

Changed on Oct 16, 2026

Retrieve a list of all Compound Aggregations.

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

get/organizations/{orgId}/compoundaggregations

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/compoundaggregations/get.ts
A function with typed inputs. Its response is checked against the schema.

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 Compound Aggregations to retrieve per page.

nextTokenstring

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

productIdstring[]

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

idsstring[]

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

codesstring[]

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

Response

Returns the list of Compound Aggregations