The structure and content of the reports are subject to change without prior notice.
For example, a new column may be added or the name of the sheet may be changed.
Product Reviews Report
The method is available for all models.
Not yet available for Market Yandex Go sellers.
If you are using an API Key token, one of the accesses in the list is required to call the method
- communication — Customer communication
- all-methods — Full account management
Starts the generation of a report on product reviews. What kind of report is this
You can find out the generation status and get a link to the finished report using a request. GET reports/info/{reportId}.
Explanation of the report columns:
Sheet Товары на витрине (file paid_opinion_models)
CSV column name |
JSON column name |
XLSX column name |
Value type |
SKU |
sku |
SKU |
string |
PRODUCT_NAME |
productName |
Товар |
string |
RATING |
rating |
Рейтинг товара |
number |
CAMPAIGN_NAME |
campaignName |
Кампания |
string |
CAMPAIGN_STATUS |
campaignStatus |
Статус |
string |
MAX_CHARGE |
maxCharge |
Баллы |
integer |
CURRENT_OPINION_COUNT |
currentOpinionCount |
Количество отзывов |
integer |
TARGET_COUNT |
targetCount |
Цель |
integer |
PAID_OPINIONS_COLLECTED |
paidOpinionsCollected |
Платные отзывы |
integer |
ESTIMATED_OPINIONS_COUNT |
estimatedOpinionsCount |
Еще можно получить |
integer |
ORDERED_ITEMS_TOTAL_AMOUNT |
orderedItemsTotalAmount |
Заказанные товары на сумму |
integer |
MODEL_ID |
modelId |
Идентификатор модели |
integer |
PRODUCT_LINK |
productLink |
Ссылка на Маркет |
string |
, Limit: 100 requests per hour |
---|
Request
POST
https://api.partner.market.yandex.ru/reports/goods-feedback/generate
Query parameters
Name |
Description |
format |
Type: ReportFormatType The format of the report or document. |
ReportFormatType
Report format:
FILE
— a spreadsheet file (XLSX).CSV
— ZIP archive with CSV files for each report sheet.JSON
— ZIP archive with JSON files for each report sheet.
Type |
Description |
Default: Enum: |
Body
application/json
{
"businessId": 0
}
Name |
Description |
businessId* |
Type: integer<int64> Cabinet ID. |
Responses
200 OK
In response, you receive an identifier that allows you to find out the generation status and download the finished report.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
Name |
Description |
result |
Type: GenerateReportDTO The ID that will be needed to track the generation status and receive the finished report or document. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
GenerateReportDTO
The ID that will be needed to track the generation status and receive the finished report or document.
Name |
Description |
estimatedGenerationTime* |
Type: integer<int64> Expected generation time in milliseconds. |
reportId* |
Type: string The ID that will be needed to track the generation status and receive the finished report or document. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
Name |
Description |
code* |
Type: string The error code. |
message |
Type: string Description of the error. |
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.