Announcements (Sep 16, 2021)

This new release includes additional filters, renaming of API parameters that will result in breaking changes. It is recommended you read the "What's New" section in full in order to update your code to incorporate the latest API changes.

What's New ?

1. API response format rework

API response shape was simplified, switching to Array type for “data” field with a new field “key” for grouping identifier.

HTTP Response Body (inner fields omitted for visibility) :

"data": [
       {
           "key": "983040004",
           "timers": {/.../},
           "counters": {/.../}
       },
       {
           "key": "873717004",
           "timers": {/.../},
           "counters": {/.../}
       }
   ],
   "paging": {
       "page": 1,
       "perPage": 2,
       "totalPages": 13,
        "totalElements": 25
   }
}

2. Additional filter “callSegments” accepts timers

Now in “callSegment” filter we can specify a desired min and max value for “callSegmentLength” in seconds.

HTTP Request Body:

{
   "grouping": {
    "groupBy": "Queues"
   },
   "timeRange": {
    "timeFrom": "2021-01-28T13:13:21.843Z",
    "timeTo": "2021-08-28T13:13:21.843Z"
   },
 "additionalFilters": {
   "callSegments": [
     {
       "callSegment": "Ringing",
       "callSegmentLength": {
         "minValueSeconds": 1,
         "maxValueSeconds": 100
       }
     }
   ]
 },
   "responseOptions": {
    "counters": {
        "allCalls": {
            "aggregationType": "Sum"
        }
    },
    "timers": {
        "totalCallLength": {
            "aggregationType": "Sum"
        }
    }
   }
}

3. Minor validation update

Requests for grouping by Departments/UserGroups/Sites/Queues (via “groupBy” field in “grouping”) do not require non-empty “ids” field anymore. Previously such a request would return a validation error: “At least one identifier must be specified for this grouping type”.