Filters

In order to narrow down the data returned by the API, you have several filtering options.

Date of Call

It can be useful to filter the returned Calls by date. To do so, the API Client can provide the following query parameters:

  • timestamp_from=2020-06-01T02:00:00Z: will filter Calls to return only the ones with a timestamp value greater than or equal to the date and time provided.
  • timestamp_to=2020-06-01T02:00:00Z: will filter Calls to return only the ones with a timestamp value lower than or equal to the date and time provided.

Parameters timestamp_from and timestamp_to can be provided together or separetely. The expected value format is from the ISO 8601 standard, and must be either as 2020-06-01T02:00:00Z or 2020-06-01T00:00:00+02:00. Both these examples represent June 1st 2020 at midnight Paris time.

It might come in handy to use query parameters order=timestamp together with timestamp_from and timestamp_to.

Status of Call

Calls are given a status within our system during their lifetime. It allows for an easy way to know what data to expect. This API expose Calls once we've done all the qualification we can. That is to say the Call is over, it has been transcribed, analyzed and so on. We name this state qualified, and by default the API expose only these Calls.

It can happen that a Call will end its journey with a status of void. This is the case for example when there has been no interaction between the customer and the brand (for example because the customer hanged up before reaching an agent). Still these Calls can be interesting to retrieve for statistical purpose for example.

In order to retrieve these "void" Calls as well as the "qualified", a query parameter can be passed:

  • status=qualified, status= or absence of this parameter: this is the default behaviour, and only
    "qualified" Calls will be returned.
  • status=qualified,void: both qualified and void Calls will be exposed.
  • status=void: only void Calls will be exposed.

The status of each Call is included in the response payload, please see the API reference for more details.