Таблица

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

Формат запроса

https://api.appmetrica.yandex.ru/stat/v1/data
 ? ids=<int,int,...>
 & metrics=<string>
 & [accuracy=<string>]
 & [callback=<string>]
 & [date1=<string>]
 & [date2=<string>]
 & [dimensions=<string>]
 & [filters=<string>]
 & [group=<group_type>]
 & [id=<integer>]
 & [include_undefined=<boolean>]
 & [lang=<string>]
 & [limit=<integer>]
 & [offset=<integer>]
 & [pretty=<boolean>]
 & [sort=<string>]
Query-параметры
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, длина строки в фильтре — до 10000 символов.

groupГруппировка данных по времени.

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

Допустимые значения:

  • all — временной интервал не разбивается.
  • hours — временной интервал разбивается на интервалы из нескольких часов.
  • auto — автоматический режим.
  • week — временной интервал разбивается по неделям.
  • month — временной интервал разбивается по месяцам.
  • hour — временной интервал разбивается на часовые интервалы.
  • year — временной интервал разбивается по годам.
  • minutes — временной интервал разбивается на интервалы из некоторого количества минут.
  • day — временной интервал разбивается по дням.
  • dekaminute — временной интервал разбивается на 10-минутные интервалы.
  • quarter — временной интервал разбивается по кварталам.
  • minute — временной интервал разбивается на минутные интервалы.
idИдентификатор счетчика. Устарело, используйте ids.
include_undefinedВключает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.
langЯзык.
limit

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

Лимит: 10000.

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

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

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

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

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

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

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

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


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

Пример запроса

curl -X GET \
  'https://api.appmetrica.yandex.ru/stat/v1/data?ids=1111&metrics=ym:ge:users' \
  -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037'