Skip to main content
GET
/
organizations
/
{orgId}
/
aggregations
List Aggregations
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/aggregations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "name": "<string>",
      "rounding": "UP",
      "quantityPerUnit": 123,
      "unit": "<string>",
      "code": "<string>",
      "segments": [
        {}
      ],
      "accountingProductId": "<string>",
      "meterId": "<string>",
      "targetField": "<string>",
      "aggregation": "SUM",
      "segmentedFields": [
        "<string>"
      ],
      "defaultValue": 123,
      "customSql": "<string>",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
pageSize
integer<int32>

Number of Aggregations to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

nextToken for multi-page retrievals.

​
productId
string[]

The UUIDs of the Products to retrieve Aggregations for.

​
ids
string[]

List of Aggregation IDs to retrieve.

​
codes
string[]

List of Aggregation codes to retrieve. These are unique short codes to identify each Aggregation.

Response

Returns the list of Aggregations

​
data
object[]
​
nextToken
string