Дерево статистики
Возвращает список доступных уровней и параметры для каждого уровня статистики, которые можно использовать для построения отчета.
Формат запроса
https://partner2.yandex.ru/api/statistics2/tree
? lang=<string>
& [pretty=<integer>]
& [stat_type=<string>]
-
- lang *
- Язык ответа. Должен присутствовать во всех запросах.
-
- pretty
- Форматирует результат для удобства чтения. Допустимое значение :
pretty=1.
-
- stat_type
-
Тип отчета. Допустимые значения:
stat_type=mm— отчет по Мобильной медиации;stat_type=dsp— отчет по DSP;stat_type=main— отчет по основной статистике. Значение по умолчанию.
* Обязательный параметр.
Заголовки запроса
| Заголовок | Описание | Обязательный |
|---|---|---|
Authorization |
Авторизационный токен пользователя. | Да |
Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется.
Формат ответа JSON
{
"result" : {string},
"data" : {
"tree" : [
{
"title" : {string},
"id" : {string},
"conflict_fields" : [],
"dimension_fields" : [
{
"values" : [
[
{string},
{string}
],
[
...
]
],
"type" : {string},
"title" : {string},
"id" : {string}
},
{
"values" : [
[
{string},
{string}
],
[
...
]
],
"type" : {string},
"title" : {string},
"id" : {string}
}
],
"entity_fields" : [
{
"type" : {string},
"label" : {string},
"index" : {integer},
"id" : {string}
}
],
"entity_filter_fields" : {
"filter_field_name" : {
"type" : {string},
"index" : {integer}
}
},
"entity_filter_simple_fields" : [
[
{
"name" : {string},
"label" : {string},
"index" : {integer}
}
]
],
"fields" : [
{
"type" : {string},
"title" : {string},
"index" : {integer},
"id" : {string},
"category_name" : {string},
"category" : {integer}
}
],
"has_product" : "",
"has_raw_stat" : ""
}
]
}
}
Параметры ответа
-
- result
- Результат выполнения метода. Допустимые значения :
ok— вызов метода прошел успешно;error— при вызове метода произошла ошибка.
-
- data
- Тело ответа.
-
- tree
- Дерево статистики.
-
- title
- Название уровня статистики.
-
- id
- Идентификатор уровня статистики. Параметр используется в запросе для построения отчета.
-
- conflict_fields
- Служебный параметр. Не используется.
-
- dimension_fields
- Информация о полях, по которым будут сгруппированы данные в отчете. Например, группировка по дням или неделям.
-
- id
- Идентификатор поля. Параметр используется в запросе для построения отчета.
-
- title
- Название поля.
-
- type
- Тип поля (здесь типом поля является
select— выбор из списка периодов). Параметр используется для построения страницы в Партнерском интерфейсе.
-
- values
- Список возможных периодов. Одно из значений используется в запросе для построения отчета.
-
-
- entity_fields
- Информация о полях, по которым будут сгруппированы данные в отчете. Например, группировка по логину.
-
- id
- Идентификатор поля. Параметр используется в запросе для построения отчета.
-
- label
- Название поля. Параметр используется для построения страницы в Партнерском интерфейсе.
-
- type
- Тип поля (например,
text— в поле можно вводить текстовую информацию). Параметр используется для построения страницы в Партнерском интерфейсе.
-
- index
- Индекс.
-
-
- entity_filter_fields
- Информация о полях, которые выполняют роль фильтров при построении отчета. К фильтрам применяют операторы SQL. Например, можно использовать фильтр по идентификатору площадки. Подробнее в разделе Поля-фильтры.
-
- filter_field_name
-
Поле (название), которое выполняет роль фильтра. Объект содержит характеристики поля.
type— Тип поля. Помогает определить какие операторы SQL можно применить к фильтру. Подробнее в разделе Поля-фильтры.index— Индекс.
-
-
- entity_filter_simple_fields
- Информация о полях, которые выполняют роль фильтров при построении отчета.
-
- name
- Название поля.
-
- label
- Название поля. Параметр используется для построения страницы в Партнерском интерфейсе.
-
- index
- Индекс.
-
-
- fields
- Информация о полях, которые можно включить в отчет. Например, такими полями являются различные показатели : показ рекламы в блоках, оборот за RTB-блоки.
-
- id
- Идентификатор поля. Параметр используется в запросе для построения отчета.
-
- type
- Тип поля (например,
text— в поле можно вводить текстовую информацию). Параметр используется для построения страницы в Партнерском интерфейсе.
-
- title
- Название поля. Параметр используется для построения страницы в Партнерском интерфейсе.
-
- index
- Индекс.
-
- category_name
- Служебный параметр. Не используется.
-
- category
- Служебный параметр. Не используется.
-
-
- has_product
- Служебный параметр. Не используется.
-
- has_raw_stat
- Служебный параметр. Не используется.
-
-
Пример для JSON
Запрос:
curl -i -X GET 'https://partner2.yandex.ru/api/statistics2/tree.json?lang=ru' \ -H 'Authorization : OAuth 123qwe456a...'Ответ:
HTTP/1.1 200 OK Server : nginx Date : Fri, 02 Jul 2020 10:20:13 GMT Content-Type : application/json; charset=UTF-8 Transfer-Encoding : chunked Connection : keep-alive { "data" : { "tree" : [ { "conflict_fields" : [], "dimension_fields" : [ { "id" : "date", "title" : "Дата", "type" : "select", "values" : [ [ "month", "по месяцам" ], [ "week", "по неделям" ], [ "day", "по дням" ], [ "year", "по годам" ] ] }, { "id" : "geo", "title" : "География", "type" : "select", "values" : [ [ "country", "по странам" ], [ "city", "по городам" ], [ "area", "по областям" ] ] } ], "entity_fields" : [ { "category" : 14, "category_name" : "Продукт", "id" : "block_level", "index" : 4, "label" : "Блочный уровень продукта", "type" : "tree" }, { "category" : 14, "category_name" : "Продукт", "id" : "page_level", "index" : 5, "label" : "Уровень продукта", "type" : "tree" }, { "category" : 12, "category_name" : "Площадка", "id" : "page_id", "index" : 11, "label" : "Page ID", "type" : "publicid" }, { "category" : 12, "category_name" : "Площадка", "id" : "page_caption", "index" : 12, "label" : "Название пейджа", "type" : "text" }, { "category" : 10, "category_name" : "Блок", "id" : "complex_block_id", "index" : 14, "label" : "ID Блока", "type" : "publicid" }, { "category" : 10, "category_name" : "Блок", "id" : "block_caption", "index" : 15, "label" : "Название блока", "type" : "text" }, { "category" : 10, "category_name" : "Блок", "id" : "tag_id", "index" : 16, "label" : "ID Среза", "type" : "publicid" }, { "category" : 9, "category_name" : "ADFOX", "id" : "adfox_block", "index" : 17, "label" : "Блок ADFOX", "type" : "boolean" }, { "category" : 9, "category_name" : "ADFOX", "id" : "deal_id", "index" : 18, "label" : "ID сделки", "type" : "publicid" }, { "category" : 9, "category_name" : "ADFOX", "id" : "deal_caption", "index" : 19, "label" : "Название сделки", "type" : "text" }, { "id" : "business_rule_id", "index" : 20, "label" : "ID правила", "type" : "publicid" }, { "id" : "business_rule_title", "index" : 21, "label" : "Название правила", "type" : "text" }, { "category" : 7, "category_name" : "Трафик", "id" : "os", "index" : 22, "label" : "Операционная система", "type" : "publicid" }, { "category" : 7, "category_name" : "Трафик", "id" : "browser", "index" : 23, "label" : "Браузер", "type" : "publicid" }, ... { "category" : 6, "category_name" : "Показатели по рекомендациям", "id" : "RecommendationWidgetCTR", "index" : 58, "title" : "CTR рекомендательного виджета", "type" : "text" } ], "has_product" : "", "has_raw_stat" : "", "id" : "payment", "title" : "Вознаграждения" } ] }, "result" : "ok" }
Язык ответа. Должен присутствовать во всех запросах.
Форматирует результат для удобства чтения. Допустимое значение : pretty=1.
Тип отчета. Допустимые значения:
stat_type=mm— отчет по Мобильной медиации;stat_type=dsp— отчет по DSP;stat_type=main— отчет по основной статистике. Значение по умолчанию.
Обязательный параметр.