Запросить формирование отчета
Метод для запроса на формирование отчета по reportName.
В отличие от POST /api/v2/reports в теле не принимаются dimensions, metrics, filters: они берутся из конфигурации отчета.
POST /api/v2/reports/{reportName}
|
Характеристика |
Значение |
|
Метод |
|
|
Путь |
|
|
Заголовки |
|
|
Успех |
|
Параметры
|
Поле |
Тип |
Обязательность |
Описание |
|
|
|
Да |
Период отчета. Поля |
|
|
|
Да |
Доступные уровни отчета:
|
|
|
|
Да |
|
|
|
|
Опционально |
Идентификатор объекта уровня (для |
|
|
|
Опционален для администратора / ассистента, обязателен для рекламодателя / владельца сайта. |
Аккаунт администратора (см. раздел Авторизация). |
Поведение по reportName:
- если
reportNameсовпадает с одним из предзаданных названий отчета — запускается предзаданный отчет; - если
reportNameимеет формуcustom_<id>и принадлежит пользователю — запускается сохраненный отчет; levelиobjectIdиз тела игнорируются (для конструктора всегдаOWNER);- иначе возвращается
404 REPORT_NOT_FOUND.
Объект dateRange
|
Поле |
Тип |
Описание |
|
|
string |
Обязательно, не пусто: дата |
|
|
string |
Должно выполняться |
Пример запроса
curl --request POST \
--url https://adfox.yandex.ru/api/v2/reports/custom_1809 \
--header 'authorization: OAuth y0_AgAA***' \
--header 'content-type: application/json' \
--data '{
"dateRange": {
"from": "2026-01-01",
"to": "2026-05-31"
},
"level": "owner"
}'
Успешный ответ (200 OK)
{
"result": {
"taskId": "umr-a-rsr-b5555555-…",
"status": "PENDING"
}
}
Дальнейший процесс:
- Получение статуса отчета.
- Получение результата отчета.