Create Meter
Intent
Creates a meter from the values supplied in the request.
When to call it
Call this when your application has collected the required values and is ready to create a meter.
Access boundary
Authorize the request with a token that carries meters:write.
Successful result
A successful request returns 201. The response schema below defines the body your integration receives.
Authorizations
Body
Name assigned to the meter. Will be shown on customer's invoices and usage.
3Filter: Filter to apply on events that'll be used to calculate the meter.
Aggregation: Aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Unit: Unit of the meter.
scalar, token, custom Custom Label: Label for the custom unit, e.g. 'request'. Required when unit is 'custom'.
Custom Multiplier: Multiplier to convert from the base unit to display scale, e.g. 1000 to display per 1000 units. Defaults to 1 when not provided.
x > 0Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Response
Response: Meter created.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
Name assigned to the meter. Will be shown on customer's invoices and usage.
Unit: Unit of the meter.
scalar, token, custom Filter: Filter to apply on events that'll be used to calculate the meter.
Aggregation: Aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
Unique identifier for the organization owning the meter.
Custom Label: Label for the custom unit.
Custom Multiplier: Multiplier to convert from base unit to display scale.
Indicates whether the meter is archived and the time it was archived.