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.

Shelf Report

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

Starts the generation of a summary report on the shelves — ad blocks with a banner or video and a set of products. Read more about them in the Help of the Market for sellers.

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 shelfs_statistics_summary)

CSV column name

JSON column name

XLSX column name

Value type

DATE

date

Дата

string

INCUT_ID

incutId

ID кампании

integer

TITLE

title

Название кампании

string

IMPRESSIONS

impressions

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

AVERAGE_IMPRESSION_FREQUENCY

averageImpressionFrequency

Частота показа

number

TO_CART

toCart

Добавления в корзину, шт.

integer

ORDERED

ordered

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

CPM

cpm

CPM, ₽

number

DRR

drr

Доля расчётных расходов от выручки с полкой

number

REAL_COST

realCost

Фактические расходы (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number
Sheet Таргетинг по категориям (file shelfs_statistics_by_category)

CSV column name

JSON column name

XLSX column name

Value type

DATE

date

Дата

string

INCUT_ID

incutId

ID кампании

integer

TITLE

title

Название кампании

string

SHOW_CATEGORY_NAME

showCategoryName

Категория показа полки

string

IMPRESSIONS

impressions

Показы, шт.

integer

COVERAGE

coverage

Охват, чел.

integer

CLICKS

clicks

Клики, шт.

integer

CTR

ctr

CTR, %

number

AVERAGE_IMPRESSION_FREQUENCY

averageImpressionFrequency

Частота показа

number

TO_CART

toCart

Добавления в корзину, шт.

integer

ORDERED

ordered

Заказанные товары, шт.

integer

CONVERSION

conversion

Конверсия в заказы, %

number

ORDERED_AMOUNT

orderedAmount

Стоимость заказанных товаров, ₽

number

CPO

cpo

СРО, ₽

number

COST

cost

Расчётные расходы, ₽

number

CPM

cpm

CPM, ₽

number

DRR

drr

Доля расчётных расходов от выручки с полкой

number
⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/shelf-statistics/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": 1,
  "dateFrom": "2025-01-01",
  "dateTo": "2025-01-01",
  "attributionType": "CLICKS"
}

Name

Description

attributionType

Type: string

Attribution type:

  • CLICKS — by clicks.
  • SHOWS — by impressions.

For information about which data in the report depends and does not depend on the type of attribution, read in the Help of the Market for sellers.

Enum: CLICKS, SHOWS

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: 1

dateFrom

Type: string<date>

The beginning of the period, inclusive.

Example: 2025-01-01

dateTo

Type: string<date>

End of the period, inclusive.

Example: 2025-01-01

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

pathParams: []
searchParams:
  - description: The format of the report or document.
    name: format
    in: query
    required: false
    schema:
      description: >
        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.
      type: string
      enum:
        - FILE
        - CSV
        - JSON
      default: FILE
headers: []
body: |-
  {
    "businessId": 1,
    "dateFrom": "2025-01-01",
    "dateTo": "2025-01-01",
    "attributionType": "CLICKS"
  }
schema:
  description: |
    The data required to generate the report.
  type: object
  required:
    - businessId
    - attributionType
    - dateFrom
    - dateTo
  properties:
    businessId:
      description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
      type: integer
      format: int64
      minimum: 1
    dateFrom:
      description: The beginning of the period, inclusive.
      format: date
      type: string
    dateTo:
      description: End of the period, inclusive.
      format: date
      type: string
    attributionType:
      type: string
      description: >
        Attribution type:
          * `CLICKS` — by clicks.
          * `SHOWS` — by impressions.
        <br><br>


        For information about which data in the report depends and does not
        depend on the type of attribution, read [in the Help of the Market for
        sellers](https://yandex.ru/support2/marketplace/ru/marketing/shelf#stats).
      enum:
        - CLICKS
        - SHOWS
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/shelf-statistics/generate
host: https://api.partner.market.yandex.ru

No longer supported, please use an alternative and newer version.

Previous
Sales Boost Report
Next
Coverage Promotion Report