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 change.
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 v2/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/v2/reports/goods-feedback/generate
Query parameters
|
Name |
Description |
|
format |
Type: string The format of the report or document. Report format:
Default: Enum: |
Body
application/json
{
"businessId": 1
}
|
Name |
Description |
|
businessId |
Type: integer Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: |
Responses
200 OK
An identifier is sent in response, which allows you to find out the generation status and download the finished report.
Body
application/json
{
"status": "OK"
}
Type: object
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
No longer supported, please use an alternative and newer version.