本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.ecommerce.commodity-metric
请求方式：POST
描述：通过该接口可查看标品销售数据详情，包括：自然月商品销额、自然月销量、促销价均值、促销价最大值、促销价最小值、件均价、销量环比、销额环比等等，具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | Array of RequestCommodityMetricsFilters | (见接口示例) | 查询过滤条件 | |
| metrics | 否 | Array of RequestCommodityMetrics | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 | |
| page | 否 | integer | 1 | 分页查询的页码，默认1 | |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数，默认20 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | Array of ResponseDataOfCommodityMetricsVo | (见接口示例) | 查询过滤条件 |
| msg | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
| success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1RequestCommodityMetricsFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| commodityId | 否 | integer | 68 | 标准商品id(标品名称或id必须传一个) |
| commodityName | 否 | string | "大宝男士磁力净痘洁面泥" | 标准商品名称(标品名称或id必须传一个) |
| crawlerDate | 否 | array | {"end":1635695999000,"start":1627747200000} | 商品爬取时间。注：默认最近一年的时间，允许缺失时间值，如2021-6月~2022-5月 |
| shopName | 否 | string | "修丽可官方旗舰店" | 店铺名称 |
| siteId | 否 | integer | 10 | 站点ID，天猫：10，京东：5 |
| requestPrice | 否 | object | { "start": 100.1, "end": 10000.1 } | 商品价格范围(json格式) |
| spCategoryNames | 否 | array | [ "3C数码", "美妆个护" ] | 品类数组，不限品类层级 |
| commodityFuzzySearch | 否 | boolean | false | 产品名是否模糊匹配，true：模糊匹配 false：全匹配 |
4.2 RequestCommodityMetrics #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dimensions | 否 | array | [ "date", "siteName" ] | agg查询维度字段，用于查询数据分布、趋势，仅支持开放的字段：commodityName（产品名）、brandName（品牌名）、siteName（站点）、date（采集时间）、shopName(店铺）、skuId（商品），非法参数会报错 |
| interval | 否 | string | "month" | 发表时间agg查询时间单位，默认：month，仅支持：day、week、month、quarter，非法参数会报错(目前仅支持month) |
| order | 否 | string | "desc" | 排序方式：asc(升序)、desc(降序)，非法参数会报错 |
| sort | 否 | string | "date" | 排序字段：monthSaleCnt（自然月销量）、monthSaleAmount（自然月销售额）、date（时间），非法参数会报错 |
4.3 ResponseDataOfCommodityMetricVo #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | [Array of CommodityMetricsVo,Array of CommodityMetricsVo] | (见接口示例) | 查询过滤条件 |
| meta | 否 | array | "list" | 返回数据格式：list、aggregation、graph |
| page | 否 | integer | 1 | 分页查询的页码 |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
| time | 否 | integer | "955" | 查询总耗时，单位毫秒 |
| total | 否 | integer | "34500230" | 查询数据总量 |
4.3.1 CommodityMetricsVo #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| maxSaleprice | 否 | number | "899.66" | 自然月售价最大值 |
| metricDate | 否 | string | "2022-01" | 汇总时间，格式化为月 |
| minSaleprice | 否 | number | "899.66" | 自然月售价最小值 |
| monthSaleAmount | 否 | number | "89900.85" | 自然月销售额 |
| monthSaleAmountRateLp | 否 | number | "0.04209" | 自然月销售额环比 |
| monthSaleCnt | 否 | integer | "899" | 自然月销量 |
| monthSaleCntRateLp | 否 | integer | "0.02482" | 自然月销量环比 |
| monthSalePrice | 否 | number | "899.66" | 自然月售价 |
| perpieceSalePrice | 否 | number | "899.66" | 件均价 |
| siteId | 否 | integer | "10" | 站点ID |
| siteName | 否 | string | "天猫" | 站点名称 |
| commodityId | 否 | integer | 32 | 标品id |
| commodityName | 否 | string | "MIUI/小米 Redmi 10X 4G" | 标品名称 |
| commodityCategoryName | 否 | string | "手机" | 产品关联的品类名 |
| commodityBrandName | 否 | string | "小米" | 产品关联的品牌名 |
| itemCnt | 否 | integer | "502" | 电商商品数 |
| skuId | 否 | long | "526498885740" | 商品SkuId |
| itemId | 否 | String | "637338326057" | 商品itemId |
| title | 否 | String | "iPad保护套2020第8代10.2寸2019苹果air3平板mini5软壳" | 商品标题 |
| itemUrl | 否 | String | "https://item.jd.com/100007308548.html" | 商品url |
5. 示例 #
示例1 查看标品下的销售数据详情 #
查看某个标品在某个时间段内的销售数据。
输入示例
{
"appkey": "predeploy",
"filters": {
"commodityId": 4256,
"commodityName":"芙丽芳丝保湿修护水润美容液",
"crawlerDate": {
"end": 1635695999000,
"start": 1627747200000
},
"siteId": 10
},
"metrics": {
"dimensions": [
"date",
"siteName"
],
"interval": "month",
"order": "desc",
"sort": "date"
},
"openStrategy": false,
"page": 1,
"pageSize": 20
}输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功！",
"data": {
"meta": {
"datasetType": "aggregation"
},
"dataset": [],
"pageSize": 20,
"page": 1,
"total": 0,
"time": 169
}
}6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
| 状态码 | 描述 |
|---|---|