Get a report

Use this method to retrieve a fully generated report in table form.

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

Parameters

Parameter	Description
`taskId`	path (string) — the value from `result.taskId` in the `POST` response (for example `umr-a-rsr-…`).

Successful response (HTTP 200)

Field	Type	Description
`result`	object
`result.taskId`	string	Task ID.
`result.columns`	array	Column descriptions from left to right.
`result.rows`	array of array	Table rows. Each row is an array of cells in the order defined by `columns`.
`result.totals`	array	Final values for the metrics, ordered as in the response. Elements may be number, string, or `null` depending on the data.

Element `result.columns[]`

Field	Type	Description
`name`	string	Column ID (data field).
`type`	string	One of these values: `string`, `integer`, `number`.
`format`	string	For floating‑point numbers, the value may be `float`.
`unit`	string	For example, `percent` for percentage metrics.

Cells in result.rows are JSON scalars or null, with no nested objects in the typical case.

Sample request

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

Sample response (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]
  }
}

Errors

For error codes, see the Error codes page.

Was the article helpful?

Check the report status

Error codes