Get monthly aggregated usages for rule enabled to consumer tenants.
GET {{baseUrl}}/aggregatedMonthlyProviderUsage?month=<string>&year=<string>&consumer=<string>&application=<string>&KPIName=<string>&page=0&size=20
Operator registers a KPI with UTS. Operator send the resource usage data of consumer to UTS. KPI contains the aggregation and unit conversion details which should be applied on received usages.
Aggregation is executed and calculated values are shown in response. This API endpoint can be used by provider tenant to see the aggregated usage calculated for month on prorate basis for various consumers.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
month | string | (Required) month for which usage requested | |
year | string | (Required) year | |
consumer | string | consumer tenant id | |
application | string | (Required) application name registered on gateway | |
KPIName | string | (Required) name of the KPI registered with UTS for application | |
page | number | specifies the requested page index. | |
size | number | specifies the number of elements in a page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"provider":"provider","application":"assetmonitor","applicationDisplayName":"Asset Monitor","KPIName":"asset-count","KPIDisplayName":"asset count","aggregationUntilDate":"2011-07-14","year":"2021","month":"january","aggregatedUsages":[{"consumer":"bmw","value":20},{"consumer":"bmw","value":20}],"aggragationFunction":{"aggregationFunctionDaily":"SUM","aggregationFunctionMonthly":"SUM","preFill":"ZERO"},"page":{"number":2,"size":10,"totalElements":40,"totalPages":4}}