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.
Operational notes
Get a meter by ID.
Scopes: meters:read meters:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The meter ID.
Response
Successful Response
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
The name of the meter. Will be shown on customer's invoices and usage.
The unit of the meter.
scalar, token, custom The filter to apply on events that'll be used to calculate the meter.
The aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
The ID of the organization owning the meter.
The label for the custom unit.
The multiplier to convert from base unit to display scale.
Whether the meter is archived and the time it was archived.