Query the usage data

1 min

POST

https://app.amberflo.io/usage

Queries aggregated usage data for a specific meter over a time period.

Request parameters:

meterApiName: Meter to query
startTimeInSeconds/endTimeInSeconds: Time range bounds
aggregation: Aggregation function (SUM, MAX, MIN, etc.)
groupBy: Optional dimension names for grouping results
timeGroupingInterval: Time bucketing (HOUR, DAY, MONTH)

The response includes aggregated values and automatically fills gaps in the time series with zero values, making it suitable for generating continuous charts and reports.

Query performance depends on time range size and grouping complexity. Use shorter time ranges or coarser intervals for better performance.

bodyobjectQuery parameters for retrieving aggregated meter usage data with filtering and grouping options

200Successful request

curl --request POST \
     --url https://app.amberflo.io/usage \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "meterApiName": "",
     "timeRange": {
     "startTimeInSeconds": 0
     },
     "take": {
     "limit": 0
     },
     "forecast": {
     "endTimeInSeconds": 0
     }
     }'