Фильтрация (Alpha)

Общая информация

Функционал фильтрации находится в альфа-версии и пока что доступен ограниченному списку аккаунтов.
Партнеры amoCRM могут обратиться в техническую поддержку для подключения аккаунта к закрытому тестированию функционала. Заявки на подключение рассматриваются в индивидуальном порядке.
После успешного тестирования, мы начнем постепенно подключать аккаунты клиентов к данному функционалу.
Данный функционал доступен для следующих списков: сделки, контакты, компании и покупатели.

Оглавление

Фильтрация списка сделок

Метод

GET /api/v4/leads

Описание

Метод позволяет получить список сделок с учетом переданного фильтра.

Ограничения

Метод доступен в соответствии с правами пользователя.

GET параметры

Параметр Тип данных Описание Множественный? Диапазонный?
filter object Фильтр
filter[id] int|array Фильтр по ID сделок
filter[name] string|array Фильтр по названию сделки
filter[price] object Фильтр по бюджету сделки
filter[statuses] array Фильтр по статусам сделки
filter[pipeline_id] int|array Фильтр по ID воронок
filter[created_by] int|array Фильтр по ID пользователей, которые создали сущность
filter[updated_by] int|array Фильтр по ID пользователей, которые изменили сущность последними
filter[responsible_user_id] int|array Фильтр по ID пользователей, которые являются ответственными за сущности
filter[created_at] object Фильтр по дате создания сделки
filter[updated_at] object Фильтр по дате изменения сделки
filter[closed_at] object Фильтр по дате закрытия сделки
filter[closest_task_at] object Фильтр по дате ближайшей к выполнению задаче
filter[custom_fields_values] object Фильтр по значениям дополнительных полей Зависит от типа поля Зависит от типа поля
query string Строка, по которой будет произведен поиск. В ближайшее время параметр будет признан устаревшим

Фильтрация списка контактов

Метод

GET /api/v4/contacts

Описание

Метод позволяет получить список контактов с учетом переданного фильтра.

Ограничения

Метод доступен в соответствии с правами пользователя.

GET параметры

Параметр Тип данных Описание Множественный? Диапазонный?
filter object Фильтр
filter[id] int|array Фильтр по ID контактов
filter[name] string|array Фильтр по названию контакта
filter[created_by] int|array Фильтр по ID пользователей, которые создали сущность
filter[updated_by] int|array Фильтр по ID пользователей, которые изменили сущность последними
filter[responsible_user_id] int|array Фильтр по ID пользователей, которые являются ответственными за сущности
filter[created_at] object Фильтр по дате создания контакта
filter[updated_at] object Фильтр по дате изменения контакта
filter[closest_task_at] object Фильтр по дате ближайшей к выполнению задаче
filter[custom_fields_values] object Фильтр по значениям дополнительных полей Зависит от типа поля Зависит от типа поля
query string Строка, по которой будет произведен поиск. В ближайшее время параметр будет признан устаревшим

Фильтрация списка компаний

Метод

GET /api/v4/companies

Описание

Метод позволяет получить список компаний с учетом переданного фильтра.

Ограничения

Метод доступен в соответствии с правами пользователя.

GET параметры

Параметр Тип данных Описание Множественный? Диапазонный?
filter object Фильтр
filter[id] int|array Фильтр по ID компаний
filter[name] string|array Фильтр по названию компании
filter[created_by] int|array Фильтр по ID пользователей, которые создали сущность
filter[updated_by] int|array Фильтр по ID пользователей, которые изменили сущность последними
filter[responsible_user_id] int|array Фильтр по ID пользователей, которые являются ответственными за сущности
filter[created_at] object Фильтр по дате создания компании
filter[updated_at] object Фильтр по дате изменения компании
filter[closest_task_at] object Фильтр по дате ближайшей к выполнению задаче
filter[custom_fields_values] object Фильтр по значениям дополнительных полей Зависит от типа поля Зависит от типа поля
query string Строка, по которой будет произведен поиск. В ближайшее время параметр будет признан устаревшим

