Announcements (Sep 26, 2021)


NOTE This release include some major, breaking API Changes as decribed below.


1. Change of API Endpoint

The API to get aggredate analytics information has been switched to the new context path URL. The old endpoint is no longer functional.

Old Endpoint:

POST /restapi/v1.0/account/{accountId}/analytics/performance/calls/aggregate/

New Endpoint :

POST /analytics/phone/performance/v1/accounts/{accountId}/calls/aggregate/

2. Timeline Support (new API Endpoint)

The new API endpoint provides the ability to see performance calls data break down for various time periods. The time periods for which data must be grouped can be specified using a new data set option that has been added. A new separate API path is available now:

POST /analytics/phone/performance/v1/accounts/{accountId}/calls/timeline
  • At the moment, ‘Timeline’ request model fully mirrors our primary request, with only one addition:

  • A required query parameter “interval” should be set with one of the following values: Hour or Day or Week or Month.

  • Currently supported grouping is 'Users'

  • Server side Error Handling : The system does not include a validation grouping selection combinations. While we further evolve this API, please ensure you provide time ranges and interval selections that are logically valid.

Example : This request returns aggregation of all the calls to the specified queue (groupBy) that had at least one hold during the call.
POST /analytics/phone/performance/v1/accounts/{accountId}/calls/timeline?interval=Day

HTTP Request Body:

{
    "grouping": {
        "groupBy": "Users",
        "ids": ["829099004"]
    },
    "timeRange": {
        "timeFrom": "2021-09-07T00:00:11.586Z",
        "timeTo": "2021-09-09T23:59:11.586Z"
    },
    "responseOptions": {
        "timers": {
            "totalCallLength": {
                "aggregationType": "Sum"
            }
        }
    }
}

HTTP Response Body:

{
    "data": [{
        "key": "829099004",
        "points": [{
                "time": "2021-09-07T00:00:00Z",
                "timers": {
                    "callsDurationSeconds": "11.288"
                },
                "counters": null
            },
            {

                "time": "2021-09-08T00:00:00Z",
                "timers": {
                    "callsDurationSeconds": 0.0
                },
                "counters": null
            },
            {
                "time": "2021-09-09T00:00:00Z",
                "timers": {
                    "callsDurationSeconds": 11.856
                },
                "counters": null
            }
        ]
    }]
}