get

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.

Request path

GET [REST URL]/usagestatistics/get

Query Parameters

Response Parameters

Notes:

1.  fromDate and toDate can have a range of 3 years maximum, with a minimum interval of "month". "Day" interval works for a range (toDate-fromDate) within 1 month of the current date. "Month" interval works for a range (toDate-fromDate) outside of the last month from the current date.
2. Optional parameter aggregationPeriod with 3 options:

• auto - default if not specified, behave as previously
• daily - force daily aggregation
• monthly - force monthly aggregation

Request Body Type

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"
                }
            ]
        }