报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
关于关键指标的报告
方法适用于所有模式.
如果您使用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: string 报告或文档的格式。 报告格式:
Default: Enum: |
Body
application/json
{
"businessId": 1,
"campaignId": 1,
"detalizationLevel": "WEEK"
}
|
Name |
Description |
|
detalizationLevel |
Type: string 在哪个时期需要详细信息:
Enum: |
|
businessId |
Type: integer 内阁ID。 要找到答案,请使用请求 GET v2/campaigns. Min value: |
|
campaignId |
Type: integer 广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要把它与:
Min value: |
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
estimatedGenerationTime
Type: integer
预计生成时间以毫秒为单位。
reportId
Type: string
跟踪生成状态和接收完成的报告或文档所需的ID。
Example:
example跟踪生成状态和接收完成的报告或文档所需的ID。
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.