Статус генерации и скачивание готовых отчетов
Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания.
Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция
| ⚙️ Лимит: 100 запросов в минуту |
|---|
Request
GET
https://api.partner.market.yandex.ru/reports/info/{reportId}
Path parameters
|
Name |
Type |
Description |
|
reportId* |
string |
Идентификатор отчета, который вы получили после запуска генерации. |
Responses
200 OK
Статус генерации отчета и ссылка, если она уже есть.
Совет
Если статус генерации отчета — FAILED или NO_DATA, проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор магазина, период или номер платежного поручения.
Body
{
"status": "OK",
"result": {
"status": "PENDING",
"subStatus": "NO_DATA",
"generationRequestedAt": "2022-12-29T18:02:01Z",
"generationFinishedAt": "2022-12-29T18:02:01Z",
"file": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Статус генерации и ссылка на готовый отчет. |
ReportInfoDTO
Статус генерации и ссылка на готовый отчет.
|
Name |
Type |
Description |
|
status* |
Статус генерации отчета:
|
|
|
subStatus |
Подстатус генерации отчета:
|
|
|
generationRequestedAt* |
string<date-time> |
Дата и время запроса на генерацию. |
|
generationFinishedAt |
string<date-time> |
Дата и время завершения генерации. |
|
file |
string |
Ссылка на готовый отчет. |
|
estimatedGenerationTime |
integer<int64> |
Ожидаемая продолжительность генерации в миллисекундах. |
ReportStatusType
Статус генерации отчета:
PENDING— отчет ожидает генерации;PROCESSING— отчет генерируется;FAILED— во время генерации произошла ошибка;DONE— отчет готов.
|
Type |
Description |
|
Enum: |
ReportSubStatusType
Подстатус генерации отчета:
NO_DATA— для такого отчета нет данных;TOO_LARGE— отчет превысил допустимый размер — укажите меньший период времени или уточните условия запроса.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |