Query the usage data (sparse)

1min

POST
https://app.amberflo.io/usage/sparse
This API is a generic statistical query tool which can allow you to fetch the usage or usage-rate (scale of usage) over time.
Differently from the usage endpoint, this one does not fill the gaps in the time series when no usage happened.
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.MeterAggregation.out
metadata
usage.MeterAggregationMetadata.out
clientMeters
usage.MeterAggregation.MeterAggregationGroup.out[]
﻿
﻿

Updated 07 Nov 2024

Did this page help you?

Query the usage data for all meters (sparse)

Query the usage data (sparse)