Query the usage data

1min

POST
https://app.amberflo.io/usage
This API is a generic statistical query tool which can allow you to fetch the usage or usage-rate (scale of usage) over time.
In order to facilitate using the response for plotting charts, this endpoint will fill the gaps in the time series when no usage happened.
If this is not needed, consider using the sparse usage endpoint.
Authentication
X-API-KEY
apiKey
Body Parameters
body
usage.MeterAggregationMetadata.in
meterApiName
string
*
aggregation
usage.AggregationType.in
timeRange
common.TimeRange.in
*
filter
map<string, string[]>
groupBy
string[]
take
usage.MeterAggregationMetadata.Take.in
timeGroupingInterval
com.amberflo.service.common.aggregation.AggregationInterval.in
valuesTimeGroupingInterval
com.amberflo.service.common.aggregation.AggregationInterval.in
rescaleFunction
com.amberflo.service.common.aggregation.RescaleFunction.in
Responses
200
Successful request
usage.DetailedMeterAggregation.out
metadata
usage.MeterAggregationMetadata.out
secondsSinceEpochIntervals
integer[]
clientMeters
usage.DetailedMeterAggregation.DetailedMeterAggregationGroup.out[]
﻿
﻿

Updated 07 Nov 2024

Did this page help you?

Query the usage data for all meters

Query the usage data in batch