Получение списка возможных условий фильтрации для отчета

Метод	`get.report_filters`
Описание	Получение списка возможных условий фильтрации для отчета
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	Data API для настройки
Вес метода	1 балл

Параметры запроса

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`report_type`	enum	да	Тип отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list"

Параметры ответа

Название	Тип	Ответ по умолчанию	Описание
`id`	enum	да	Уникальная мнемоника условия фильтрации
`name`	string	да	Название условия фильтрации
`description`	string	да	Описание условия фильтрации
`format`	string	да	Тип фильтра
`additional_web_format`	string	да	Мнемоника поля для логики отображения фильтров на вебе
Операторы фильтрации
`operators`	array	да	Операторы фильтрации доступные для выбранного условия. Список всех операторов можно получить в разделе "Возможные операторы"
`id`	enum		Мнемоника оператора фильтрации
`name`	string		Название оператора фильтрации
`is_default`	boolean		Оператор фильтрации по умолчанию
Список возможных значений
`values`	array	да	Возвращается либо список возможных значений для выбранного условия, либо список Топ-10 значений из статистики за последние 7 дней
`is_custom_dimension`	boolean	да	Фильтр создан на основе пользовательского измерения.

JSON структура запроса

Копировать

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.report_filters",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "report_type": "enum"
  }
}

JSON структура ответа

Копировать

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {

    },
    "data": [
      {
       "id": "enum",
       "name": "string",
       "description": "string",
       "format": "enum",
       "operators": [
         {
           "id": "enum",
           "name": "string",
           "is_default": "boolean"
         }
       ],
       "values": [
         "value_1",
         "value_2",
         .....
       ],
       "is_custom_dimension": "boolean"
      }
    ]
  }
}

JSON пример ответа

Копировать

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {

    },
    "data": [
      {
       "id": "tags",
       "name": "Теги",
       "description": "string",
       "format": "text_list",
       "operators": [
         {
           "id": "ilike",
           "name": "Включает",
           "is_default": true
         },
         {
           "id": "not_ilike",
           "name": "Исключает",
           "is_default": false
         },
         {
           "id": "=",
           "name": "Равно",
           "is_default": false
         },
         {
           "id": "!=",
           "name": "Не равно",
           "is_default": false
         }
       ],
       "values": [
         "Целевой",
         "Лид",
         ....
       ],
       "is_custom_dimension": false
      },
      {
       "id": "call_type",
       "name": "Тип звонка",
       "description": "string",
       "format": "system",
       "operators": [
         {
           "id": "=",
           "name": "Равно",
           "is_default": false
         },
         {
           "id": "!=",
           "name": "Не равно",
           "is_default": false
         }
       ],
       "values": [
         "ВАТС",
         "Коллтрекинг",
         ....
       ],
       "is_custom_dimension": false
      },
      ....
    ]
  }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"