Получение данных по времени
Позволяет получить данные с разбивкой по времени (например, по дням, неделям, месяцам). Используйте данный тип запроса для построения графиков и отслеживания динамики.
Посмотрите как используется данный запрос в примере.
Синтаксис запроса
https://api-metrika.yandex.net/stat/v1/data/bytime
? ids=<int,int,...>
& metrics=<string>
& [accuracy=<string>]
& [annotation_groups=<list>]
& [callback=<string>]
& [date1=<string>]
& [date2=<string>]
& [dimensions=<string>]
& [direct_client_logins=<string,_string,...>]
& [filters=<string>]
& [group=<group_type>]
& [include_annotations=<boolean>]
& [include_undefined=<boolean>]
& [keys_sort=<string>]
& [lang=<string>]
& [preset=<string>]
& [pretty=<boolean>]
& [proposed_accuracy=<boolean>]
& [row_ids=<list>]
& [timezone=<string>]
& [top_keys=<integer>]ids * | Идентификаторы счетчиков, через запятую. Используется вместо параметра id. |
metrics * | Список метрик, разделенных запятой. Лимит: 20 метрик в запросе. |
accuracy | Размер выборки, используемой для отчета. Позволяет управлять семплированием (количеством визитов, использованных при расчете итогового значения). Значение по умолчанию: medium |
annotation_groups | Группы примечаний, разделенные запятой, которые должны вернуться в ответе. Передается, если параметр include_annotations принимает значение true Если параметр annotation_groups не указан, в ответе вернутся все примечания, созданные для счетчика. Допустимые значения:
|
callback | Функция обратного вызова, которая обрабатывает ответ API. |
date1 | Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: Значение по умолчанию: |
date2 | Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: Значение по умолчанию: |
dimensions | Список группировок, разделенных запятой. Лимит: 10 группировок в запросе. |
direct_client_logins | Логины клиентов Яндекс Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы. |
filters | Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10 000 символов; количество значений в одном условии фильтрации — 100. |
group | Группировка данных по времени. Значение по умолчанию: week Допустимые значения:
|
include_annotations | Признак включения в ответ примечания. По умолчанию выключено. Значение по умолчанию: false |
include_undefined | Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено. |
keys_sort | Список группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по убыванию (указан знак «-» перед группировкой или метрикой). Чтобы отсортировать данные по возрастанию, удалите знак «-». |
lang | Язык. |
preset | Шаблон отчета. |
pretty | Задает форматирование результата. Чтобы использовать форматирование, укажите значение true. Значение по умолчанию: |
proposed_accuracy | Если параметр выставлен в true, API имеет право автоматически увеличивать accuracy до рекомендованного значения.Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты. |
row_ids | Выбор строк для построения графиков. Содержит перечисление списков ключей. |
timezone | Часовой пояс в формате ±hh:mm в диапазоне [-23:59; +23:59] (знак плюса нужно нужно передавать как |
top_keys | Задает количество строк результата, если не указан параметр Значение по умолчанию: 7 |
ids * | Идентификаторы счетчиков, через запятую. Используется вместо параметра id. |
metrics * | Список метрик, разделенных запятой. Лимит: 20 метрик в запросе. |
accuracy | Размер выборки, используемой для отчета. Позволяет управлять семплированием (количеством визитов, использованных при расчете итогового значения). Значение по умолчанию: medium |
annotation_groups | Группы примечаний, разделенные запятой, которые должны вернуться в ответе. Передается, если параметр include_annotations принимает значение true Если параметр annotation_groups не указан, в ответе вернутся все примечания, созданные для счетчика. Допустимые значения:
|
callback | Функция обратного вызова, которая обрабатывает ответ API. |
date1 | Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: Значение по умолчанию: |
date2 | Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: Значение по умолчанию: |
dimensions | Список группировок, разделенных запятой. Лимит: 10 группировок в запросе. |
direct_client_logins | Логины клиентов Яндекс Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы. |
filters | Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10 000 символов; количество значений в одном условии фильтрации — 100. |
group | Группировка данных по времени. Значение по умолчанию: week Допустимые значения:
|
include_annotations | Признак включения в ответ примечания. По умолчанию выключено. Значение по умолчанию: false |
include_undefined | Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено. |
keys_sort | Список группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по убыванию (указан знак «-» перед группировкой или метрикой). Чтобы отсортировать данные по возрастанию, удалите знак «-». |
lang | Язык. |
preset | Шаблон отчета. |
pretty | Задает форматирование результата. Чтобы использовать форматирование, укажите значение true. Значение по умолчанию: |
proposed_accuracy | Если параметр выставлен в true, API имеет право автоматически увеличивать accuracy до рекомендованного значения.Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты. |
row_ids | Выбор строк для построения графиков. Содержит перечисление списков ключей. |
timezone | Часовой пояс в формате ±hh:mm в диапазоне [-23:59; +23:59] (знак плюса нужно нужно передавать как |
top_keys | Задает количество строк результата, если не указан параметр Значение по умолчанию: 7 |
* Обязательный параметр
Пример запроса
https://api-metrika.yandex.net/stat/v1/data/bytime?ids=44147844%2C2215573&metrics=ym%3As%3Apageviews
Формат ответа
{
"total_rows" : < long > ,
"total_rows_rounded" : < boolean > ,
"sampled" : < boolean > ,
"contains_sensitive_data" : < boolean > ,
"sample_share" : < double > ,
"sample_size" : < long > ,
"sample_space" : < long > ,
"data_lag" : < int > ,
"query" : {
"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" : [ [ {
"id" : < int > ,
"date" : < local_date > ,
"time" : < local_time > ,
"title" : < string > ,
"message" : < string > ,
"group" : < chart_annotation_group >
}, ... ], ... ]
}
| Параметры | Описание |
|---|---|
| total_rows | Общее количество строк в ответе по всему множеству данных (с учетом фильтра). |
| total_rows_rounded | Признак того, что общее количество строк было округлено. |
| sampled | Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false. |
| contains_sensitive_data | Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении Возможные значения: |
| sample_share | Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1. |
| sample_size | Количество строк в выборке данных. |
| sample_space | Количество строк данных. |
| data_lag | Задержка в обновлении данных, в секундах. |
| query | Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов. |
| data | Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата. |
| totals | Общие результаты для метрик по всему множеству данных (с учетом фильтра). |
| annotations | Примечания. |
| query | |
| timezone | Часовой пояс периода выборки в формате ±hh:mm. |
| preset | Пресет отчета. |
| dimensions | Массив группировок. |
| metrics | Массив метрик. |
| sort | Массив сортировок. |
| date1 | Дата начала периода выборки в формате YYYY-MM-DD. |
| date2 | Дата окончания периода выборки в формате YYYY-MM-DD. |
| filters | Фильтр сегментации. |
| data | |
| dimensions | Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id. |
| metrics | Массив массивов значений метрик для данной строки. Внешний массив перечисляет метрики, внутренние массивы — значения конкретной метрики для каждой временной группы. |
| annotations | |
| id | Идентификатор примечания. |
| date | Дата. |
| time | Время. |
| title | Заголовок. |
| message | Описание. |
| group | Группа. Возможные значения:
|
| Параметры | Описание |
|---|---|
| total_rows | Общее количество строк в ответе по всему множеству данных (с учетом фильтра). |
| total_rows_rounded | Признак того, что общее количество строк было округлено. |
| sampled | Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: true, false. |
| contains_sensitive_data | Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении Возможные значения: |
| sample_share | Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1. |
| sample_size | Количество строк в выборке данных. |
| sample_space | Количество строк данных. |
| data_lag | Задержка в обновлении данных, в секундах. |
| query | Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов. |
| data | Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата. |
| totals | Общие результаты для метрик по всему множеству данных (с учетом фильтра). |
| annotations | Примечания. |
| query | |
| timezone | Часовой пояс периода выборки в формате ±hh:mm. |
| preset | Пресет отчета. |
| dimensions | Массив группировок. |
| metrics | Массив метрик. |
| sort | Массив сортировок. |
| date1 | Дата начала периода выборки в формате YYYY-MM-DD. |
| date2 | Дата окончания периода выборки в формате YYYY-MM-DD. |
| filters | Фильтр сегментации. |
| data | |
| dimensions | Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id. |
| metrics | Массив массивов значений метрик для данной строки. Внешний массив перечисляет метрики, внутренние массивы — значения конкретной метрики для каждой временной группы. |
| annotations | |
| id | Идентификатор примечания. |
| date | Дата. |
| time | Время. |
| title | Заголовок. |
| message | Описание. |
| group | Группа. Возможные значения:
|