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

Info

Console

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:

FILE — the spreadsheet file (XLSX).
CSV — A ZIP archive with CSV files for each report sheet.
JSON — A ZIP archive with JSON files for each report sheet.

Default: FILE

Enum: FILE, CSV, JSON

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

status*

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: object

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.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

The Prices Report

Turnover Report (FBY)