# Приложение (информация о полях в объектах JSON:API)

**JSON:API - Параметры по умолчанию**

| Название                     | Описание                                                               |
| ---------------------------- | ---------------------------------------------------------------------- |
| filters\[filter\_name]=value | В запросе может быть набор фильтров, которые будут влиять на результат |
| page\[number]                | с помощью этого параметра можно переходить по страницам ответа         |
| sort                         | сортировка по атрибутам объекта (таким как created\_at)                |

**JSON:API - Типы параметров**

| Тип                            | Описание                                                                                                                                                                                                                                                                                                                  |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Дата                           | передаются в виде строки в формате ISO8601 (не забывайте про time zone)                                                                                                                                                                                                                                                   |
| Массивы в значениях фильтров   | передаются в виде строки в формате ISO8601 (не забывайте про time zone) Передаются строкой соединенной через запятую Например, запрос, который будет возвращать список коммуникаций определенного вида (communications\_types), будет иметь вид `/api/v1/client_interactions?communications_types=phone_call,chat,ticket` |
| Диапазоны в значениях фильтров | Передаются в фильтрах, которые заканчиваются на `_from` (для начального значения) и `_to` (для последнего значения). Например, для диапазона названия фильтров для продолжительности разговора будет `duration_from` и `duration_to`                                                                                      |

**Филтры ресурса client\_interactions**

| Name                                                            | Описание                                                        |
| --------------------------------------------------------------- | --------------------------------------------------------------- |
| client\_interaction\_time\_from / client\_interaction\_time\_to | время совершения коммуникации (started\_at), iso8601 с datetime |
| review\_time\_to / review\_time\_from                           | диапазон времени оценки                                         |
| direction                                                       | incoming / outcoming                                            |
| duration\_from / duration\_to                                   | длительность в секундах                                         |
| reviews\_count\_to / reviews\_count\_from                       | кол-во оценок                                                   |
| checklist\_score\_from / checklist\_score\_to                   |                                                                 |
| client\_phone\_number                                           |                                                                 |
| units\_ids                                                      |                                                                 |
| clients\_ids                                                    |                                                                 |
| is\_reviewed                                                    |                                                                 |
| client\_integration\_uids                                       |                                                                 |
| operators\_ids                                                  |                                                                 |
| reviewers\_ids                                                  |                                                                 |
| communication\_type                                             |                                                                 |
| communications\_types                                           |                                                                 |
| comments\_rating\_flags                                         |                                                                 |
| nps\_from / nps\_to                                             |                                                                 |
| checklist\_definitions\_ids                                     |                                                                 |

**Фильтры для ресурса Reviews**

| Name                                                            |
| --------------------------------------------------------------- |
| time\_to / time\_from                                           |
| client\_interaction\_time\_to / client\_interaction\_time\_from |
| client\_interaction\_direction                                  |
| has\_comments                                                   |
| units\_ids                                                      |
| operators\_ids                                                  |
| reviewers\_ids                                                  |
| client\_integration\_uids                                       |
| client\_interactions\_ids                                       |
| checklist\_definitions\_ids                                     |
| comments\_rating\_flags                                         |