The table lists HTTP response codes.
Value | Description |
200 | The report was created successfully in online mode |
201 | The report was successfully added to the offline queue |
202 | The report is being generated in offline mode |
400 | Error in the request, or exceeded the limit on requests in the queue |
500 | Server error when generating the report |
502 | Request processing timed out on the server |
If an error occurs, the following structure is returned:
{
"error": {
"request_id": (string),
"error_code": (int),
"error_string": (string),
"error_detail": (string)
}
}
Parameter | Type | Description |
request_id | string | Unique request ID assigned by the Yandex Direct API server. It is also passed in the Request-ID HTTP header. |
error_code | int | Numeric error code. |
error_string | string | Textual message about the error. |
error_detail | string | Detailed description of the error. |
<?xml version="1.0" encoding="UTF-8"?>
<reports:reportDownloadError xmlns:reports="http://api.direct.yandex.com/v5/reports">
<reports:ApiError>
<>(string)</reports:requestId>
<>(int)</reports:errorCode>
<>(string)</reports:errorMessage>
<>(string)</reports:errorDetail>
</reports:ApiError>
</reports:reportDownloadError>
Parameter | Type | Description |
reports:ApiError object |
reports:requestId | string | Unique request ID assigned by the Yandex Direct API server. It is also passed in the Request-ID HTTP header. |
reports:errorCode | int | Numeric error code. |
reports:errorMessage | string | Textual message about the error. |
reports:errorDetail | string | Detailed description of the error. |
Errors are described in the section Errors and warnings.