Введение
REST API предназначено для получения статистики администраторами аккаунтов, ассистентами и рекламодателями.
Примечание
Статистика в отчетах показывается по московскому времени (UTC +3).
Базовый адрес
https://adfox.yandex.ru/api/v2/reports
Формат запросов и ответов
Параметры:
- Формат данных: JSON
- Кодировка: UTF-8
Запрос на формирование отчета следует передавать по протоколу HTTPS методом GET или POST.
Для POST-запросов обязателен заголовок:
Content-Type: application/json
Успешный ответ всегда обернут в поле result:
{
"result": { ... }
}
При ошибке (если сработала бизнес-логика API: валидация, «задача не найдена», «отчет не готов» и т. д.) возвращается поле error:
{
"error": {
"code": "UNKNOWN_METRIC",
"message": "Unknown metric: impressions_xxx"
}
}
|
Поле |
Тип |
Описание |
|
|
|
Всегда присутствует при такой ошибке. |
|
|
|
Машинное имя кода (латиница, |
|
|
|
Пояснение на английском. |
HTTP-статус согласован с error.code (см. раздел Коды ошибок).
Для одного и того же HTTP-статуса возможны разные code.
Ограничения
|
Параметр |
Значение |
|
Максимальный период для запроса отчета |
365 дней |
|
Максимум строк в результате |
1 000 000 |
|
Максимум группировок в запросе |
10 |
|
Максимум метрик в запросе |
10 |
|
Максимум фильтров в запросе |
10 |
Лимиты количества запросов
Примечание
Срок хранения данных для отчетов — 3 года.
Для запросов на формирование отчета действуют ограничения по количеству — не более:
- 100 запросов в минуту;
- 3 запроса одновременно для одного владельца аккаунта.
После того, как отчеты будут готовы ("status": SUCCESS), можно отправлять новые запросы.