Приложение (информация о полях в объектах 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