API-методы статистики v2 позволяют получать различную статистику по рекламным объектам.
Ограничения и фильтры в этих методах задаются с помощью GET-параметров, а не в теле адреса, как это происходит в API v1.
В случае ошибки возвращается ответ вида:
{ "error": { "message": "message_text", "code": "CODE" } } |
HTTP-код | Code | Описание |
400 | ERR_WRONG_PARAMETER | Некорректное значение параметра, либо не указан обязательный параметр |
400 | ERR_LIMIT_EXCEEDED | Превышен лимит запрашиваемых дат или количества объектов |
400 | ERR_WRONG_DATE | Указана некорректная дата |
400 | ERR_WRONG_BANNERS | Запрашиваемые баннеры не существуют или недоступны для данного API-пользователя |
400 | ERR_WRONG_CAMPAIGNS | Запрашиваемые кампании не существуют или недоступны для данного API-пользователя |
400 | ERR_WRONG_USERS | Пользователя не существует или статистика по нему недоступна для данного API-пользователя |
403 | ERR_ACCESS_DENIED | Нет прав для доступа к API-методу |
404 | ERR_WRONG_RESOURCE | API-метода не существует |
500 | ERR_INTERNAL | Внутренняя ошибка сервера |
GET {host}/api/v2/statistics/{banners|campaigns|users}/{day|summary}.json
Ресурс возвращает суммарную за все время открутки или подневную за выбранный период статистику по аккаунтам, кампаниям, баннерам.
Ограничения и фильтры задаются с помощью GET-параметров:
Параметр | Формат | Значение по умолчанию | Описание |
date_from | YYYY-MM-DD | Начальная дата. Только для day.json. | |
date_to | YYYY-MM-DD | Конечная дата (включительно). Только для day.json. | |
id | список идентификаторов, разделенных запятой | Список идентификаторов баннеров, кампаний или пользователей. | |
metrics | список текстовых идентификаторов, разделенных запятой | base | Список наборов метрик. Доступные варианты: all, base, events, video, uniques, tps, playable, romi. |
attribution | impression | default | атрибуцировать по времени события, времени показа. Игнорируется для summary |
Все параметры кроме metrics являются обязательными.
В одном запросе можно получить как все статистические метрики, так и конкретные наборы.
Структура ответа:
Пример запроса:
GET {host}/api/v3/statistics/{banners|campaigns|users}/day.json
Ресурс возвращает суммарную статистику за выбранный период по аккаунтам, кампаниям, баннерам с пагинацией.
Ограничения и фильтры задаются с помощью GET-параметров:
Параметр | Формат | Значение по умолчанию | Описание |
date_from | YYYY-MM-DD | Начальная дата. | |
date_to | YYYY-MM-DD | Текущая дата | Конечная дата (включительно). |
id | список идентификаторов, разделенных запятой | Список идентификаторов баннеров, кампаний или пользователей. | |
id_ne | список идентификаторов, разделенных запятой | Список идентификаторов баннеров, кампаний или пользователей с отрицанием. | |
fields | список запрашиваемых метрик или полей в формате метрика или метрика.название_поля разделенные запятой | base | Список наборов метрик. Доступные метрики: all, base, events, uniques, video, carousel, tps, moat, playable, romi. |
attribution | impression | conversion | Атрибуцировать по времени события, времени показа. Доступные варианты: conversion, impression |
banner_status | список статусов, разделенных запятой. Доступные варианты: all, active, blocked, deleted. | all | Список статусов баннеров, доступен для статистики по кампаниям и баннерам. |
banner_status_ne | список статусов, разделенных запятой. Доступные варианты: all, active, blocked, deleted. | all | Список статусов баннеров с отрицанием, доступен для статистики по кампаниям и баннерам. |
campaign_status | список статусов, разделенных запятой. Доступные варианты: all, active, blocked, deleted. | all | Список статусов кампаний, доступен для статистики по кампаниям и баннерам. |
campaign_status_ne | список статусов, разделенных запятой. Доступные варианты: all, active, blocked, deleted. | all | Список статусов кампаний с отрицанием. Доступен для статистики по кампаниям и баннерам. |
campaign_id | список идентификаторов, разделенных запятой | Список идентификаторов кампаний. Доступен для статистики по баннерам. | |
campaign_id_ne | список идентификаторов, разделенных запятой | Список идентификаторов кампаний с отрицанием. Доступен для статистики по баннерам. | |
package_id | список идентификаторов, разделенных запятой | Список идентификаторов пакетов. Доступен для статистики по баннерам. | |
package_id_ne | список идентификаторов, разделенных запятой | Список идентификаторов пакетов с отрицанием. Доступен для статистики по кампаниям и баннерам. | |
sort_by | поле в формате метрика.название_поля | Поле по которому будут сортироваться идентификаторы кампаний, баннеров или пользователей. Доступные метрики: base, events, video, carousel, tps, moat, playable, romi. | |
d | строковое поле | asc | Направление сортировки. Доступные варианты: asc, desc |
limit | целое число от 1 до 250 | 20 | Количество отдаваемых объектов. |
offset | целое число | 0 | Смещение. |
Параметр date_from является обязательными.
В одном запросе можно получить как все статистические метрики, так и конкретные наборы.
Структура ответа:
Пример запроса:
GET {host}/api/v2/statistics/goals/{banners|campaigns|users}/day.json
Ресурс возвращает статистику по конверсиям Top@Mail.ru и установкам мобильных приложений по кампаниям и баннерам в разрешении 1 день.
Ограничения и фильтры задаются с помощью GET-параметров:
Параметр | Формат | Описание |
date_from | YYYY-MM-DD | Начальная дата |
date_to | YYYY-MM-DD | Конечная дата (включительно) |
id | список идентификаторов, разделенных запятой | Список идентификаторов баннеров или кампаний |
attribution | impression | Атрибуцировать по времени события, времени показа |
conversion_type | postview, postclick, total или их комбинации разделенные через запятую | Тип конверсии: postclick - постклик, postview - поствью, total - суммарно |
Все параметры являются обязательными.
Структура ответа:
Пример запроса:
GET {host}/api/v2/statistics/inapp/{banners|campaigns|users}/day.json
Ресурс возвращает статистику по аттрибуцированным с рекламными показами myTarget событиями мобильных приложений по кампаниям и баннерам в разрешении 1 день.
Ограничения и фильтры задаются с помощью GET-параметров:
Параметр | Формат | Описание |
date_from | YYYY-MM-DD | Начальная дата |
date_to | YYYY-MM-DD | Конечная дата (включительно) |
id | список идентификаторов, разделенных запятой | Список идентификаторов пользователей, баннеров или кампаний |
attribution | impression | Атрибуцировать по времени события, времени показа |
conversion_type | postview, postclick, total или их комбинации разделенные через запятую | Тип конверсии: postclick - постклик, postview - поствью, total - суммарно |
Все параметры являются обязательными.
Структура ответа:
Пример запроса:
Ресурс возвращает статистику по аттрибуцированным с рекламными показами myTarget событиями из списков оффлайн конверсий по кампаниям в разрешении 1 день.
GET api/v2/statistics/offline_conversions/campaigns/day.json
Параметр | Формат | Описание |
date_from | YYYY-MM-DD | Начальная дата |
date_to | YYYY-MM-DD | Конечная дата (включительно) |
id | список идентификаторов, разделенных запятой | Список идентификаторов кампаний |
Фильтры даты учитывают дату события, к которой атрибутирована конверсия
Параметры ответа:
"rate" conversion rate = пользователи, которые сконвертировались и видели РК / все пользователи, видевшие РК
в процентах
"cost" фактическая стоимость привлечения = стоимость РК / пользователи, которые сконвертировались и видели рекламу
"offline" Количество конверсий
GET {host}/api/v2/statistics/faststat/{banners|campaigns|users}.json
Ресурс возвращает базовую статистику по рекламным объектам в режиме реального времени, без учёта фильтрации некорректного траффика. Значения в итоговой статистике могут значительно отличаться.
Ограничения и фильтры задаются с помощью GET-параметров:
Параметр | Формат | Описание |
id | список идентификаторов, разделенных запятой | Список идентификаторов баннеров или кампаний |
Все параметры являются обязательными.
Структура ответа:
Пример запроса:
"