Query analytics data with sparse time series

1 min

POST

https://app.amberflo.io/bizlytics/query/sparse

Retrieves analytics data for meters and usage patterns without interpolating missing data points. This endpoint returns a sparse time series, meaning gaps in usage are not filled with zero values, providing an accurate view of when actual usage occurred.

Use this endpoint to:

Get precise usage patterns without artificial zero-filling
Analyze actual activity periods versus idle times
Reduce data volume for intermittent usage patterns
Generate more efficient reports for sporadic usage

The sparse format is particularly useful for meters with intermittent activity, as it only returns data points when usage actually occurred. Supports various aggregation types including SUM, AVG, MAX, MIN, and COUNT across configurable time intervals.

Important Note: Unlike the standard query endpoint, this does not interpolate missing time periods, resulting in smaller response sizes for sparse data.

bodyobject

200Successfully retrieved sparse analytics data without gap interpolation

400Invalid query parameters or unsupported aggregation type

401Authentication required or invalid API key

403Insufficient permissions to access analytics data

404Requested meter or analytics object not found

500Internal server error occurred while processing the query

curl --request POST \
     --url https://app.amberflo.io/bizlytics/query/sparse \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "objectType": "",
     "timeRange": {
     "startTimeInSeconds": 0
     },
     "forecast": {
     "endTimeInSeconds": 0
     }
     }'