Получить отчет

Возвращает таблицу готового отчета.

GET /api/v2/reports/{taskId}/result

Параметры

Параметр

Описание

taskId

path, строка — значение из result.taskId ответа POST (например umr-a-rsr-…).

Успешный ответ (HTTP 200)

Поле

Тип

Описание

result

object

result.taskId

string

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

result.columns

array

Описание колонок слева направо.

result.rows

array of array

Строки таблицы; каждая строка — массив ячеек в порядке columns.

result.totals

array

Итоговые значения по метрикам (порядок соответствует порядку метрик в ответе; тип элементов — число / строка / null в зависимости от данных).

Элемент result.columns[]

Поле

Тип

Описание

name

string

Идентификатор колонки (поле данных).

type

string

Одно из: string, integer, number.

format

string

Для чисел с плавающей точкой может быть float.

unit

string

Например percent для процентных метрик.

Ячейки result.rows — JSON-скаляры или null, без вложенных объектов в стандартном случае.

Пример запроса

curl -H 'Authorization: OAuth <токен>' \
  'https://adfox.yandex.ru/api/v2/reports/umr-a-rsr-b5555555-5555-5555-5555-555555555501/result'

Пример ответа (HTTP 200)

{
  "result": {
    "taskId": "umr-a-rsr-b5555555-5555-5555-5555-555555555501",
    "columns": [
      { "name": "date", "type": "string" },
      { "name": "campaign_id", "type": "integer" },
      { "name": "loads_commercial", "type": "integer" },
      { "name": "clicks_total", "type": "integer" },
      { "name": "ctr", "type": "number", "format": "float", "unit": "percent" }
    ],
    "rows": [
      ["2024-01-01", 12345, 10000, 150, 1.5],
      ["2024-01-02", 12345, 12000, 180, 1.5]
    ],
    "totals": [null, null, 22000, 330, null]
  }
}

Ошибки

С кодами ошибок можно ознакомиться на странице Коды ошибок.

Предыдущая
Проверить готовность отчета
Следующая
Коды ошибок