Создать отчет

Создает отчет по кампании, публикации или обложке. Срок хранения отчетов 30 дней, но не более 1000 последних отчетов.

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

Параметры необходимо указывать в параметрах запроса в формате json. Данные передаются в кодировке UTF-8.

Формат запроса

POST https://promopages.yandex.ru/api/promo/v1/reports/campaigns-daily-stats
POST https://promopages.yandex.ru/api/promo/v1/reports/campaigns-publications-daily-stats
POST https://promopages.yandex.ru/api/promo/v1/reports/campaigns-previews-daily-stats

Формат тела запроса

Для всех трех типов отчетов доступны следующие параметры:

{
  "publisherId": {string},
  "campaignIds": {array},
  "mskDateFrom": {string},
  "mskDateTo": {string},
  "trafficSource": {string}
}

Параметр

Тип

Описание

Обязательный

publisherId

string

Идентификатор канала.

Да

campaignIds

Array[]

Идентификатор кампаний, передается массивом.

Да

mskDateFrom

string

Дата начала кампаний в формате «YYYY-MM-DD».

Нет

mskDateTo

string

Дата окончания кампаний в формате «YYYY-MM-DD».

Нет

trafficSource

string

Тип отчета. Можно указать только один из вариантов:

  • total — общий отчет по всем источникам;

  • ya_search — отчет по Поиску ;

  • rsya — отчет по РСЯ.

Если параметр не передается в теле запроса, то по умолчанию создается отчет с типом total.

Нет

Если запрос отправлен успешно, в ответе вернется json-объект с полем reportId внутри.