Сравнение сегментов

Позволяет сравнить два сегмента данных, указанные в запросе. Сегменты идентифицируются как сегмент А и сегмент B. Для каждого сегмента можно задать разные диапазоны дат и фильтры сегментации. Данные будут представлены в виде таблицы.

Для каждой строки отчета возвращается два набора метрик: метрики сегмента А и метрики сегмента B.

Посмотрите как используется данный запрос в примере.

  1. Синтаксис запроса
  2. Формат ответа

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

https://api-metrika.yandex.ru/stat/v1/data/comparison
 ? [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=<int>]
 & [offset=<int>]
 & [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

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" : [ {
        "dimensions" : [ {
            "key_1" :  < string > ,
            "key_2" : ...
        }, ... ],
        "metrics" : {
            "a" : [  < double > , ... ],
            "b" : [  < double > , ... ]
        }
    }, ... ],
    "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
dimensions Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id.
metrics Значения метрик для этой строки, отдельно для сегментов A и B.
metrics
a Массив значений метрик для сегмента A.
b Массив значений метрик для сегмента B.
totals
a Массив значений метрик для сегмента A.
b Массив значений метрик для сегмента B.