Получение вложенности измерений

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

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

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

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

>

Название	Тип	Допустимые значения	Ответ по умолчанию	Описание
Группы измерений
dimensions_groups	array		да	Список групп измерений
id	number			Идентификатор группы измерений
name	string			Название группы измерений
description	string			Описание группы измерений. Отображается в подсказке
parent_group_id	number			Идентификатор группы измерений в вложении которой находится данная группа измерений
sort	number			Сквозной идентификатор, используемый для сортировки в дереве измерений.
Измерения
dimensions	array		да	Список измерений
id	enum			Мнемоника измерения
name	string			Название измерения
description	string			Описание измерения. Отображается в подсказке
group_id	number			Идентификатор группы измерений в вложении которой находится данное измерение
sort	number			Сквозной идентификатор, используемый для сортировки в дереве измерений.
data_type	enum		да	Формат данных
is_custom	boolean		да	Является ли измерение пользовательским
is_entity_separated	boolean		да	Является ли пользовательское измерение расширенным

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

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

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

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

        },
        "data": {
            "dimensions_groups": [
                    {
                      "id": "number",
                      "name": "string",
                      "description": "string",
                      "parent_group_id": "number",
                      "sort": "number"
                    }
            ],
            "dimensions": [
                    {
                      "id": "enum",
                      "name": "string",
                      "description": "string",
                      "group_id": "number",
                      "sort": "number",
                      "data_type": "enum",
                      "is_custom": "boolean",
                      "is_entity_separated": "boolean"
                    }
            ]
        }
    }
}

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

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

        },
        "data": {
            "dimensions_groups": [
                    {
                      "id": 1,
                      "name": "Рекламная система",
                      "description": "Параметры подтянутые из внешних систем",
                      "parent_group_id": null,
                      "sort": 100
                    },
                    {
                      "id": 2,
                      "name": "Мои измерения",
                      "description": "Параметры созданные пользователем",
                      "parent_group_id": 1,
                      "sort": 200
                    }
            ],
            "dimensions": [
                    {
                      "id": "campaign_ext_name",
                      "name": "Интегрированная рекламная кампания",
                      "description": "Название внешней рекламной кампании",
                      "group_id": 2,
                      "sort": 201,
                      "data_type": "string",
                      "is_custom": false,
                      "is_entity_separated": false
                    },
                    {
                      "id": "banner_group_name",
                      "name": "Группа объявлений",
                      "description": "Название группы объявлений в рекламной системе",
                      "group_id": null,
                      "sort": 401,
                      "data_type": "string",
                      "is_custom": false,
                      "is_entity_separated": false
                    }
            ]
        }
    }
}

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

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