Sign in
Aggregation

Update Aggregation

Update the Aggregation with the given UUID.

Note: If you have created Custom Fields for an Aggregation, when you use this endpoint to update the Aggregation use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

put/organizations/{orgId}/aggregations/{id}

Path parameters

orgIdstring required

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

idstring required

The UUID of the Aggregation to update.

Request body

versioninteger
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 required

Descriptive name for the Aggregation.

rounding'UP' | 'DOWN' | 'NEAREST' | 'NONE' required

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 required

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.

Note: If quantityPerUnit is set to a value other than one, rounding is typically set to "UP".

unitstring required

User defined label for units shown for Bill line items, indicating to your customers what they are being charged for.

codestring

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

accountingProductIdstring

Optional Product ID this Aggregation should be attributed to for accounting purposes

meterIdstring required

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.

targetFieldstring required

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' required

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.

segmentedFieldsstring[]

(Optional). Used when creating a segmented Aggregation, which segments the usage data collected by a single Meter. Works together with segments.

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

segmentsobject[]

(Optional). Used when creating a segmented Aggregation, which segments the usage data collected by a single Meter. Works together with segmentedFields.

Enter the values that are to be used as the segments, read from the fields in the meter pointed at by segmentedFields.

Note that you can use wildcards or defaults when setting up segment values. For more details on how to do this with an example, see Using Wildcards - API Calls in our main User Docs.

defaultValuenumber

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.

customSqlstring

NOTE: The customSql Aggregation type is currently only available in Beta release and on request. If you are interested in using this feature, please get in touch with m3ter Support or your m3ter contact.

Example request

{
  "code": "example_code"
}

Response

Return the updated Aggregation

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
meterIdstring

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.

targetFieldstring

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.

segmentedFieldsstring[]

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

defaultValuenumber

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.

customSqlstring
dtCreatedstring date-time

The DateTime when the aggregation was created (in ISO 8601 format).

dtLastModifiedstring date-time

The DateTime when the aggregation was last modified (in ISO 8601 format).

createdBystring

The id of the user who created this aggregation.

lastModifiedBystring

The id of the user who last modified this aggregation.

Changes

Changed in 5 of the 10 revisions of this API.757

  • 0f92c877619f11See the full diff
    • ●

      added the new CUSTOM_SQL enum value to the allOf[subschema #4]/aggregation response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new CUSTOM_SQL enum value to the request property allOf[subschema #4]/aggregation

      request-property-enum-value-added

  • 9f9e5f3dbde751See the full diff
    • ▲

      removed the enum value CUSTOM_SQL of the request property allOf[subschema #4]/aggregation

      request-property-enum-value-removed

    • ▲

      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

    • ○

      removed the CUSTOM_SQL enum value from the allOf[subschema #4]/aggregation response property for the response status 200

      response-property-enum-value-removed

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

  • 9beb1e1df3bd1See the full diff
    • ●

      the allOf[subschema #4]/customSql request property's maxLength was set to 2048

      request-property-max-length-set

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

  • 6c3e1a3cfb8f11See the full diff
    • ●

      added the new CUSTOM_SQL enum value to the allOf[subschema #4]/aggregation response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new CUSTOM_SQL enum value to the request property allOf[subschema #4]/aggregation

      request-property-enum-value-added

  • d064a12d0d93224See the full diff
    • ▲

      the allOf[AbstractAggregationRequest]/allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property type/format changed from / to object/

      request-property-type-changed

    • ●

      removed subschema #1 subschema #2 from the allOf[AbstractAggregationRequest]/allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property allOf list

      request-property-all-of-removed

    • ●

      removed subschema #1 subschema #2 from the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property allOf list

      request-property-all-of-removed

    • ○

      added the new optional request property allOf[AbstractAggregationRequest]/allOf[subschema #3]/accountingProductId

      new-optional-request-property

    • ○

      added the new optional request property allOf[subschema #4]/customSql

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #4]/customSql 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