Таблица

Внимание.

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

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

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

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

GET https://api-metrika.yandex.net/stat/v1/data
 ? direct_client_logins=<string,_string,...>
 & ids=<int,int,...>
 & metrics=<string>
 & [accuracy=<string>]
 & [callback=<string>]
 & [date1=<string>]
 & [date2=<string>]
 & [dimensions=<string>]
 & [filters=<string>]
 & [id=<integer>]
 & [include_undefined=<boolean>]
 & [lang=<string>]
 & [limit=<integer>]
 & [offset=<integer>]
 & [preset=<string>]
 & [pretty=<boolean>]
 & [proposed_accuracy=<boolean>]
 & [sort=<string>]
 & [timezone=<string>]
Query-параметры
direct_client_logins *Логины клиентов Яндекс.Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.
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, длина строки в фильтре — до 10 000 символов.

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

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

Лимит: 10 0000.

Значение по умолчанию: 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" :  < string > ,
        "date2" :  < string > ,
        "filters" :  < string > ,
        "limit" :  < integer > ,
        "offset" :  < integer > 
    },
    "totals" : [  < double > , ... ],
    "min" : [  < double > , ... ],
    "max" : [  < double > , ... ],
    "data" : [ {
        "dimensions" : [ {
            "key_1" :  < string > ,
            "key_2" : ...
        }, ... ],
        "metrics" : [  < double > , ... ]
    }, ... ]
}
ПараметрыОписание
total_rowsОбщее количество строк в ответе по всему множеству данных (с учетом фильтра).
total_rows_roundedПризнак того, что общее количество строк было округлено.
sampledПризнак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false.
sample_shareДоля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_sizeКоличество строк в выборке данных.
sample_spaceКоличество строк данных.
data_lagЗадержка в обновлении данных, в секундах.
queryИсходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.
totalsОбщие результаты для метрик по всему множеству данных (с учетом фильтра).
minМинимальные результаты для метрик среди попавших в выдачу ключей.
maxМаксимальные результаты для метрик среди попавших в выдачу ключей.
dataСтроки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.
query
idsИдентификаторы счетчиков.
timezoneЧасовой пояс периода выборки в формате ±hh:mm.
presetПресет отчета.
dimensionsМассив группировок.
metricsМассив метрик.
sortМассив сортировок.
date1Дата начала периода выборки в формате YYYY-MM-DD.
date2Дата окончания периода выборки в формате YYYY-MM-DD.
filtersФильтр сегментации.
limitКоличество элементов на странице выдачи.
offsetИндекс первой строки выборки, начиная с 1.
data
dimensionsМассив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id.
metricsМассив значений метрик для данной строки. Значения этого массива — числа или null.