本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.ecommerce.item.sub-category-metric
请求方式：POST
描述：本接口默认品类聚合，通过该接口可查询到各子品类的销售数据详情，包括：自然销售量、自然销售额等等。
该接口初始版本为特化应用的接口，现在品类销售数据汇总完全包含了该接口的功能，推荐使用https://cms.datastory.com.cn/docs/%e5%93%81%e7%b1%bb%e9%94%80%e5%94%ae%e6%95%b0%e6%8d%ae%e6%b1%87%e6%80%bb/
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | Array of RequestCategoryItemMetricsFilters | (见接口示例) | 查询过滤条件 | |
| metrics | 是 | Array of RequestCategoryItemMetrics | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 | |
| page | 否 | integer | 1 | 分页查询的页码，默认1 | |
| pageSize | 否 | integer | 20 | 分页查询的单页数据条数，默认20 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | Array of ResponseDataOfCategoryLevelItemMetricVo | (见接口示例) | 查询过滤条件 |
| msg | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
| success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1RequestCategoryItemMetricsFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| categoryNames | 是 | string | 品类名 | |
| optionalFields | 否 | list | [ "monthSaleCntLp", "monthSaleAmountLp" ] | 可选的字段，支持[monthSaleCntLp,monthSaleAmountLp] |
| queryDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 查询时间 |
| siteId | 否 | integer | 5 | 站点ID，天猫：10，京东：5 |
| topN | 否 | integer | 100 | 限制个数（默认100） |
4.2RequestCategoryItemMetrics #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| additionalDimensions | 否 | array | ["siteName"] | 追加的聚合字段。支持：siteName |
| categoryLevel | 否 | integer | 3 | 聚合的品类层级 |
| filterOtherLevel | 否 | boolean | true | 是否过滤其他层级(比如根据第三级聚合时将第一、第二层级数据过滤) |
| order | 否 | string | desc | 排序方式：asc（升序）、desc（降序） |
| sort | 否 | string | "monthSaleCnt" | 排序字段：monthSaleCnt(自然月销量)、monthSaleAmount(自然月销售额)，非法参数会报错 |
4.3ResponseDataOfCategoryLevelItemMetricVo #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | [Array of CategoryLevelItemMetricVo,Array of CategoryLevelItemMetricVo] | （见接口请求示例） 返回数据集，不同接口返回结果的格式不一样 | |
| dorisTime | 否 | integer | "458" | 查询Doris耗时,单位毫秒 |
| meta | 否 | array | "list" | 返回数据格式：list、aggregation、graph |
| page | 否 | integer | 1 | 分页查询的页码 |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
| time | 否 | integer | "955" | 查询总耗时，单位毫秒 |
| total | 否 | integer | "34500230" | 查询数据总量 |
4.3.1CategoryLevelItemMetricVo #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| fifthCategoryName | 否 | string | "899" | 五级品类名称 |
| firstCategoryName | 否 | string | "899" | 一级品类名称 |
| fourthCategoryName | 否 | string | "899" | 四级品类名称 |
| monthSaleAmount | 否 | number | "89900.85" | 自然月销售额 |
| monthSaleAmountRateLp | 否 | number | "0.04209" | 自然月销售额环比 |
| monthSaleCnt | 否 | integer | "899" | 自然月销量 |
| monthSaleCntRateLp | 否 | number | "0.02482" | 自然月销量环比 |
| monthSalePrice | 否 | number | "899.66" | 自然月售价 |
| secondCategoryName | 否 | string | "899" | 二级品类名称 |
| thirdCategoryName | 否 | string | "899" | 三级品类名称 |
5. 示例 #
示例1 查看每个品类下的子品类销售数据详情 #
输入示例
{
"appkey": "predeploy",
"filters": {
"categoryNames": [
"string"
],
"optionalFields": [
"monthSaleCntLp",
"monthSaleAmountLp"
],
"queryDate": {
"end": 1635695999000,
"start": 1627747200000
},
"topN": 100
},
"metrics": {
"categoryLevel": 3,
"filterOtherLevel": true,
"order": "desc",
"sort": "monthSaleCnt"
},
"openStrategy": false,
"page": 1,
"pageSize": 20
}输出示例
{
"code": 0,
"data": {
"dataset": [
{
"fifthCategoryName": 899,
"firstCategoryName": 899,
"fourthCategoryName": 899,
"monthSaleAmount": 89900.85,
"monthSaleAmountRateLp": 0.04209,
"monthSaleCnt": 899,
"monthSaleCntRateLp": 0.02482,
"monthSalePrice": 899.66,
"secondCategoryName": 899,
"thirdCategoryName": 899
}
],
"dorisTime": 458,
"meta": {
"datasetType": "list"
},
"page": 1,
"pageSize": 20,
"time": 955,
"total": 34500230
},
"msg": "接口返回成功！",
"openStrategy": false,
"success": true
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
| 状态码 | 描述 |
|---|---|