Skip to main content
POST
Get meter usage analytics

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Analytics parameters

aggregation_type
enum<string>
required
Available options:
COUNT,
SUM,
AVG,
COUNT_UNIQUE,
LATEST,
SUM_WITH_MULTIPLIER,
MAX,
WEIGHTED_SUM
end_time
string<date-time>
required
Example:

"2024-02-01T00:00:00Z"

external_customer_id
string
required
Example:

"cust_123"

meter_ids
string[]
required
Minimum array length: 1
Example:
start_time
string<date-time>
required
Example:

"2024-01-01T00:00:00Z"

billing_anchor
string<date-time>
window_size
enum<string>
Available options:
MONTH,
MINUTE,
15MIN,
30MIN,
HOUR,
3HOUR,
6HOUR,
12HOUR,
DAY,
WEEK,
MONTH

Response

OK

items
object[]