Sign in
CompoundAggregation

Retrieve CompoundAggregation

Retrieve a CompoundAggregation using the given UUID.

This endpoint returns a specific CompoundAggregation associated with an Organization. It provides detailed information about the CompoundAggregation.

get/organizations/{orgId}/compoundaggregations/{id}

Path parameters

orgIdstring required

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

idstring required

The unique identifier (UUID) of the CompoundAggregation to retrieve.

Response

Returns the CompoundAggregation

idstring required

The UUID of the entity.

versioninteger

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.
customFieldsobject

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 in the m3ter documentation for more information.

namestring

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.
quantityPerUnitnumber

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.

unitstring

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.

codestring

Code of the Aggregation. A unique short code to identify the Aggregation.

segmentsobject[]

(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.

accountingProductIdstring
calculationstring

This field is a string that represents the formula for the calculation. This formula determines how the CompoundAggregation is calculated from the underlying usage data.

productIdstring

This field represents the unique identifier (UUID) of the Product that is associated with the CompoundAggregation.

evaluateNullAggregationsboolean

This is a boolean True / False flag.

If set to TRUE, the calculation will be evaluated even if the referenced aggregation has no usage data.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the CompoundAggregation was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the CompoundAggregation was last modified.

createdBystring

The unique identifier (UUID) of the user who created this CompoundAggregation.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this CompoundAggregation.

Changes

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

  • 9f9e5f3dbde74See the full diff
    • ▲

      the response property allOf[AbstractAggregationResponse]/allOf[AbstractResponseWithCustomFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractAggregationResponse]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponseWithCustomFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

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

  • d064a12d0d931See the full diff
    • ○

      added the optional property allOf[AbstractAggregationResponse]/allOf[subschema #3]/accountingProductId to the response with the 200 status

      response-optional-property-added

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