Фильтрация списка покупателей

Метод

GET /api/v4/customers

Описание

Метод позволяет получить список покупателей с учетом переданного фильтра.

Ограничения

Метод доступен в соответствии с правами пользователя.

GET параметры

Параметр Тип данных Описание Множественный? Диапазонный?
filter object Фильтр
filter[id] int|array Фильтр по ID покупателей
filter[name] string|array Фильтр по названию покупателя
filter[next_price] string|array Фильтр по ожидаемой сумме следующей покупки
filter[next_date] object Фильтр по ожидаемой дате следующей покупки
filter[status_id] int|array Фильтр по ID статуса покупателей
filter[created_by] int|array Фильтр по ID пользователей, которые создали сущность
filter[updated_by] int|array Фильтр по ID пользователей, которые изменили сущность последними
filter[responsible_user_id] int|array Фильтр по ID пользователей, которые являются ответственными за сущности
filter[created_at] object Фильтр по дате создания компании
filter[updated_at] object Фильтр по дате изменения компании
filter[closest_task_at] object Фильтр по дате ближайшей к выполнению задаче
filter[custom_fields_values] object Фильтр по значениям дополнительных полей Зависит от типа поля Зависит от типа поля

Типы фильтров

В данный момент доступно несколько типов фильтров.

  • Одиночный
  • Множественный
  • Диапазонный
  • Фильтр по статусам (только для сделок)
  • Фильтр по дополнительным полям

Каждый из них рассмотрим ниже с примерами.

Одиночный

Самый простой фильтр, который доступен. Принимает одно строковое значение.

Пример запроса

        
/api/v4/leads/?filter[name]=Сделка
        
    

Множественный

Расширенный вариант одиночного фильтра. Принимает несколько строковых значений.

Пример запроса

        
/api/v4/leads/?filter[pipeline_id][0]=15314&filter[pipeline_id][0]=21856
        
    

Диапазонный

Фильтр, который позволяет фильтровать числовые значение по диапазону ОТ-ДО.

Если фильтр установлен по значением полей, в которых хранится timestamp, то необходимо передавать в фильтр timestamp значения.

Фильтр доступен для следующих полей:

  • price
  • next_price
  • next_date
  • created_at
  • updated_at
  • closed_at
  • closest_task_at
  • Поля типа date, date_time, numeric

Пример запроса

        
/api/v4/leads/?filter[updated_at][from]=1575296400&filter[updated_at][to]=1589540009
        
    

Фильтр по статусам

Фильтр, который позволяет фильтровать сделки по нахождению в конкретных статусах.

Фильтр принимает массив, у каждого объекта массива есть 2 обязательных поля – pipeline_id и status_id.

Пример запроса

        
/api/v4/leads?filter[statuses][0][pipeline_id]={pipeline_id}&filter[statuses][0][status_id]={status_id}
        
    

Фильтр по дополнительным полям

Фильтр, который позволяет фильтровать сделки по значению нескольких дополнительных полей.

Для разных типов полей необходимы разные значения в фильтре.

  • Для полей numeric, text, url, textarea, streetaddress в значение фильтра передается значение поля
  • Для полей select, multiselect, radiobutton в значение фильтра передается ID enum значения
  • Для поля checkbox в значение фильтра передается 1 или 0

Для разных типов полей доступны разные подходы к фильтрации.

Поля, которые поддерживают фильтр по диапазону:

  • date
  • date_time
  • numeric

Поля, которые поддерживают множественный выбор:

  • numeric
  • text
  • url
  • textarea
  • streetaddress
  • select
  • multiselect
  • radiobutton

Пример запроса

        
/api/v4/lead?filter[custom_fields_values][{field_id}][]={value}&filter[custom_fields_values][{field_id}][]={value2}
/api/v4/lead?filter[custom_fields_values][{field_id}][]={enum_id}&filter[custom_fields_values][{field_id}][]={enum_id2}
/api/v4/lead?filter[custom_fields_values][{field_id}][from]={date_from}&filter[custom_fields_values][{field_id}][to]={date_to}