Introduction

Account administrators, assistants, and advertisers can use this service to get statistics.

Note

Statistics in reports are shown in the UTC +3 time zone.

The request to generate a report must be sent over HTTPS using the GET method.

The report parameters must be specified in the request body.

Address for request

https://adfox.yandex.com/api/report/<method>/<level>?[methodArguments]

Parameter

Description

method

The method for getting information about the report.

level

The level of detail.

methodArguments

Parameters for the method arguments.

Note

If you use a member (advertiser or website owner) account that was copied to several administrator accounts, you need to pass the ownerId parameter in each request (the ID of the administrator account that a report request is sent to).

Example address for the request:

https://adfox.yandex.com/api/report/date/interval/owner?name=days&ownerId=50242

Response format

The response to the request is sent in JSON format:

{
   result: <result>
   error: <error>
}

Parameter

Type

Description

result

integer

Error code.

error

string

If the request is successful, this field is empty. If an error occurred, the field contains the error code.

Limits on the number of requests

The number of requests to generate a report is limited to:

  • 100 requests per minute.
  • 3 simultaneous requests from one account owner.

When the reports are ready ("state": SUCCESS), you can send new requests.

Report data is stored for 3 years.