Получение вложенности столбцов
| Метод | getobj.columns_tree |
|---|---|
| Описание | Получение вложенности столбцов |
| Кому доступен | Агент, Клиент |
| Необходимые компоненты для работы с методом | Data API для настройки |
| Вес метода | 1 балл |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
report_type |
enum | да | Тип отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list" |
Параметры ответа
| Название | Тип | Допустимые значения | Ответ по умолчанию | Описание | ||
|---|---|---|---|---|---|---|
| Группы столбцов | ||||||
columns_groups |
array | да | Список групп столбцов | |||
id |
number | Идентификатор группы столбцов | ||||
name |
string | Название группы столбцов | ||||
description |
string | Описание группы столбцов. Отображается в подсказке | ||||
parent_group_id |
number | Идентификатор группы столбцов в вложении которой находится данная группа столбцов | ||||
sort |
number | Сквозной идентификатор, используемый для сортировки в дереве столбцов. | ||||
| Столбцы | ||||||
columns |
array | да | Список столбцов доступных пользователю в отчете | |||
id |
string | Мнемоника столбца | ||||
name |
string | Название столбца | ||||
description |
string | Описание столбца. Отображается в подсказке | ||||
group_id |
number | Идентификатор группы столбцов в вложении которой находится данный столбец | ||||
sort |
number | Сквозной идентификатор, используемый для сортировки в дереве измерений. | ||||
is_custom |
boolean | Является ли столбец пользовательским. | ||||
type |
enum |
metric - Столбец на основе метрикиformula - Столбец на основе формулы |
Тип столбца. В зависимости от типа столбца нужно использовать соответствующие методы для редактирования и получения настроек. | |||
expression |
string | Используемые условия фильтрации в столбце или формула для вычисления столбца. Отображается в подсказке | ||||
data_type |
enum | да | Формат данных | |||
multichannel_model |
enum | да | Используемый способ мультиканального анализа | |||
is_transferable |
boolean | да | Возможен ли переход в другие отчеты по данному столбцу. | |||
is_pie_chart_available |
boolean | Доступность стобца для отображени в графичевском виде круговой диаграммы(pie chart) | ||||
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"getobj.columns_tree",
"params":{
"access_token":"string",
"user_id":"number",
"report_type": "enum"
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": {
"columns_groups": [
{
"id": "number",
"name": "string",
"description": "string",
"parent_group_id": "number",
"sort": "number"
}
],
"columns": [
{
"id": "string",
"name": "string",
"description": "string",
"group_id": "number",
"sort": "number",
"is_custom": "boolean",
"type": "enum",
"expression": "string",
"data_type": "enum",
"multichannel_model": "enum",
"is_pie_chart_available": "boolean",
"is_transferable": "boolean"
}
]
}
}
}
JSON Пример ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": {
"columns_groups": [
{
"id": 1,
"name": "Посещения",
"description": "Показатели сессии",
"parent_group_id": null,
"sort": 100
},
{
"id": 2,
"name": "Расходы",
"description": "Показатели связанные с расходами на рекламу",
"parent_group_id": null,
"sort": 200
}
{
"id": 3,
"name": "Мои столбцы",
"description": "Пользовательские столбцы",
"parent_group_id": null,
"sort": 300
}
],
"columns": [
{
"id": "cc_1",
"name": "Глубина просмотра, среднее",
"sort": 110,
"type": "metric",
"group_id": 1,
"data_type": "float",
"is_custom": false,
"expression": null,
"description": null,
"multichannel_model": null,
"is_transferable": false,
"is_pie_chart_available": false
},
{
"id": "cc_2",
"name": "Отказы, количество",
"sort": 111,
"type": "metric",
"group_id": 1,
"data_type": "integer",
"is_custom": false,
"expression": null,
"description": null,
"multichannel_model": null,
"is_transferable": false,
"is_pie_chart_available": true
},
{
"id": "cc_3",
"name": "Новые посещения, количество",
"sort": 112,
"type": "metric",
"group_id": 1,
"data_type": "integer",
"is_custom": false,
"expression": null,
"description": null,
"multichannel_model": null,
"is_transferable": false,
"is_pie_chart_available": true
},
{
"id": "cc_4",
"name": "Время на сайте, среднее",
"sort": 113,
"type": "metric",
"group_id": 1,
"data_type": "time",
"is_custom": false,
"expression": null,
"description": null,
"multichannel_model": null,
"is_transferable": false,
"is_pie_chart_available": false
}
]
}
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом getobj"