Документация
Интеграция SDK

Drill down

Позволяет сформировать многоуровненвый (древовидный) отчет. При этом каждому уровню соответствует одна группировка.

Запрос к методу drilldown возвращает один подуровень для указанного родительского уровня. Родительский уровень указывается в параметре parent_id. Чтобы получить данные для первого уровня, отправьте запрос без параметра parent_id.

Чтобы получить данные для вложенных уровней, необходимо указать путь от корня. Путь формируется из значений поля id параметра dimension. Если поле id отсутствует, укажите поле name.

Краткое содержание

Синтаксис запроса

https://api.appmetrica.yandex.ru/stat/v1/data/drilldown ? 
ids
[no-highlight[Идентификаторы счетчиков, через запятую. Используется вместо параметра id.]no-highlight]
=<int,int,...> & metrics
[no-highlight[

Список метрик, разделенных запятой.

Лимит: 20 метрик в запросе.

]no-highlight]
=<string> & [accuracy
[no-highlight[Точность вычисления результата. Позволяет управлять семплированием (количеством визитов, использованных при расчете итогового значения).

Значение по умолчанию: medium

]no-highlight]
=<string>] & [callback
[no-highlight[Функция обратного вызова, которая обрабатывает ответ API.]no-highlight]
=<string>] & [date1
[no-highlight[

Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Значение по умолчанию: 6daysAgo

]no-highlight]
=<string>] & [date2
[no-highlight[

Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Значение по умолчанию: today

]no-highlight]
=<string>] & [dimensions
[no-highlight[

Список группировок, разделенных запятой.

Лимит: 10 группировок в запросе.

]no-highlight]
=<string>] & [filters
[no-highlight[

Фильтр сегментации.

Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10000 символов.

]no-highlight]
=<string>] & [group
[no-highlight[Группировка данных по времени.

Значение по умолчанию: week

Допустимые значения:

  • all — временной интервал не разбивается.
  • hours — временной интервал разбивается на интервалы из нескольких часов.
  • auto — автоматический режим.
  • week — временной интервал разбивается по неделям.
  • month — временной интервал разбивается по месяцам.
  • hour — временной интервал разбивается на часовые интервалы.
  • year — временной интервал разбивается по годам.
  • minutes — временной интервал разбивается на интервалы из некоторого количества минут.
  • day — временной интервал разбивается по дням.
  • dekaminute — временной интервал разбивается на 10-минутные интервалы.
  • quarter — временной интервал разбивается по кварталам.
  • minute — временной интервал разбивается на минутные интервалы.
]no-highlight]
=<group_type>] & [id
[no-highlight[Идентификатор счетчика. Устарело, используйте ids.]no-highlight]
=<integer>] & [include_undefined
[no-highlight[Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.]no-highlight]
=<boolean>] & [lang
[no-highlight[Язык.]no-highlight]
=<string>] & [limit
[no-highlight[

Количество элементов на странице выдачи.

Лимит: 10000.

Значение по умолчанию: 100

]no-highlight]
=<integer>] & [offset
[no-highlight[Индекс первой строки выборки, начиная с 1.

Значение по умолчанию: 1

]no-highlight]
=<integer>] & [parent_id
[no-highlight[Выбор строки для дальнейшего развертывания. Состоит из json-списка ключей.]no-highlight]
=<string>] & [pretty
[no-highlight[Задает форматирование результата. Чтобы использовать форматирование, укажите значение true.

Значение по умолчанию: false

]no-highlight]
=<boolean>] & [sort
[no-highlight[Список группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по возрастанию.Чтобы отсортировать данные по убыванию, укажите знак «-» перед группировкой или метрикой.]no-highlight]
=<string>]
idsИдентификаторы счетчиков, через запятую. Используется вместо параметра id.
metrics

Список метрик, разделенных запятой.

Лимит: 20 метрик в запросе.

accuracyТочность вычисления результата. Позволяет управлять семплированием (количеством визитов, использованных при расчете итогового значения).

Значение по умолчанию: medium

callbackФункция обратного вызова, которая обрабатывает ответ API.
date1

Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Значение по умолчанию: 6daysAgo

date2

Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Значение по умолчанию: today

dimensions

Список группировок, разделенных запятой.

Лимит: 10 группировок в запросе.

filters

Фильтр сегментации.

Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10000 символов.

groupГруппировка данных по времени.

Значение по умолчанию: week

Допустимые значения:

  • all — временной интервал не разбивается.
  • hours — временной интервал разбивается на интервалы из нескольких часов.
  • auto — автоматический режим.
  • week — временной интервал разбивается по неделям.
  • month — временной интервал разбивается по месяцам.
  • hour — временной интервал разбивается на часовые интервалы.
  • year — временной интервал разбивается по годам.
  • minutes — временной интервал разбивается на интервалы из некоторого количества минут.
  • day — временной интервал разбивается по дням.
  • dekaminute — временной интервал разбивается на 10-минутные интервалы.
  • quarter — временной интервал разбивается по кварталам.
  • minute — временной интервал разбивается на минутные интервалы.
