Введение
API отчетов позволяет получать информацию о статистике кампаний, не используя интерфейс Яндекс Метрики для медийной рекламы. Доступно в рамках Метрики Про.
При формировании запроса к API используются группировки (dimensions) и метрики (metrics).
Группировка (dimension) — это атрибут просмотра или клика, по которому можно сгруппировать данные.
В запросах к API группировки задаются в параметре dimensions. Если необходимо указать несколько группировок, перечислите их через запятую.
Также возможен отчет без группировок, в этом случае будет рассчитан суммарный результат.
Метрика (metric) — числовая величина, которая рассчитывается на основе атрибута просмотра или клика.
В запросах к API метрики задаются в параметре metrics. Если необходимо указать несколько метрик, перечислите их через запятую.
Подробно о терминах
Предлагаем подробнее узнать о понятиях «группировка» и «метрика» на примере отчета по типу устройств:
|
Тип устройства |
Количество показов |
|
Смартфон |
2523 |
|
Планшет |
1052 |
|
Ноутбук |
1521 |
Где:
-
Тип устройства — атрибут взаимодействия пользователя, по которому сгруппированы данные отчета (группировка).
-
Количество показов — значение, рассчитанное на основе числовых атрибутов показов (метрика), соответствующее указанному группировке.
Примечание
Если вы знакомы с языком SQL, измерения можно представить как колонки, по которым происходит группировка, а метрики — как результаты вычисления агрегатных функций.
Метрики и группировки, указанные в запросе к API, позволяют формировать необходимую вам структуру отчета.
Например, чтобы получить отчет по количеству показов рекламы с группировкой по типу устройств, используйте такой запрос:
https://api.media.metrika.yandex.net/v1/stat/data?ids=12345&metrics=am:e:renders&dimensions=am:e:deviceType&limit=5
Виды отчетов
Полученные данные могут быть представлены в следующих формах:
Все уровни отчета и метрики представлены в виде таблицы.
Чтобы отображать данные в виде таблицы, используйте метод /v1/stat/data.
Формирование одной ветви древовидного отчета.
Чтобы сформировать ветвь, используйте метод /v1/stat/data/drilldown.
Данные представлены с разбивкой по времени (например, по дням, неделям и месяцам). Форма удобна для построения графиков и отслеживания динамики.
Используйте метод /v1/stat/data/bytime.
Формат отчетов
API возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON или CSV.
Формат указывается в запросе после пути URL:
GET https://api.media.metrika.yandex.net/v1/stat/data.csv?<ids>&<metrics>&<dimensions>
Так как формат JSON является форматом, принятым по умолчанию, его можно не указывать:
GET https://api.media.metrika.yandex.net/v1/stat/data?<ids>&<metrics>&<dimensions>