Description
Returns current system usage statistics for given time period.
With Usage Statistics, it is possible to track how client usage of the system is growing over time in order to have a transparent view of client billing which is correlated.
GET [REST URL]/usagestatistics/get
Parameter | Type | Description |
---|---|---|
fromDate | Datetime | / |
toDate | Datetime | / |
aggregationPeriod | String | auto, daily, monthly |
Parameter | Type | Description |
---|---|---|
fromDate | Datetime | from the request |
toDate | Datetime | from the request |
KPI object | / | name, description, unit, value |
Notes:
list of Attribute arguments
Example response body:
{ "fromDate": "2022-07-01", "toDate": "2022-09-27", "kpis": [ { "name": "totalnoofmessagesbounced", "description": "Total no. of messages bounced across all domains in system", "unit": "UNIT", "counters": [ { "timestamp": "2022-07-01", "value": "8" }, { "timestamp": "2022-08-01", "value": "2" }, { "timestamp": "2022-09-01", "value": "0" } ] } |