idИдентификатор счетчика. Устарело, используйте ids.
include_undefined
 Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.
langЯзык.
limit

Количество элементов на странице выдачи.

Лимит: 10000.

Значение по умолчанию: 100

offsetИндекс первой строки выборки, начиная с 1.

Значение по умолчанию: 1

parent_idВыбор строки для дальнейшего развертывания. Состоит из json-списка ключей.
prettyЗадает форматирование результата. Чтобы использовать форматирование, укажите значение true.

Значение по умолчанию: false

sortСписок группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по возрастанию.Чтобы отсортировать данные по убыванию, укажите знак «-» перед группировкой или метрикой.

Формат ответа


{
    "total_rows
[no-highlight[

Описание

Общее количество строк в ответе.

]no-highlight]
" : < long > , "sampled
[no-highlight[

Описание

Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false.

]no-highlight]
" : < boolean > , "sample_share
[no-highlight[

Описание

Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.

]no-highlight]
" : < double > , "sample_size
[no-highlight[

Описание

Количество строк в выборке данных.

]no-highlight]
" : < long > , "sample_space
[no-highlight[

Описание

Количество строк данных.

]no-highlight]
" : < long > , "data_lag
[no-highlight[

Описание

Задержка в обновлении данных, в секундах.

]no-highlight]
" : < int > , "query
[no-highlight[

Описание

Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.

]no-highlight]
" : { "ids
[no-highlight[

Описание

Идентификаторы счетчиков.

]no-highlight]
" : [ < int > , ... ], "dimensions
[no-highlight[

Описание

Массив группировок.

]no-highlight]
" : [ < string > , ... ], "metrics
[no-highlight[

Описание

Массив метрик.

]no-highlight]
" : [ < string > , ... ], "sort
[no-highlight[

Описание

Массив сортировок.

]no-highlight]
" : [ < string > , ... ], "date1
[no-highlight[

Описание

Дата начала периода выборки в формате YYYY-MM-DD.

]no-highlight]
" : < string > , "date2
[no-highlight[

Описание

Дата окончания периода выборки в формате YYYY-MM-DD.

]no-highlight]
" : < string > , "filters
[no-highlight[

Описание

Фильтр сегментации.

]no-highlight]
" : < string > , "limit
[no-highlight[

Описание

Количество элементов на странице выдачи.

]no-highlight]
" : < integer > , "offset
[no-highlight[

Описание

Индекс первой строки выборки, начиная с 1.

]no-highlight]
" : < integer > }, "totals
[no-highlight[

Описание

Общие результаты для метрик по всему множеству данных (с учетом фильтра).

]no-highlight]
" : [ < double > , ... ], "min
[no-highlight[

Описание

Минимальные результаты для метрик среди попавших в выдачу ключей.

]no-highlight]
" : [ < double > , ... ], "max
[no-highlight[

Описание

Максимальные результаты для метрик среди попавших в выдачу ключей.

]no-highlight]
" : [ < double > , ... ], "data
[no-highlight[

Описание

Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.

]no-highlight]
" : [ { "dimension
[no-highlight[

Описание

Значение группировки для заданного уровня дерева. Например, задан второй уровень дерева (длина переданного массива parent_id равна единице). В данном случае поле будет содержать значение второй группировки запроса.

]no-highlight]
" : { "key_1" : < string > , "key_2" : ... }, "metrics
[no-highlight[

Описание

Массив значений метрик для данной строки. Значения этого массива — числа или null.

]no-highlight]
" : [ < double > , ... ], "expand
[no-highlight[

Описание

Указывает можно ли раскрыть эту строку на следующий уровень дерева.

]no-highlight]
" : < boolean > }, ... ] }
ПараметрыОписание
total_rows Общее количество строк в ответе.
sampled Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false.
sample_share Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_size Количество строк в выборке данных.
sample_space Количество строк данных.
data_lag Задержка в обновлении данных, в секундах.
query Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.
totals Общие результаты для метрик по всему множеству данных (с учетом фильтра).
min Минимальные результаты для метрик среди попавших в выдачу ключей.
max Максимальные результаты для метрик среди попавших в выдачу ключей.
data Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.
query
ids Идентификаторы счетчиков.
dimensions Массив группировок.
metrics Массив метрик.
sort Массив сортировок.
date1 Дата начала периода выборки в формате YYYY-MM-DD.
date2 Дата окончания периода выборки в формате YYYY-MM-DD.
filters Фильтр сегментации.
limit Количество элементов на странице выдачи.
offset Индекс первой строки выборки, начиная с 1.
data
dimension Значение группировки для заданного уровня дерева. Например, задан второй уровень дерева (длина переданного массива parent_id равна единице). В данном случае поле будет содержать значение второй группировки запроса.
metrics Массив значений метрик для данной строки. Значения этого массива — числа или null.
expand Указывает можно ли раскрыть эту строку на следующий уровень дерева.