Получение данных таблицы в отчёте пользователя

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

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

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

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
date_from	iso8601	YYYY-MM-DD hh:mm:ss	да	да		Дата начала основной выборки
date_till	iso8601	YYYY-MM-DD hh:mm:ss	да	да		Дата окончания основной выборки
Массив строк запрашиваемого отчета
rows	array		да			Массив строк запрашиваемого отчета
Список запрашиваемых измерений
dimension	array		да			Список значений запрашиваемых dimensions
value	string		да	да	Если в запрашиваемого dimension нет данных, возвращается Не определено	Имя значений запрашиваемых dimensions
value_id	string					Уникальный идентификатор ветви значений запрашиваемых измерений
Список запрашиваемых столбцов
columns	array		да	да		Список значений запрашиваемых столбцов в разрезе измерения
expandable	boolean					Можно ли развернуть измерение

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

{
    "id": "number",
    "jsonrpc": "2.0",
    "method": "getobj.report_table",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "limit": "number",
        "offset": "number",
        "report_type": "enum",
        "date_from": "iso8601",
        "date_till": "iso8601",
        "dimensions": [
            "dimension1",
            "dimensionN",
            ....
        ],
        "columns": [
            "column1",
            "columnN",
            ....
        ],
        "parent_dimensions_value_ids": [
            "N",
            "M",
            ....
        ],
        "filter":{

        },
        "columns_filter":{

        },
        "sort": [
            {
            "field": "string",
            "order": "string"
            }
        ]
    }
}

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

{
    "id": "number",
    "jsonrpc": "2.0",
    "method": "getobj.report_table",
    "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",
        "dimensions": [
            "site",
            "gr"
        ],
        "columns": [
            "cc_5"
        ],
        "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"
        },
        "columns_filter":{
            "field":"cc_5",
            "value":1,
            "operator":">"
      }
    }
}

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

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": {
            "date_from": "iso8601",
            "date_till": "iso8601",
            "rows": [
                {
                "dimension": {
                    "value": "string",
                    "value_id": "string"
                },
                "columns": [
                    < double >,
                    < double >,
                    ...
                ],
                "expandable": "boolean"
                }
            ]

        }
    }
}

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

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "data": {
            "date_from": "2020-02-19 00:00:00",
            "date_till": "2020-02-20 23:59:59",
            "rows": [
                {
                    "columns": [
                        16.0,
                        25.0,
                        43.75
                    ],
                    "dimension": {
                        "value": "Google Chrome",
                        "value_id": "6"
                    },
                    "expandable": false
                },
                {
                    "columns": [
                        11.0,
                        11.0,
                        36.36363636
                    ],
                    "dimension": {
                        "value": "Яндекс.Браузер",
                        "value_id": "70"
                    },
                    "expandable": true
                }
            ]
        }
    }
}

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"