--- title: "List Aggregations" method: GET path: "/organizations/{orgId}/aggregations" tags: ["Aggregation"] --- # List Aggregations `GET /organizations/{orgId}/aggregations` Retrieve a list of Aggregations that can be filtered by Product, Aggregation ID, or Code. ## Path parameters - `orgId` string, required ## Query parameters - `pageSize` integer - `nextToken` string - `productId` string[] - `ids` string[] - `codes` string[] ## Response `200` Returns the list of Aggregations - PaginatedAggregationResponseData - `data` AggregationResponse[] - `id` string, required — The UUID of the entity. - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response. - `customFields` object — User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information. - `name` string — Descriptive name for the Aggregation. - `rounding` 'UP' | 'DOWN' | 'NEAREST' | 'NONE' — Specifies how you want to deal with non-integer, fractional number Aggregation values. **NOTES:** * "NEAREST" rounds to the nearest half: 5.1 is rounded to 5, and 3.5 is rounded to 4. * Also used in combination with `quantityPerUnit`. Rounds the number of units after `quantityPerUnit` is applied. If you set `quantityPerUnit` to a value other than one, you would typically set Rounding to **UP**. For example, suppose you charge by kilobytes per second (KiBy/s), set `quantityPerUnit` = 500, and set charge rate at $0.25 per unit used. If your customer used 48,900 KiBy/s in a billing period, the charge would be 48,900 / 500 = 97.8 rounded up to 98 * 0.25 = $2.45. - `quantityPerUnit` number — Defines how much of a quantity equates to 1 unit. Used when setting the price per unit for billing purposes - if charging for kilobytes per second (KiBy/s) at rate of $0.25 per 500 KiBy/s, then set quantityPerUnit to 500 and price Plan at $0.25 per unit. If `quantityPerUnit` is set to a value other than one, rounding is typically set to UP. - `unit` string — User defined or following the *Unified Code for Units of Measure* (UCUM). Used as the label for billing, indicating to your customers what they are being charged for. - `code` string — Code of the Aggregation. A unique short code to identify the Aggregation. - `segments` object[] — *(Optional)*. Used when creating a segmented Aggregation, which segments the usage data collected by a single Meter. Works together with `segmentedFields`. Contains the values that are to be used as the segments, read from the fields in the meter pointed at by `segmentedFields`. - `accountingProductId` string - `meterId` string — The UUID of the Meter used as the source of usage data for the Aggregation. Each Aggregation is a child of a Meter, so the Meter must be selected. - `targetField` string — `Code` of the target `dataField` or `derivedField` on the Meter used as the basis for the Aggregation. - `aggregation` 'SUM' | 'MIN' | 'MAX' | 'COUNT' | 'LATEST' | 'MEAN' | 'UNIQUE' | 'CUSTOM_SQL' — Specifies the computation method applied to usage data collected in `targetField`. Aggregation unit value depends on the **Category** configured for the selected targetField. * **SUM**. Adds the values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. * **MIN**. Uses the minimum value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. * **MAX**. Uses the maximum value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. * **COUNT**. Counts the number of values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. * **LATEST**. Uses the most recent value. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. Note: Based on the timestamp `ts` value of usage data measurement submissions. If using this method, please ensure *distinct* `ts` values are used for usage data measurement submissions. * **MEAN**. Uses the arithmetic mean of the values. Can be applied to a **Measure**, **Income**, or **Cost** `targetField`. * **UNIQUE**. Uses unique values and returns a count of the number of unique values. Can be applied to a **Metadata** `targetField`. - `segmentedFields` string[] — *(Optional)*. Used when creating a segmented Aggregation, which segments the usage data collected by a single Meter. Works together with `segments`. The `Codes` of the fields in the target Meter to use for segmentation purposes. String `dataFields` on the target Meter can be segmented. Any string `derivedFields` on the target Meter, such as one that concatenates two string `dataFields`, can also be segmented. - `defaultValue` number — Aggregation value used when no usage data is available to be aggregated. *(Optional)*. **Note:** Set to 0, if you expect to reference the Aggregation in a Compound Aggregation. This ensures that any null values are passed in correctly to the Compound Aggregation calculation with a value = 0. - `customSql` string - `dtCreated` string, date-time — The DateTime when the aggregation was created *(in ISO 8601 format)*. - `dtLastModified` string, date-time — The DateTime when the aggregation was last modified *(in ISO 8601 format)*. - `createdBy` string — The id of the user who created this aggregation. - `lastModifiedBy` string — The id of the user who last modified this aggregation. - `nextToken` string ## Other responses - `4XX` — Error message - `5XX` — Error message --- [API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)