报告的结构及内容如有更改，恕不另行通知。

例如，可以添加新列或更改工作表的名称。

销售分析报告

方法适用于所有模式.

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

开始生成指定期间的销售分析报告。 这是什么报告

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

报告列说明：

表单Аналитика продаж（文件sales_funnel_report）

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DAY

day

День

string

MONTH

month

Месяц

string

YEAR

year

Год

integer

CATEGORY_NAME

categoryName

Категория

string

BRAND_NAME

brandName

Бренд

string

OFFER_ID

offerId

Ваш SKU

string

OFFER_NAME

offerName

Название товара

string

BY_MSKU_SHOWS

byMskuShows

Показы товаров всех продавцов, шт.

integer

VISIBILITY_INDEX

visibilityIndex

Индекс видимости, %

string

SHOWS

shows

Показы моих товаров, шт.

integer

SHOWS_WITH_PROMOTION

showsWithPromotion

Показы моих товаров с акциями, шт.

integer

SHOWS_SHARE

showsShare

Доля показов с бустом, %

number

CLICKS

clicks

Клики по товарам, шт.

integer

CLICKS_WITH_PROMOTION

clicksWithPromotion

Клики по товарам с акциями, шт.

integer

TO_CART_CONVERSION

toCartConversion

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

number

TO_CART

toCart

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

integer

TO_CART_WITH_PROMOTION

toCartWithPromotion

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

integer

TO_CART_SHARE

toCartShare

Доля добавлений товаров с бустом в корзину, %

number

ORDER_ITEMS

orderItems

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

integer

ORDER_ITEMS_WITH_PROMOTION

orderItemsWithPromotion

Заказанные товары по акциям, шт.

integer

ORDER_ITEMS_TOTAL_AMOUNT

orderItemsTotalAmount

Заказано товаров на сумму, ₽

integer

ORDER_ITEMS_TOTAL_AMOUNT_WITH_PROMOTION

orderItemsTotalAmountWithPromotion

Заказано товаров с акциями на сумму, ₽

integer

TO_ORDER_CONVERSION

toOrderConversion

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

number

ORDER_ITEMS_SHARE

orderItemsShare

Доля заказанных товаров с бустом, %

number

ORDER_ITEMS_DELIVERED_COUNT

orderItemsDeliveredCount

Доставлено за период, шт.

integer

ORDER_ITEMS_DELIVERED_COUNT_WITH_PROMOTION

orderItemsDeliveredCountWithPromotion

Доставлено за период по акциям, шт.

string

ORDER_ITEMS_DELIVERED_TOTAL_AMOUNT

orderItemsDeliveredTotalAmount

Доставлено за период на сумму, ₽

integer

ORDER_ITEMS_DELIVERED_TOTAL_AMOUNT_WITH_PROMOTION

orderItemsDeliveredTotalAmountWithPromotion

Доставлено за период по акциям на сумму, ₽

integer

ORDER_ITEMS_DELIVERED_FROM_ORDERED_COUNT

orderItemsDeliveredFromOrderedCount

Доставлено из заказанных за период, шт.

integer

ORDER_ITEMS_DELIVERED_FROM_ORDERED_TOTAL_AMOUNT

orderItemsDeliveredFromOrderedTotalAmount

Доставлено из заказанных на сумму за период, ₽

integer

ORDER_ITEMS_DELIVERED_FROM_ORDERED_TOTAL_AMOUNT_WITH_PROMOTION

orderItemsDeliveredFromOrderedTotalAmountWithPromotion

Доставлено из заказанных на сумму за период по акциям, ₽

integer

ORDER_ITEMS_CANCELED_COUNT

orderItemsCanceledCount

Отмены и невыкупы за период, шт.

integer

ORDER_ITEMS_CANCELED_BY_CREATED_AT_COUNT

orderItemsCanceledByCreatedAtCount

Отмены и невыкупы заказанного за период, шт.

integer

ORDER_ITEMS_RETURNED_COUNT

orderItemsReturnedCount

Возвращённые товары за период, шт.

integer

ORDER_ITEMS_RETURNED_BY_CREATED_AT_COUNT

orderItemsReturnedByCreatedAtCount

Возвраты заказанного за период, шт.

integer
⚙️ 限制: 每小时10个请求

Request

POST

https://api.partner.market.yandex.ru/v2/reports/shows-sales/generate

Query parameters

Name

Description

format

Type: ReportFormatType

报告或文档的格式。

ReportFormatType

报告格式:

  • FILE — 电子表格文件（XLSX).
  • CSV — 每个报告表都有一个包含CSV文件的ZIP存档。
  • JSON — 每个报告表都有一个带有JSON文件的ZIP压缩包.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "businessId": 0,
    "campaignId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "grouping": "CATEGORIES"
}

Name

Description

dateFrom*

Type: string<date>

期的开始，包括在内。

dateTo*

Type: string<date>

期结束，包括在内。

grouping*

Type: ShowsSalesGroupingType

Группировка данных отчета.

Enum: CATEGORIES, OFFERS

businessId

Type: integer<int64>

内阁ID。

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

campaignId

Type: integer<int64>

活动ID。

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

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中，选择 Api和模块:

  • 座 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要发送商店ID，这是在市场上的卖家帐户旁边的商店名称和一些报告。

ShowsSalesGroupingType

报表数据的分组。 可能的值:

  • CATEGORIES — 按类别分组。
  • OFFERS — 按产品分组。

Type

Description

ShowsSalesGroupingType

Enum: CATEGORIES, OFFERS

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

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

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.

上一篇
关闭文件
下一篇
印象提升报告