Сравнение - drill down

Внимание.

Передача авторизационного токена в параметрах URL перестанет работать 13 февраля 2019 года. Чтобы продолжить работу с API Метрики, настройте авторизацию по токену в HTTP-заголовке.

23 января, 30 января и 6 февраля 2019 года запланировано профилактическое отключение устаревшего способа авторизации — в эти дни он будет временно отключен.

С помощью данного метода можно комбинировать методы Drill down и Сравнение сегментов. Таким образом позволяет получить данные по ветвям дерева для сравнения сегментов.

Для каждого значения группировки API возвращает два набора метрик. Например, для сегмента A и сегмента B. Для каждого сегмента можно задать разные диапазоны дат и фильтры сегментации.

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

GET https://api-metrika.yandex.net/stat/v1/data/comparison/drilldown
 ? direct_client_logins=<string,_string,...>
 & ids=<int,int,...>
 & metrics=<string>
 & [accuracy=<string>]
 & [callback=<string>]
 & [date1_a=<string>]
 & [date1_b=<string>]
 & [date2_a=<string>]
 & [date2_b=<string>]
 & [dimensions=<string>]
 & [filters=<string>]
 & [filters_a=<string>]
 & [filters_b=<string>]
 & [id=<integer>]
 & [include_undefined=<boolean>]
 & [lang=<string>]
 & [limit=<integer>]
 & [offset=<integer>]
 & [parent_id=<string>]
 & [preset=<string>]
 & [pretty=<boolean>]
 & [proposed_accuracy=<boolean>]
 & [sort=<string>]
 & [timezone=<string>]
Query-параметры
direct_client_logins *Логины клиентов Яндекс.Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.
ids *Идентификаторы счетчиков, через запятую. Используется вместо параметра id.
metrics *

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

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

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

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

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

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

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

date1_b

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

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

date2_a

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

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

date2_b

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

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

dimensions

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

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

filters

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

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

filters_aФильтр сегментации для сегмента A.
filters_bФильтр сегментации для сегмента B.
idИдентификатор счетчика. Устарело, используйте ids.
include_undefinedВключает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.
langЯзык.
limit

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

Лимит: 100000.

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

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

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

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

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

proposed_accuracyЕсли указано значение true, API имеет право автоматически увеличивать accuracy до рекомендованного значения. Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты.
sortСписок группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по убыванию (указан знак «-» перед группировкой или метрикой).Чтобы отсортировать данные по возрастанию, удалите знак «-».
timezone

Часовой пояс в формате ±hh:mm в диапазоне [-23:59; +23:59] (знак плюса нужно передавать как %2B), в котором будут рассчитан период выборки запроса, а также связанные с датой и временем группировки. По умолчанию используется часовой пояс счетчика.

*  Обязательный параметр

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


{
    "total_rows" :  < long > ,
    "total_rows_rounded" :  < boolean > ,
    "sampled" :  < boolean > ,
    "sample_share" :  < double > ,
    "sample_size" :  < long > ,
    "sample_space" :  < long > ,
    "data_lag" :  < int > ,
    "query" : {
        "ids" : [  < int > , ... ],
        "timezone" :  < string > ,
        "preset" :  < string > ,
        "dimensions" : [  < string > , ... ],
        "metrics" : [  < string > , ... ],
        "sort" : [  < string > , ... ],
        "date1_a" :  < string > ,
        "date2_a" :  < string > ,
        "filters_a" :  < string > ,
        "date1_b" :  < string > ,
        "date2_b" :  < string > ,
        "filters_b" :  < string > ,
        "limit" :  < integer > ,
        "offset" :  < integer > 
    },
    "data" : [ {
        "dimension" : {
            "key_1" :  < string > ,
            "key_2" : ...
        },
        "metrics" : {
            "a" : [  < double > , ... ],
            "b" : [  < double > , ... ]
        },
        "expand" :  < boolean > 
    }, ... ],
    "totals" : {
        "a" : [  < double > , ... ],
        "b" : [  < double > , ... ]
    }
}
ПараметрыОписание
total_rowsОбщее количество строк в ответе по всему множеству данных (с учетом фильтра).
total_rows_roundedПризнак того, что общее количество строк было округлено.
sampledПризнак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false.
sample_shareДоля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_sizeКоличество строк в выборке данных.
sample_spaceКоличество строк данных.
data_lagЗадержка в обновлении данных, в секундах.
queryИсходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.
dataСтроки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.
totalsОбщие результаты для метрик по всему множеству данных (с учетом фильтра).
query
idsИдентификаторы счетчиков.
timezoneЧасовой пояс периода выборки в формате ±hh:mm.
presetПресет отчета.
dimensionsМассив группировок.
metricsМассив метрик.
sortМассив сортировок.
date1_aДата начала периода выборки для сегмента A в формате YYYY-MM-DD.
date2_aДата окончания периода выборки для сегмента A в формате YYYY-MM-DD.
filters_aФильтр сегментации для сегмента A.
date1_bДата начала периода выборки для сегмента B в формате YYYY-MM-DD.
date2_bДата окончания периода выборки для сегмента B в формате YYYY-MM-DD.
filters_bФильтр сегментации для сегмента B.
limitКоличество элементов на странице выдачи.
offsetИндекс первой строки выборки, начиная с 1.
data
dimensionЗначение группировки для заданного уровня дерева. Например, задан второй уровень дерева (длина переданного массива parent_id равна единице). В данном случае поле будет содержать значение второй группировки запроса.
metricsЗначения метрик для этой строки, отдельно для левого и правого сегмента
expandУказывает можно ли раскрыть эту строку на следующий уровень дерева.
metrics
aМассив значений метрик для сегмента A.
bМассив значений метрик для сегмента B.
totals
aМассив значений метрик для сегмента A.
bМассив значений метрик для сегмента B.