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

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

Request

GET

https://api-metrika.yandex.net/stat/v1/data/comparison/drilldown

Query parameters

Name

Description

ids*

Type: integer<int32>[]

Идентификаторы счетчиков, через запятую.
Example: 44147844,2215573

metrics*

Type: string

Список метрик, разделенных запятой. Лимит: 20 метрик в запросе.
Example: ym:s:pageviews

accuracy

Type: string

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

callback

Type: string

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

date1

Type: string

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

Default: 6daysAgo

date1_a

Type: string

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

Default: 6daysAgo

Min length: 1

date1_b

Type: string

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

Default: 6daysAgo

Min length: 1

date2

Type: string

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

Default: today

date2_a

Type: string

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

Default: today

Min length: 1

date2_b

Type: string

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

Default: today

Min length: 1

dimensions

Type: string

Список группировок, разделенных запятой. Лимит: 10 группировок в запросе.
Example: ym:s:trafficSource

direct_client_logins

Type: string[]

Логины клиентов Яндекс Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.
Example: login1,login2

filters

Type: string

Фильтр сегментации. Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10 000 символов; количество значений в одном условии фильтрации — 100.

filters_a

Type: string

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

filters_b

Type: string

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

include_undefined

Type: boolean

Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.

lang

Type: string

Язык.

limit

Type: string

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

Default: 100

Min value: 0

offset

Type: string

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

Default: 1

Min value: 1

only_expandable_undefined

Type: boolean

Удалять из результата нераскрывающиеся неопределённые значения. Имеет смысл только в случае include_undefined=true.

parent_id

Type: string[]

Выбор строки для дальнейшего развертывания. Состоит из json-списка ключей.

preset

Type: string

Шаблон отчета.
Example: sources_summary

pretty

Type: string

Задает форматирование результата. Чтобы использовать форматирование, укажите значение true.

Default: false

proposed_accuracy

Type: boolean

Если параметр выставлен в true, API имеет право автоматически увеличивать accuracy до рекомендованного значения.Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты.

sort

Type: string

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

timezone

Type: string

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

Responses

200 OK

OK

Body

application/json
{
    "query": {
        "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": 0,
        "offset": 0
    },
    "data": [
        {
            "dimension": [
                {}
            ],
            "metrics": {
                "a": [
                    0
                ],
                "b": [
                    0
                ]
            },
            "expand": false
        }
    ],
    "total_rows": 0,
    "total_rows_rounded": false,
    "sampled": false,
    "contains_sensitive_data": false,
    "sample_share": 0,
    "sample_size": 0,
    "sample_space": 0,
    "data_lag": 0,
    "totals": {
        "a": [
            0
        ],
        "b": [
            0
        ]
    }
}

Name

Description

contains_sensitive_data

Type: boolean

Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении true в ответе не отобразятся такие данные, если выборка составляет меньше 10 посетителей. Возможные значения: true, false.

data

Type: ComparisonRowDrillDownAB[]

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

data_lag

Type: integer<int32>

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

query

Type: ComparisonQueryAB

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

sample_share

Type: number<double>

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

sample_size

Type: integer<int64>

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

sample_space

Type: integer<int64>

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

sampled

Type: boolean

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

total_rows

Type: integer<int64>

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

total_rows_rounded

Type: boolean

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

totals

Type: ComparisonDataAB

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

ComparisonRowDrillDownAB

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

Name

Description

dimension

Type: object[]

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

expand

Type: boolean

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

metrics

Type: ComparisonDataAB

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

ComparisonQueryAB

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

Name

Description

date1_a

Type: string

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

date1_b

Type: string

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

date2_a

Type: string

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

date2_b

Type: string

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

dimensions

Type: string[]

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

filters_a

Type: string

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

filters_b

Type: string

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

limit

Type: integer<int32>

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

metrics

Type: string[]

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

offset

Type: integer<int32>

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

preset

Type: string

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

sort

Type: string[]

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

timezone

Type: string

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

ComparisonDataAB

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

Name

Description

a

Type: number<double>[]

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

b

Type: number<double>[]

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

No longer supported, please use an alternative and newer version.

Предыдущая
Сравнение сегментов
Следующая
Получение данных по времени