Получение данных по времени

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

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

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

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

https://api-metrika.yandex.ru/stat/v1/data/bytime
 ? [direct_client_logins=<string,_string,...>]
 & [ids=<int,int,...>]
 & [metrics=<string>]
 & [accuracy=<string>]
 & [annotation_groups=<list>]
 & [callback=<string>]
 & [date1=<string>]
 & [date2=<string>]
 & [dimensions=<string>]
 & [filters=<string>]
 & [group=<group_type>]
 & [id=<integer>]
 & [include_annotations=<boolean>]
 & [include_undefined=<boolean>]
 & [lang=<string>]
 & [preset=<string>]
 & [pretty=<boolean>]
 & [proposed_accuracy=<boolean>]
 & [row_ids=<list>]
 & [timezone=<string>]
 & [top_keys=<integer>]
direct_client_logins Логины клиентов Яндекс.Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.
ids Идентификаторы счетчиков, через запятую. Используется вместо параметра id.
metrics

Список метрик, разделенных запятой.

Лимит: 20 метрик в запросе.

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

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

annotation_groups Группы примечаний, разделенные запятой, которые должны вернуться в ответе. Передается, если параметр include_annotations принимает значение true.Если параметр annotation_groups не указан, в ответе вернутся все примечания, созданные для счетчика.
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_annotations Признак включения в ответ примечания. По умолчанию выключено.

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

include_undefined Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.
lang Язык.
preset Шаблон отчета.
pretty Задает форматирование результата. Чтобы использовать форматирование, укажите значение true.

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

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

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

top_keys

Задает количество строк результата, если не указан параметр row_ids.

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

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


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