Skip to main content
GET
/
api
/
v1
/
meters
/
{meter_id}
/
usage
Get Meter Usage
curl --request GET \
  --url https://api.example.com/api/v1/meters/{meter_id}/usage
{
  "meter_id": "...",
  "total_usage": 82450,
  "event_count": 12300,
  "unique_customers": 47,
  "period_start": "2025-01-01T00:00:00Z",
  "period_end": "2025-01-31T23:59:59Z",
  "grouped_data": [
    { "period": "2025-01-01", "usage": 2800, "event_count": 420 }
  ]
}
​
meter_id
string
required
UUID of the meter
​
customer_id
string
Filter to a specific customer
​
start_date
string
ISO 8601 start of the analysis window
​
end_date
string
ISO 8601 end of the analysis window
​
group_by
string
default:"day"
Grouping: hour, day, week, month
{
  "meter_id": "...",
  "total_usage": 82450,
  "event_count": 12300,
  "unique_customers": 47,
  "period_start": "2025-01-01T00:00:00Z",
  "period_end": "2025-01-31T23:59:59Z",
  "grouped_data": [
    { "period": "2025-01-01", "usage": 2800, "event_count": 420 }
  ]
}