Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

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

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

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

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

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

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

GET https://api-metrika.yandex.ru/stat/v1/data/comparison ? 
direct_client_logins
[no-highlight[Логины клиентов Яндекс.Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.]no-highlight]
=<string,_string,...> & 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_a
[no-highlight[

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

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

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

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

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

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

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

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

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

Дата окончания периода выборки для сегмента B в формате 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>] & [filters_a
[no-highlight[Фильтр сегментации для сегмента A.]no-highlight]
=<string>] & [filters_b
[no-highlight[Фильтр сегментации для сегмента B.]no-highlight]
=<string>] & [id
[no-highlight[Идентификатор счетчика. Устарело, используйте ids.]no-highlight]
=<integer>] & [include_undefined
[no-highlight[Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.]no-highlight]
=<boolean>] & [lang
[no-highlight[Язык.]no-highlight]
=<string>] & [limit
[no-highlight[

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

Лимит: 100000.

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

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

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

]no-highlight]
=<integer>] & [preset
[no-highlight[Шаблон отчета.]no-highlight]
=<string>] & [pretty
[no-highlight[Задает форматирование результата. Чтобы использовать форматирование, укажите значение true.

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

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

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

]no-highlight]
=<string>]
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
[no-highlight[

Описание

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

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

Описание

Признак того, что общее количество строк было округлено.

]no-highlight]
" : < boolean > , "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 > , ... ], "timezone
[no-highlight[

Описание

Часовой пояс периода выборки в формате ±hh:mm.

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

Описание

Пресет отчета.

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

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

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

Описание

Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id.

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

Описание

Значения метрик для этой строки, отдельно для сегментов A и B.

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

Описание

Массив значений метрик для сегмента A.

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

Описание

Массив значений метрик для сегмента B.

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

Описание

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

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

Описание

Массив значений метрик для сегмента A.

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

Описание

Массив значений метрик для сегмента B.

]no-highlight]
" : [ < 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.