Получение готового отчета

Для получения отчета выполните запрос:

https://adfox.yandex.ru/api/report/result?taskId=<taskId>

Параметры запроса

Параметр

Описание

taskId

Идентификатор задачи на формирование запроса.

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

Запрос возвращает готовый отчет. Отчет формируется в формате JSON:

{
  "result": {
      "taskId": ()
      "state": ()
      "fields": [
          <fieldId>,
          ...
      ],
      "fieldsInfo": {
          <filedId>: <fieldInfo>
      },
      "table": [
          [
              <dataRowField>,
              ...
          ],
          ...
      ],
      "totals": {
          <fieldId>: <totalValue>,
          ...
      },
      "eventHorizon": <eventHorizon> 
  },
  "error": <errorCode>
}

Параметр

Описание

state

Готовность отчета в момент запроса:

  • PENDING — ожидает начала формирования;
  • STARTED — отчет формируется;
  • SUCCESS — отчет готов.

fieldId

Идентификатор поля данных. Порядок идентификаторов полей в массиве fields соответствует порядку в массиве с данными table.

fieldInfo

Описание содержимого поля данных.

dataRowField

Данные отчета.

totalValue

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

eventHorizon

День отчетного периода, до которого данные отчета гарантированно полные, в формате YYYY-MM-DD hh:ii:ss.