本页内容
1. 接口描述 #
接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.item.sku-metric
请求方式:POST
描述:通过该接口可查看电商商品时序数据详情,包括:商品自然月销额、商品自然月销量、商品自然月售价、商品唯一ID、日期等等,具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|---|
appkey | 否 | string | "predeploy" | 权限校验标识 | |
filters | 是 | Array of RequestltemFilters | (见接口示例) | 查询过滤条件 | |
metrics | 否 | Array of RequestBaseMetrics | (见接口示例) | 查询过滤条件 | |
openStrategy | 否 | boolean | false | 是否接受缓存 | |
page | 否 | integer | 1 | 分页查询的页码,默认1 | |
pageSize | 否 | integer | 20 | 分页查询的单页数据条数,默认20 |
3. 输出参数 #
参数名称 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
code | 否 | integer | 0 | 返回状态码,内部定义 |
data | 否 | Array of ResponseDataOfltemMetric | (见接口示例) | 查询过滤条件 |
msg | 否 | string | "接口返回成功!" | 接口返回信息说明,在接口返回失败时会有 |
openStrategy | 否 | boolean | false | 是否接受缓存 |
success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestltemFilters #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | "68" | 品牌id |
brandName | 否 | string | "小米" | 品牌名 |
categoryId | 否 | integer | "1123" | 品类ID 注:仅支持末级品类,该参数准备废弃,建议使用spCategoryId |
categoryName | 否 | string | "奶粉" | 标准品类名 注:仅支持末级品类,该参数准备废弃,建议使用spCategoryName |
crawlerDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 商品爬取时间。注:默认最近一年的时间,允许缺失时间值 |
filterSkuIds | 否 | list | [100000200000092540,100000200000092580,100000200000093890] | 根据商品过滤聚合(商品维度聚合)时传 |
optionalFields | 否 | list | [ "itemCnt", "brandCnt" ] | 可选的的字段,支持[itemCnt,brandCnt] |
requestPrice | 否 | array | {"end":1000,"start":100} | 商品销售价格范围 |
siteId | 否 | integer | 5 | 站点ID,天猫:10,京东:5 |
skuId | 否 | long | "637338326057" | 商品SkuId |
spCategoryId | 否 | integer | "1121" | 标准品类id(查询该品类下所有的子品类) |
spCategoryName | 否 | string | "3c数码" | 标准品类名(查询该品类下所有的子品类) |
specifyBrandcategoryRelation | 否 | boolean | "false" | 是否指定品牌品类关系 |
title | 否 | string | "苹果8plus" | 商品标题,不传则查询时不限制商品标题 |
4.2 RequestBaseMetrics #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
categoryLevel | 否 | integer | 5 | 品类聚合的层级粒度,范围1—5,5代表最末级,默认5 |
dimensions | 否 | array | [ "categoryName", "brandName" ] | agg查询维度字段,用于查询数据分布、趋势(例如基于品牌),仅支持开放的字段:skuId(商品)、date(发表时间、采集时间),非法参数会报错 |
filterotherCategoryLevel | 否 | boolean | true | 是否过滤其他品类层级 |
interval | 否 | string | "month" | 发表时间agg查询时间单位,默认:month,仅支持:day、week、month、quarter,非法参数会报错 |
order | 否 | string | "desc" | 排序方式:asc(升序)、desc(降序),非法参数会报错 |
sort | 否 | string | "monthSaleCnt" | 排序字段:monthSaleCnt(自然月销量)、monthSaleAmount(自然月销售额),非法参数会报错 |
4.3 ResponseDataOfItemMetric #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
dataset | 否 | [Array of ItemMetric,Array of ItemMetric] | (见接口请求示例) | 返回数据集,不同接口返回结果的格式不一样 |
dorisTime | 否 | integer | "458" | 查询Doris耗时,单位毫秒 |
meta | 否 | array | "list" | 返回数据格式:list、aggregation、graph |
page | 否 | integer | 1 | 分页查询的页码 |
pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
time | 否 | integer | "955" | 查询总耗时,单位毫秒 |
total | 否 | integer | "34500230" | 查询数据总量 |
4.3.1 ItemMetric #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandCnt | 否 | integer | "0.02482" | 品牌数 |
brandName | 否 | string | "苹果" | 品牌名称 |
categoryName | 否 | string | "洗发水" | 末级品类名称 |
firstCategoryName | 否 | string | "洗发水" | 一级品类名称 |
fourthCategoryName | 否 | string | "洗发水" | 四级品类名称 |
itemCnt | 否 | integer | "502" | 电商商品数 |
itemCntRateLP | 否 | number | "0.02482" | 电商商品数环比 |
maxSalePrice | 否 | number | "899.66" | 自然月售价最大值 |
metricDate | 否 | string | "2022-01" | 汇总时间,格式化为月 |
minSalePrice | 否 | number | "899.66" | 自然月售价最小值 |
monthSaleAmount | 否 | number | "89900.85" | 自然月销售额 |
monthSaleAmountRateLp | 否 | number | "0.04209" | 自然月销售额环比 |
monthSaleCnt | 否 | integer | "899" | 自然月销量 |
monthSaleCntRateLp | 否 | number | "0.02482" | 自然月销量环比 |
monthSalePrice | 否 | number | "899.66" | 自然月售价 |
perPieceSalePrice | 否 | number | "899.66" | 件均价 |
secondCategoryName | 否 | string | "洗发水" | 二级品类名称 |
siteId | 否 | integer | "10" | 站点ID |
siteName | 否 | string | "天猫" | 站点名称 |
skuId | 否 | integer | "526498885740" | 商品SkuId |
thirdCategoryName | 否 | string | "洗发水" | 三级品类名称 |
5. 示例 #
示例1 查看商品的销售数据详情 #
查看某个商品在某个时间段内的销售数据。
输入示例
{
"appkey": "predeploy",
"filters": {
"crawlerDate": {
"end": 1649952000000,
"start": 1640966400000
},
"filterSkuIds": [
100000200000000155,
100000200000000068,
100000200000000163,
100000200000000377,
100000200000000248,
100000200000091584,
100000200000091718,
100000200000092159,
100000200000092537,
100000200000092582,
100000200000093892
]
},
"metrics": {
"dimensions": [
"date"
],
"interval": "month",
"order": "desc",
"sort": "monthSaleCnt"
},
"openStrategy": false,
"page": 1,
"pageSize": 5
}
输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功!",
"data": {
"meta": {
"datasetType": "aggregation"
},
"dataset": [
{
"metricDate": "2022-01-01",
"monthSalePrice": 562.6999999999999,
"monthSaleCnt": 7543,
"monthSaleAmount": 4244446.1
},
{
"metricDate": "2022-02-01",
"monthSalePrice": 640.6999999999999,
"monthSaleCnt": 5566,
"monthSaleAmount": 3566136.1999999997
},
{
"metricDate": "2022-04-01",
"monthSalePrice": 716.1213333333333,
"monthSaleCnt": 4998,
"monthSaleAmount": 3579174.4239999996
},
{
"metricDate": "2022-03-01",
"monthSalePrice": 730.7209090909091,
"monthSaleCnt": 4936,
"monthSaleAmount": 3606838.407272727
}
],
"pageSize": 5,
"page": 1,
"total": 4,
"time": 187
}
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
状态码 | 描述 |
---|---|