分析数据 - Ozon Seller API

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

示例值:

Api-Key

string

API-密钥。

必需

示例值:

Body 参数application/json

date_from

string

可选

数据将出现在报告中的日期。

若您没有Premium订阅，请指定过去三个月内的日期。

date_to

string

可选

数据将出现在报告中的截止日期。

dimension

array[string]

可选

报告中的分组数据。

所有卖家可用的分组方法：

unknownDimension — 未知商品标识符，

sku — 商品标识符，

spu — 商品标识符，

day — 日，

week — 星期，

month — 月。

只有Premium订阅卖家才能使用的分组方法：

year — 年

category1 — 一级类别，

category2 — 二级类别，

category3 — 三级类别，

category4 — 四级类别，

brand — 品牌，

modelID — 型号。

filters

array[object (object) {3}]

过滤器。

可选

key

string

可选

排序参数。可以传递dimension 和 metric中的任何属性, brand除外。

op

string

可选

value

string

用于对比的值。

可选

limit

integer <int64>

可选

响应的值个数：

最大值 — 1000，

最小值 — 1.

metrics

array[string]

可选

最多指定14个指标。如有更多，您将收到 InvalidArgument的错误。

生成报告所依据的指标列表。

所有卖家可用的指标：

revenue — 订购的金额，

ordered_units — 订购的商品。

仅对Premium订阅卖家可用的指标：

unknown_metric — 未知指标，

hits_view_search — 在搜索和类别中的指标，

hits_view_pdp — 商品卡片上的指标，

hits_view — 总展示次数，

hits_tocart_search — 从搜索或类别添加到购物车，

hits_tocart_pdp — 从商品卡片添加到购物车，

hits_tocart — 添加到购物车的总数，

session_view_search — 在搜索或类别中显示的会话，

session_view_pdp — 在商品卡片上显示的会话，

session_view — 所有会话，

conv_tocart_search — 从商品卡片转换到购物车，

conv_tocart_pdp — 从商品卡片转换到购物车的总转化率，

conv_tocart — 购物车总转化率，

returns — 退货，

cancellations — 取消的商品，

delivered_units — 交付的商品，

position_category — 在搜索和类别中的的位置。

枚举值:

unknown_metrichits_view_searchhits_view_pdphits_viewhits_tocart_searchhits_tocart_pdphits_tocartsession_view_searchsession_view_pdpsession_viewconv_tocart_searchconv_tocart_pdpconv_tocartrevenuereturnscancellationsordered_unitsdelivered_unitsadv_view_pdpadv_view_search_categoryadv_view_alladv_sum_allposition_categorypostingspostings_premium

offset

integer <int64>

可选

响应中要跳过的元素数字。例如，如果 offset = 10, 那么答案将从找到的第11个元素开始。

sort

array[object (object) {2}]

报告排列设置。

可选

key

string

可选

查询排序结果所依据的指标。

order

string

可选

分类类型:

ASC — 升序，

DESC — 降序。

默认值:

ASC

示例

{
  "date_from": "2020-09-01",
  "date_to": "2021-10-15",
  "metrics": [
    "hits_view_search"
  ],
  "dimension": [
    "sku",
    "day"
  ],
  "filters": [],
  "sort": [
    {
      "key": "hits_view_search",
      "order": "DESC"
    }
  ],
  "limit": 1000,
  "offset": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-seller.ozon.ru/v1/analytics/data' \
--header 'Client-Id: ' \
--header 'Api-Key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "date_from": "2020-09-01",
    "date_to": "2021-10-15",
    "metrics": [
        "hits_view_search"
    ],
    "dimension": [
        "sku",
        "day"
    ],
    "filters": [],
    "sort": [
        {
            "key": "hits_view_search",
            "order": "DESC"
        }
    ],
    "limit": 1000,
    "offset": 0
}'

返回响应

🟢200数据分析

application/json

Body

result

object (object)

查询结果。

可选

data

array[object (object) {2}]

数据组。

可选

totals

array[number <double>]

指标总计和平均值。

可选

timestamp

string

报告创建时间。

可选

示例

{
  "result": {
    "data": [],
    "totals": [
      0
    ]
  },
  "timestamp": "2021-11-25 15:19:21"
}

🟠400参数错误

🟠403拒绝访问

🟠404未找到答案

🟠409请求冲突

🔴500内部服务器错误