M3m3ter-com
Aggregation

Create Aggregation

Changed on

Create a new Aggregation.

post/organizations/{orgId}/aggregations

Request

Path parameters

orgIdstring required

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

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed 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 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: You can use wildcards or defaults when setting up segment values. For more details on how to do this with examples, 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

Enter the SQL query expression to be used for a Custom SQL Aggregation. Custom SQL queries should be run against the Measurements table - for more details see Custom SQL Aggregations in your main User documentation.

NOTE: The customSql Aggregation type is currently available in Preview release. 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 created 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

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

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

The SQL query expression to be used for a Custom SQL Aggregation.

productIdstring
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

  • 85c514abc692Revision changes
    • breaking

      added subschema #1 subschema #2 to the ///////// request property allOf list

    • breaking

      added subschema #1 subschema #2 to the ///// request property allOf list

    • breaking

      the //////// request property type changed from no type to object

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the request property type changed from no type to object

    • breaking

      the //////// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

  • 0f92c877619fRevision changes
    • warning

      added the new CUSTOM_SQL enum value to the / response property for the response status

    • info

      added the new CUSTOM_SQL enum value to the request property /