Versions Compared

Key

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

...

Insert excerpt
License
License
nameLicensing Information The feature described in this documentation is optional and might not be part of the edition covered by your company's license.
nopaneltrue

Meters are the customer-specific buckets of usage for the different meter types. When a customer opts for a meter type, then the meter need needs to be created using these with the following parameters:

  • Meter Key (for the Meter processor where the usage data is guided)

  • Meter Type ID (for the meter type the usage should be aggregated for)

  • The User ID (for the customer)

Meters can be created, retrieved, updated, and deleted using the API, see API Reference.

Meter The meter inherits these the following properties defined on from the meter type used stated when creating a the meter -:

  • Active From from - Meter The meter is active from the date time defined on in the Active From from field on in the Meter Typemeter type. If Active To from is set to a time before the meter creation time then Meter is the meter will be activated as soon as it is created. The time is calculated based on the timezone defined on in the Meter Type when created by meter type when the meter type is created in the user interface.

  • Active To to - Meter The meter is active to the date time defined on in the Active To to field on the Meter Typemeter type. The time is calculated based on the timezone defined on in the Meter Type when created by meter type when the meter type is created in the user interface.

  • Unit - Unit defined on the Meter Type is a unit which is a unit for metered record valueThis is the unit in which the metered record value will be counted, such as minutes, days, or number of coffee cups for a coffee service.

  • Aggregation type - Meter follows The meter’s usage is aggregated according to the aggregation which is defined on in the Meter Typemeter type.

  • Reset schedule - Meter The meter follows the reset Reset schedule defined in the Meter Typemeter type. The period end of the Meter meter is calculated based on the reset Reset schedule. The timezone defined on Meter in meter type is considered when calculating period start and period end. See Meter Reset in Metered Output Record , see Flushing Metered Records.
    When Meter a meter is newly first created the , its period start is when meter is created. It is shown on set to the time of creation in the selected timezone. This is shown in the Period start field in the Meter Inspector in the selected timezone.

...

  • .

When updating a meter, you can update the parameter “deleteOnReset“. It has a default value of false, but can be set to true or false, default false. Once set either ‘true’ or ‘false’. If you set it to true, the meter is will be deleted when the current period ends after sending the metered record to downstream functionsystems.

Note!

Meter A meter can be created anytime dynamically at any time using the API after once the meter type and a stream with meter a Meter processor is have been created.