Получение результирующих данных в отчете пользователя

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

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

Название	Тип	Обязательный	Допустимые значения	Описание
`access_token`	string	да		Ключ сессии аутентификации
`user_id`	number	нет		Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`report_type`	enum	да		Тип отчета пользователя. В данный момент работает только для типа отчетов `call_summary_uis`. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list"
`date_from`	iso8601	да	YYYY-MM-DD hh:mm:ss	Дата начала основной выборки(ограничение 366 дней)
`date_till`	iso8601	да	YYYY-MM-DD hh:mm:ss	Дата окончания основной выборки
`columns`	array	да	Если заполнен `transfer_dimension_value_id`, то необходимо указать только один столбце по которому произошел клик для перехода.	Список идентификаторов пользовательских столбцов, разделенных запятой. Доступный список столбцов см.раздел "Получение вложенности столбцов" . Порядок влияет на ответ.
Фильтры применяемые в отчете
`filter`	object	нет	Допустимо использовать не более `2 уровней` вложенности. Смотри примеры ниже	Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации"
`filters`	array	да		Выражение, может содержать в себе как простые фильтры, так и дерево фильтров.
`field`	string			Поле сущности к которой будет применяться фильтрация (список заранее определен для метода
`operator`	enum			Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации"
`value`	string			Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота.

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
`totals`	array					Итоговые данные по запрашиваемым показателям в `columns` в текущем уровне.

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

Копировать

{
  "id": "number",
  "jsonrpc": "2.0",
  "method": "getobj.report_total",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "report_type": "enum",
    "date_from": "iso8601",
    "date_till": "iso8601",    
    "columns": [
      "column1",
      "columnN"
    ],
    "filter":{

    }
  }
}

JSON пример структуры запроса

Копировать

{
  "id": "number",
  "jsonrpc": "2.0",
  "method": "getobj.report_total",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "limit": "number",
    "offset": "number",
    "report_type": "call_summary_uis",
    "date_from": "2020-02-01 00:00:00",
    "date_till": "2020-02-01 23:59:59",
    "columns": [
      "cc_302"
    ],
    "filter":{
      "filters":[
       {
        "filters":[
         {
          "field":"tags",
          "operator":"=",
          "value":"Целевой"
         },
         {
          "field":"tags",
          "operator":"=",
          "value":"Лид"
         }
        ],
        "condition":"or"
       },
       {
        "filters":[
         {
          "field":"site_domain",
          "operator":"=",
          "value":"www.site1.ru"
         },
         {
          "field":"site_domain",
          "operator":"=",
          "value":"www.site1.ru"
         }
        ],
        "condition":"or"
       }
      ],
      "condition":"and"
    }
  }
}

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

Копировать

{
  "id": "1",
  "jsonrpc": "2.0",
  "result": {
    "data": {
      "totals": [
        34.0
      ]
  }
 }
}

JSON Примеры вложенности фильтров

Минимальный уровень вложенности

Копировать

{
  "filter":{
    "field":"tags",
    "operator":"=",
    "value":"Целевой"
  }
}

Максимальный уровень вложенности (Уровень вложенности = 2)

Копировать

{
  "filter":{
   "filters":[
     {
      "filters":[
        {
         "field":"string",
         "operator":"enum",
         "value":"string"
        }
      ],
      "condition":"or"
     },
     {
      "filters":[
        {
         "field":"string",
         "operator":"enum",
         "value":"string"
        }
      ],
      "condition":"or"
     }
   ],
   "condition":"and"
  }
}

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

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