Отчет «Аналитика продаж»
Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
⚙️ Лимит: 10 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/reports/shows-sales/generate
Query parameters
Name |
Type |
Description |
format |
Формат отчета. |
ReportFormatType
Формат отчета:
FILE
— файл с электронной таблицей.CSV
— ZIP-архив с CSV-файлами на каждый лист отчета.
Type |
Description |
Enum: |
Body
{
"businessId": 0,
"campaignId": 0,
"dateFrom": "string",
"dateTo": "string",
"grouping": "CATEGORIES"
}
Name |
Type |
Description |
businessId |
integer<int64> |
Идентификатор бизнеса. Указывается, если нужно составить отчет по всем магазинам бизнеса. В запросе обязательно должен быть либо |
campaignId |
integer<int64> |
Идентификатор кампании. Указывается, если нужно составить отчет по конкретному магазину. В запросе обязательно должен быть либо |
dateFrom* |
string<date> |
Начало периода, включительно. |
dateTo* |
string<date> |
Конец периода, включительно. |
grouping* |
Группировка данных отчета.
|
ShowsSalesGroupingType
Группировка данных отчета. Возможные значения:
CATEGORIES
— группировка по категориям.OFFERS
— группировка по товарам.
Type |
Description |
Enum: |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
result |
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета. |
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
Name |
Type |
Description |
reportId* |
string |
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета. |
estimatedGenerationTime* |
integer<int64> |
Ожидаемая продолжительность генерации в миллисекундах. |
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 |
Список ошибок. |
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 |
Список ошибок. |