Read Meter
Intent
Reads the meter without changing it.
When to call it
Call this after your application has received or stored the identifier for the meter.
Access boundary
Authorize the request with a token that carries meters:read or meters:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the meter.
Response
Request completed successfully
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.