本页内容
1. 接口描述 #
接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.item.category-metric
请求方式:POST
描述:通过该接口可查看电商商品品类维度数据详情,包括:品牌、自然月销额、自然月销量、自然月售价、站点名、站点ID、商品唯一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 ResponseDataOfItemMetric | (见接口示例) | 查询过滤条件 |
msg | 否 | string | "接口返回成功!" | 接口返回信息说明,在接口返回失败时会有 |
openStrategy | 否 | boolean | false | 是否接受缓存 |
success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestltemFilters #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | "68" | 品牌id |
brandName | 否 | string | "小米" | 品牌名 |
categoryId | 否 | integer | "1123" | 品类id |
categoryIds | 否 | list | [5643,6515,6519,6521] | 品类ID集合(商品品类维度聚合) |
categoryName | 否 | string | "奶粉" | 标准品类名(与品类id二选一,优先查品类id 注:仅支持末级品类,该参数准备废弃,建议使用spCategoryName |
crawlerDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 商品爬取时间。注:默认最近一年的时间,允许缺失时间值 |
filterSkuIds | 否 | list | [100000200000092540,100000200000092580,100000200000093890] | 根据商品过滤聚合(商品维度聚合)时传 |
optionalFields | 否 | list | [ "itemCnt", "brandCnt" ] | 可选的的字段,支持itemCnt,brandCnt,commodityCnt |
shopName | 否 | string | "修丽可官方旗舰店" | 店铺名称 |
siteId | 否 | integer | 5 | 站点ID,天猫:10,京东:5 |
siteIds | 否 | integer | [5,10] | 站点数组 |
skuId | 否 | long | "637338326057" | 商品SkuId |
spCategoryId | 否 | integer | "1121" | 标准品类id(查询该品类下所有的子品类) |
spCategoryName | 否 | string | "3c数码" | 标准品类名(查询该品类下所有的子品类) |
spCategoryNames | 否 | array | ["3c数码","美妆个护"] | 标准品类名(查询该品类下所有的子品类)。注:品类数组,用于支持筛选行业(仅支持品牌汇总接口) |
specifyBrandcategoryRelation | 否 | boolean | false | 是否指定品牌品类关系 |
limitBcWhitelist | 否 | integer | true | 是否限制品牌品类白名单 |
title | 否 | string | "苹果8plus" | 商品标题,不传则查询时不限制商品标题 |
requestPrice | 否 | object | { "start": 100.1, "end": 10000.1 } | 商品价格范围(json格式) |
shopTypes | 否 | int | 2 | 店铺类型,0:其他、1:专卖店、2:旗舰店 |
brandNames | 否 | array | ["小米"] | 品牌名数组 |
4.2 RequestBaseMetrics #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
categoryLevel | 否 | integer | 5 | 品类聚合的层级粒度,范围1—5,5代表最末级,默认5 |
dimensions | 否 | array | [ "categoryName", "brandName" ] | agg查询维度字段,用于查询数据分布、趋势(例如基于品牌),仅支持开放的字段:brandName(品牌)、categoryName(品类)、commodityName(产品)、siteName(站点)、skuId(商品)、date(发表时间、采集时间)、shopName(店铺),非法参数会报错 |
filterotherCategoryLevel | 否 | boolean | true | 是否过滤其他品类层级 |
interval | 否 | string | "month" | 发表时间agg查询时间单位,默认:month(目前仅支持month),非法参数会报错 |
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 | 否 | long | "526498885740" | 商品SkuId |
thirdCategoryName | 否 | string | "洗发水" | 三级品类名称 |
5. 示例 #
示例1 查看品类下的销售数据详情 #
查看某个品类在某个时间段内的销售数据(时序)。
输入示例
{"appkey": "predeploy",
"filters": {
"categoryName":"手机",
"siteId":10
},
"metrics":{
"dimensions":["date"]
},
"openStrategy": false,
"page": 1,
"pageSize": 20
}
输出示例
Download
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功!",
"data": {
"meta": {
"datasetType": "aggregation"
},
"dataset": [
{
"metricDate": "2022-02",
"monthSalePrice": 7830.8455,
"monthSaleCnt": 148757959,
"monthSaleAmount": 13397618051.5614,
"perPieceSalePrice": 90.0632,
"maxSalePrice": 9999999,
"minSalePrice": 1.1,
"monthSaleCntRateLp": 0.2112,
"monthSaleAmountRateLp": 0.0655
},
{
"metricDate": "2022-03",
"monthSalePrice": 4559.6587,
"monthSaleCnt": 127687936,
"monthSaleAmount": 13327233617.7702,
"perPieceSalePrice": 104.3735,
"maxSalePrice": 9999999,
"minSalePrice": 1.1,
"monthSaleCntRateLp": -0.1416,
"monthSaleAmountRateLp": -0.0052
},
{
"metricDate": "2022-01",
"monthSalePrice": 2087.5621,
"monthSaleCnt": 122814595,
"monthSaleAmount": 12573254053.5233,
"perPieceSalePrice": 102.3759,
"maxSalePrice": 9999999,
"minSalePrice": 1.1,
"monthSaleCntRateLp": 0,
"monthSaleAmountRateLp": 0
},
{
"metricDate": "2022-05",
"monthSalePrice": 1101.7651,
"monthSaleCnt": 59707941,
"monthSaleAmount": 6963857344.7076,
"perPieceSalePrice": 116.632,
"maxSalePrice": 9999999,
"minSalePrice": 1.1,
"monthSaleCntRateLp": 0.3532,
"monthSaleAmountRateLp": 0.3492
},
{
"metricDate": "2022-04",
"monthSalePrice": 1293.6471,
"monthSaleCnt": 44123504,
"monthSaleAmount": 5161401434.8491,
"perPieceSalePrice": 116.9762,
"maxSalePrice": 9999999,
"minSalePrice": 1.1,
"monthSaleCntRateLp": -0.6544,
"monthSaleAmountRateLp": -0.6127
},
{
"metricDate": "2022-07",
"monthSalePrice": 1283.8424,
"monthSaleCnt": 33548673,
"monthSaleAmount": 6376149364.8165,
"perPieceSalePrice": 190.0567,
"maxSalePrice": 145854.7143,
"minSalePrice": 1.1,
"monthSaleCntRateLp": 10.8253,
"monthSaleAmountRateLp": 0.312
},
{
"metricDate": "2022-06",
"monthSalePrice": 871.3365,
"monthSaleCnt": 2837021,
"monthSaleAmount": 4859851259.1445,
"perPieceSalePrice": 1713.0121,
"maxSalePrice": 187599,
"minSalePrice": 1.1,
"monthSaleCntRateLp": -0.9525,
"monthSaleAmountRateLp": -0.3021
}
],
"pageSize": 20,
"page": 1,
"total": 7,
"time": 1243
}
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
状态码 | 描述 |
---|---|