GetReportList

Возвращает список сформированных и формируемых отчетов о статистике кампании.

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.

Метод используют для проверки готовности отчета с интересующим идентификатором. Также с помощью метода получают идентификатор отчета, чтобы затем удалить отчет с помощью метода DeleteReport.

Ограничения

Вызывать метод рекомендуется не чаще одного раза в 10-20 секунд (формирование отчета занимает в среднем одну-две минуты). Когда отчет готов, метод возвращает ссылку для скачивания файла с сервера.

Входные данные

Ниже показана структура входных данных в формате JSON. Метод не имеет входных параметров.

{
   "method": "GetReportList"
}

Результирующие данные

Метод возвращает массив объектов ReportInfo, каждый из которых содержит сведения об одном отчете. Всего в массиве может присутствовать до пяти объектов. Массив отсортирован по убыванию ReportID.

Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* ReportInfo */
         "ReportID": (int),
         "Url": (string),
         "StatusReport": (string)
      }
      ...
   ]
}

Ниже приведено описание параметров.

Параметр Описание
Объект ReportInfo
ReportID Идентификатор отчета о статистике кампании.
Url Ссылка для скачивания отчета с сервера. Если формирование отчета не завершено, возвращается пустая строка. Отчет доступен по протоколу HTTPS.
StatusReport

Состояние отчета:

  • Done — отчет сформирован;
  • Pending — отчет формируется;
  • Failed — сформировать отчет не удалось.
Параметр Описание
Объект ReportInfo
ReportID Идентификатор отчета о статистике кампании.
Url Ссылка для скачивания отчета с сервера. Если формирование отчета не завершено, возвращается пустая строка. Отчет доступен по протоколу HTTPS.
StatusReport

Состояние отчета:

  • Done — отчет сформирован;
  • Pending — отчет формируется;
  • Failed — сформировать отчет не удалось.