Запрос на формирование отчета
Одновременно в работе могут находиться не больше 3 отчетов.
Получение отчетов
Для формирования отчета выполните запрос:
https://adfox.yandex.ru/api/report/<level>?name=<report_name>&<arguments>
Параметры запроса
|
Параметр |
Описание |
|
|
Уровень детализации отчета. |
|
|
Название отчета (используется при запросе). Можно узнать с помощью метода list. |
|
|
Аргументы, необходимые для формирования данного отчета, со значениями. Полный список аргументов представлен в разделе Аргументы для построения отчета. |
Чтобы построить отчет по нескольким объектам, передайте список идентификаторов в виде массива JSON. Пример запроса для кампании:
https://adfox.yandex.ru/api/report/campaign?name=days&dateFrom=2022-04-28&dateTo=2022-04-29&campaignId=[1891306,1891313,1891312,1860311]
Формат ответа
Запрос возвращает идентификатор задачи taskId на формирование отчета. Идентификатор задачи нужен для получения готового отчета.
{
"result": {
"taskId": ()
},
"error": <errorCode>
}
Примечание
По полученному taskId можно получать данные в течение часа.
Доступные уровни детализации:
- owner — общий отчет;
- supercampaign — на уровне суперкампании;
- campaign — на уровне кампании;
- banner — на уровне баннера;
- site — на уровне сайта;
- section — на уровне раздела;
- place — на уровне рекламного места.