Skip to main content
GET
Retrieve usage data

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"sub_ig1f5x45789r3ax7dlfff4q4"

Query Parameters

resolution
enum<string>
default:auto

The resolution of the consumption. 'auto' will choose a good resolution based on the start and end date.

Available options:
auto,
15min,
hour,
day,
week,
month
Example:

"auto"

start
string

The start date of the interval (inclusive). Defaults depend on the meter type.
Smart meters: yesterday start of day (00:00:00) in the customers's timezone. Analog meters: subscription start date or 12 months ago, whichever is later.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-03-30"

end
string

The end date of the interval (exclusive). Defaults depend on the meter type. Smart meters: today start of day (00:00:00) in the customers's timezone. Analog meters: latest available reading date.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-03-31"

Response

Retrieve the subscription usage

object
enum<string>
required
Available options:
usage
meter_type
enum<string>
required

The meter type. Smart meters record consumption data in 15min intervals, analog meter readings only get reported periodically by the metering operator or the customer.

Available options:
analog,
smart
Example:

"smart"

resolution
enum<string>
required

The resolution of the consumption. An optimal resolution will be chosen based on the start and end date if no resolution is provided in the query params.

Available options:
15min,
hour,
day,
week,
month
Example:

"15min"

data
object[]
required

The consumption of the meter

Example: