Введение

Сервис предназначен для получения статистики администраторами аккаунтов, ассистентами и рекламодателями.

Примечание

Статистика в отчетах показывается по московскому времени (UTC +3).

Запрос на формирование отчета следует передавать по протоколу HTTPS методом GET.

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

Адрес для запроса

https://adfox.yandex.ru/api/report/<method>/<level>?[methodArguments]

Параметр

Описание

method

Метод для получения информации по отчету.

level

Уровень детализации отчета.

methodArguments

Параметры для аргументов метода.

Примечание

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

Пример адреса для запроса:

https://adfox.yandex.ru/api/report/date/interval/owner?name=days&ownerId=50242

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

Ответ на запрос приходит в формате JSON:

{
  result: <result>
  error: <error>
}

Параметр

Тип

Описание

result

int

Числовой код ошибки.

error

string

Если запрос выполнен успешно, это пустое поле. Если произошла ошибка — соответствующий код.

Лимиты количества запросов

Для запросов на формирование отчета действуют ограничения по количеству — не более:

  • 100 запросов в минуту;

  • 3 запросов одновременно для одного владельца аккаунта.

После того, как отчеты будут готовы ("state": SUCCESS), можно отправлять новые запросы.

Срок хранения данных для отчетов — 3 года.