Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

关于关键指标的报告

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

开始生成关于关键指标的报告。 这是什么报告

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.

报告列说明:

表单Основные(文件key_indicators_summary

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

PERIOD

period

Период

string

GMV

gmv

Выручка, ₽

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

Стоимость всех услуг Маркета без продвижения, ₽

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

表单Выручка(文件key_indicators_revenue

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

PERIOD

period

Период

string

GMV

gmv

Выручка, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

YANDEX_PLUS

yandexPlus

Платежи за скидки по баллам Яндекс Плюса, ₽

number

SUBSIDY

subsidy

Платежи за скидки маркетплейса, ₽

number

表单Показатели продаж(文件key_indicators_sales

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

PERIOD

period

Период

string

SHOWS

shows

Показы товаров

integer

TO_CART_CONVERSION

toCartConversion

Конверсия добавления в корзину, %

number

TO_ORDER_CONVERSION

toOrderConversion

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

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

GMV

gmv

Выручка, ₽

number

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

ORDER_ITEMS_DELIVERED

orderItemsDelivered

Доставленные товары, шт

integer

ORDER_ITEM_AVG_PRICE

orderItemAvgPrice

Средняя стоимость доставленного товара, ₽

number

表单Расходы(文件key_indicators_expenses

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

PERIOD

period

Период

string

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

Стоимость всех услуг Маркета без продвижения, ₽

number

FEE

fee

Стоимость размещения товаров на витрине, ₽

number

PAYMENT_ACCEPTANCE_AND_TRANSFER

paymentAcceptanceAndTransfer

Приём и перевод платежа покупателя, ₽

number

LOGISTIC_SERVICES

logisticServices

Стоимость услуг логистики, ₽

number

WAREHOUSE_SERVICES

warehouseServices

Стоимость услуг склада, ₽

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

BOOST

boost

Расходы на буст продаж, ₽

number

PROMOTION_WITH_SHOWS

promotionWithShows

Расходы на продвижение с оплатой за показы, ₽

number

LOYALTY_PARTICIPATION_FEE

loyaltyParticipationFee

Участие в программе лояльности и отзывы, ₽

number

EXTENDED_ACCESS_PAYMENT

extendedAccessPayment

Расширенный доступ к сервисам Маркетплейса, ₽

number

表单Все(文件key_indicators_full

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

PERIOD

period

Период

string

SHOWS

shows

Показы товаров

integer

TO_CART_CONVERSION

toCartConversion

Конверсия добавления в корзину, %

number

TO_ORDER_CONVERSION

toOrderConversion

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

number

ORDERS_DELIVERED

ordersDelivered

Доставленные заказы, шт.

integer

GMV

gmv

Выручка, ₽

number

ORDERS_AVG_PRICE

ordersAvgPrice

Средний чек заказа, ₽

number

ORDER_ITEMS_DELIVERED

orderItemsDelivered

Доставленные товары, шт

integer

ORDER_ITEM_AVG_PRICE

orderItemAvgPrice

Средняя стоимость доставленного товара, ₽

number

TOTAL_SUBSIDY

totalSubsidy

Все платежи за скидки, ₽

number

YANDEX_PLUS

yandexPlus

Платежи за скидки по баллам Яндекс Плюса, ₽

number

SUBSIDY

subsidy

Платежи за скидки маркетплейса, ₽

number

SERVICES_WITHOUT_PROMOTION

servicesWithoutPromotion

Стоимость всех услуг Маркета без продвижения, ₽

number

FEE

fee

Стоимость размещения товаров на витрине, ₽

number

PAYMENT_ACCEPTANCE_AND_TRANSFER

paymentAcceptanceAndTransfer

Приём и перевод платежа покупателя, ₽

number

LOGISTIC_SERVICES

logisticServices

Стоимость услуг логистики, ₽

number

WAREHOUSE_SERVICES

warehouseServices

Стоимость услуг склада, ₽

number

PROMOTION_SERVICES

promotionServices

Стоимость услуг продвижения, ₽

number

BOOST

boost

Расходы на буст продаж, ₽

number

PROMOTION_WITH_SHOWS

promotionWithShows

Расходы на продвижение с оплатой за показы, ₽

number

LOYALTY_PARTICIPATION_FEE

loyaltyParticipationFee

Участие в программе лояльности и отзывы, ₽

number

EXTENDED_ACCESS_PAYMENT

extendedAccessPayment

Расширенный доступ к сервисам Маркетплейса, ₽

number

**⚙️ 限制:**每小时100个请求

Request

POST

https://api.partner.market.yandex.ru/v2/reports/key-indicators/generate

Query parameters

Name

Description

format

Type: ReportFormatType

报告或文档的格式。

ReportFormatType

报告格式:

  • FILE -电子表格文件(XLSX).
  • CSV -ZIP存档与CSV文件的每个报告表。
  • JSON -ZIP存档与JSON文件的每个报告表。

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "businessId": 0,
    "campaignId": 0,
    "detalizationLevel": "WEEK"
}

Name

Description

detalizationLevel*

Type: KeyIndicatorsReportDetalizationLevelType

За какой период нужна детализация.

Enum: WEEK, MONTH

businessId

Type: integer<int64>

内阁ID。

如果您需要在机柜中创建所有商店的报告,则会显示。 请求必须包含 businessId,或 campaignId 但不是同时两种。

campaignId

Type: integer<int64>

活动ID。

如果您需要在特定商店上创建报告,则会显示。 请求必须包含 businessId,或 campaignId 但不是同时两种。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

  • 模块和 API→区块 向Yandex发送数据。街市.
  • 查询日志 →块中的下拉列表 显示日志.

,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。

KeyIndicatorsReportDetalizationLevelType

在哪个时期需要详细信息:

  • WEEK -一周前。

  • MONTH -按月计算。

Type

Description

KeyIndicatorsReportDetalizationLevelType

Enum: WEEK, MONTH

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

Name

Description

estimatedGenerationTime*

Type: integer<int64>

以毫秒为单位的预期生成时间。

reportId*

Type: string

跟踪生成状态和接收完成的报告或文档所需的ID。

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

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