Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When the data is sent out of Meter meter processor, also known as flush of the record, a record in json format will be sent for each meter associated with the Meter meter processor.

Irrespective of whether meter being updated or not during the last metering period, the meter is always flushed when it’s period ends. Meters meters are not flushed after the Active To has been passed for the meter type linked except Meters meters which has been updated during the current metering period.

Usage Audit audit are generated when the input data is outputted from Meter Processormeter processor.

The metered record can be viewed in JSON format in the Meter Inspector

...

Field

Purpose

id

The unique ID of meter.

userId

Unique ID of the user the meter belongs to, for example an email address, user name or MSISDN number.

meterTypeId

The unique ID of the meter type that the meter aggregate usage for.

meterTypeName

Name of the meter type this meter is created using.

timezone

The timezone that should be applied for reset time. Defined on the meter type of this meter.

meterKey

The meter key for the Meter meter processor aggregating the usage for the meter.

value

The current value of the meter, updated based on guiding rules and aggregation type defined on meter type.

unit

Unit which this meter is measuring. Defined on the meter type of this meter.

createdAt

UTC timestamp of when meter was created.

updatedAt

UTC timestamp of when meter was last updated.

periodStart

UTC timestamp from when the metering period has started. This is calculated based on when last period has ended.

periodEnd

UTC timestamp when the metering period has ended. This is calculated based on reset schedule.

groups

Granular breakdown of the aggregated values, grouped by the guiding rules defined in the Meter Configuration . Each group is represented by an array containing the parameters key, fields, and value.

carryFirst

First occurrence of one or many fields that should be carried over from usage record. Configured in other operations in Meter Configuration

carryLast

Last occurrence of one or many fields that should be carried over from usage record. Configured in other operations in Meter Configuration

deleteOnReset

If true, the meter will be deleted when ongoing metering period ends. Can be updated using update Meter API.

meterMetaData

Additional meta information related to usage ingestion example, datetime when the first and last record matched this meter.

...