本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.ecommerce.comment.metric
请求方式：POST
描述：通过该接口可查看电商商品的评论数据详情，包括：品牌、品类、评论记录数、站点名、站点ID等等，具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见?公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | Array of RequestCommentFilters | (见接口示例) | 查询过滤条件 | |
| metrics | 否 | Array of RequestBaseMetrics | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 | |
| page | 否 | integer | 1 | 分页查询的页码，默认1 | |
| pageSize | 否 | integer | 20 | 分页查询的单页数据条数，默认20 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | Array of ResponseDataOfCommentMetric | (见接口示例) | 查询过滤条件 |
| msg | 否 | string | "借口返回成功!" | 接口返回信息说明，在接口返回失败时会有 |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
| success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestCommentFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| brandId | 否 | integer | 68 | 品牌名ID |
| brandName | 否 | string | "小米" | 品牌名 |
| categoryId | 否 | integer | "68" | 品类id |
| categoryIds | 否 | list | [5643,6515,6519,6521] | 品类ID |
| categoryName | 否 | string | "奶粉" | 品类标准名。注：仅支持末级品类，该参数准备废弃，建议使用spCategoryNames |
| spCategoryName | 否 | string | "3c数码" | 品类标准名(查询该品类下所有的子品类) |
| spCategoryNames | 否 | array | ["3C数码"] | 品类标准名列表(查询该品类下所有的子品类)。注：优先级高于spCategoryName |
| publishDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 评论发表时间 |
| siteId | 否 | integer | 5 | 站点ID，天猫：10，京东：5 |
| shopName | 否 | string | "修丽可官方旗舰店" | 店铺名称 |
| skuId | 否 | long | "637338326057" | 商品SkuId |
| title | 否 | string | "苹果8plus" | 商品标题，不传则查询时不限制商品标题 |
4.2 RequestBaseMetrics #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| categoryLevel | 否 | integer | 5 | 品类聚合的层级粒度，范围1—5，5代表最末级，默认5 |
| dimensions | 否 | array | "list" | agg查询维度字段，用于查询数据分布、趋势（例如基于品牌），仅支持开放的字段：categoryName（品类）、brandName（品牌）、siteName（站点）、skuId（商品id）、date（发表时间、采集时间），非法参数会报错 |
| interval | 否 | string | "month" | 发表时间agg查询时间单位，默认：month(目前仅支持month)，非法参数会报错 |
| order | 否 | string | "desc" | 排序方式：asc(升序)、desc(降序)，非法参数会报错 |
| sort | 否 | string | "totalCnt" | 排序字段：totalCnt(记录数)，非法参数会报错 |
4.3 ResponseMeta #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | array of CommentMetric | (见接口示例) | 查询过滤条件 |
| 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 CommentMetric #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| brandId | 否 | string | "10622" | 品牌ID |
| brandName | 否 | string | "苹果" | 品牌名称 |
| categoryId | 否 | integer | "10621" | 末级品类ID |
| categoryName | 否 | string | "洗发水" | 末级品类名称 |
| firstCategoryName | 否 | string | "洗发水" | 一级品类名称 |
| fourthCategoryName | 否 | string | "洗发水" | 四级品类名称 |
| publishDate | 否 | string | "2022-01" | 发表时间，格式化为月 |
| secondCategoryName | 否 | string | "洗发水" | 二级品类名称 |
| shopId | 否 | string | "106269063" | 店铺id |
| shopName | 否 | string | "秉迪数码专营店" | 店铺名称 |
| skuId | 否 | long | "526498885740" | 商品Sku_Id |
| thirdCategoryName | 否 | string | "洗发水" | 三级品类名称 |
| totalCnt | 否 | integer | "17899" | 记录数，表示评论记录数 |
5. 示例 #
示例1 查看品类和品牌下的评论详情 #
查看某个品类品牌某个时间段内的评论数据。
输入示例
{
"appkey": "predeploy",
"filters": {
"categoryName": "手机"
},
"metrics": {
"dimensions": [
"brandName"
],
"interval": "month",
"order": "desc",
"sort": "totalCnt"
},
"openStrategy": false,
"page": 1,
"pageSize": 1000
}输出示例
{
"brandName": "知了",
"totalCnt": 19
},
{
"brandName": "东风风神",
"totalCnt": 19
},
{
"brandName": "红鸟",
"totalCnt": 19
},
{
"brandName": "ickb",
"totalCnt": 19
},
{
"brandName": "品色",
"totalCnt": 19
},
{
"brandName": "德业",
"totalCnt": 19
},
{
"brandName": "帕萨特",
"totalCnt": 19
},
{
"brandName": "Bone",
"totalCnt": 19
},
{
"brandName": "skullcandy",
"totalCnt": 19
},
{
"brandName": "快麦",
"totalCnt": 19
},
{
"brandName": "天锐",
"totalCnt": 19
},
{
"brandName": "机乐堂",
"totalCnt": 19
},
{
"brandName": "益博思",
"totalCnt": 18
},
{
"brandName": "魏派",
"totalCnt": 18
},
{
"brandName": "瑞雪",
"totalCnt": 18
},
{
"brandName": "艾利和",
"totalCnt": 18
},
{
"brandName": "上汽通用",
"totalCnt": 18
},
{
"brandName": "蜻蜓FM",
"totalCnt": 18
},
{
"brandName": "星瑞",
"totalCnt": 18
},
{
"brandName": "小鹏",
"totalCnt": 18
},
{
"brandName": "古尚古",
"totalCnt": 18
},
{
"brandName": "力勤",
"totalCnt": 18
},
{
"brandName": "德甲士",
"totalCnt": 18
},
{
"brandName": "柏奈儿",
"totalCnt": 18
},
{
"brandName": "猛玛",
"totalCnt": 18
},
{
"brandName": "HK",
"totalCnt": 18
},
{
"brandName": "艾特铭客",
"totalCnt": 18
},
{
"brandName": "欧创",
"totalCnt": 18
},
{
"brandName": "讯迪",
"totalCnt": 18
},
{
"brandName": "帕拉梅拉",
"totalCnt": 17
},
{
"brandName": "星派",
"totalCnt": 17
},
{
"brandName": "英朗",
"totalCnt": 17
},
{
"brandName": "东风英菲尼迪",
"totalCnt": 17
},
{
"brandName": "诺西",
"totalCnt": 17
},
{
"brandName": "喜多宝",
"totalCnt": 17
},
{
"brandName": "山狗",
"totalCnt": 17
},
{
"brandName": "奥妙",
"totalCnt": 17
},
{
"brandName": "小度",
"totalCnt": 17
},
{
"brandName": "劲捷",
"totalCnt": 17
},
{
"brandName": "西伯利亚",
"totalCnt": 17
},
{
"brandName": "华润",
"totalCnt": 16
},
{
"brandName": "铠侠",
"totalCnt": 16
},
{
"brandName": "征拓",
"totalCnt": 16
},
{
"brandName": "汉王",
"totalCnt": 16
},
{
"brandName": "途观",
"totalCnt": 16
},
{
"brandName": "韵达",
"totalCnt": 16
},
{
"brandName": "instagram",
"totalCnt": 16
},
{
"brandName": "万利达",
"totalCnt": 16
},
{
"brandName": "海氏",
"totalCnt": 16
},
{
"brandName": "CMP",
"totalCnt": 16
},
{
"brandName": "楠思",
"totalCnt": 15
},
{
"brandName": "结义",
"totalCnt": 15
},
{
"brandName": "米乐奇",
"totalCnt": 15
},
{
"brandName": "林肯",
"totalCnt": 15
},
{
"brandName": "恒阳",
"totalCnt": 15
},
{
"brandName": "丽能",
"totalCnt": 15
},
{
"brandName": "精臣",
"totalCnt": 14
},
{
"brandName": "雷凌",
"totalCnt": 14
},
{
"brandName": "JOBY",
"totalCnt": 14
},
{
"brandName": "炫彩",
"totalCnt": 14
},
{
"brandName": "ZMI",
"totalCnt": 13
},
{
"brandName": "卡宴",
"totalCnt": 13
},
{
"brandName": "阿卡西斯",
"totalCnt": 13
},
{
"brandName": "宏太",
"totalCnt": 13
},
{
"brandName": "Hamee",
"totalCnt": 13
},
{
"brandName": "诺必行",
"totalCnt": 13
},
{
"brandName": "松下",
"totalCnt": 13
},
{
"brandName": "冇心",
"totalCnt": 12
},
{
"brandName": "宏光",
"totalCnt": 12
},
{
"brandName": "莱维特",
"totalCnt": 12
},
{
"brandName": "蔚来",
"totalCnt": 12
},
{
"brandName": "世达",
"totalCnt": 12
},
{
"brandName": "戴尔",
"totalCnt": 12
},
{
"brandName": "狂热者",
"totalCnt": 12
},
{
"brandName": "映客",
"totalCnt": 11
},
{
"brandName": "品爱",
"totalCnt": 11
},
{
"brandName": "谷歌",
"totalCnt": 11
},
{
"brandName": "百图",
"totalCnt": 11
},
{
"brandName": "Polaroid",
"totalCnt": 11
},
{
"brandName": "a1",
"totalCnt": 11
},
{
"brandName": "十度",
"totalCnt": 11
},
{
"brandName": "RSR",
"totalCnt": 10
},
{
"brandName": "东风标致",
"totalCnt": 10
},
{
"brandName": "Max Mara",
"totalCnt": 10
},
{
"brandName": "凯迪拉克",
"totalCnt": 10
},
{
"brandName": "钻盾",
"totalCnt": 10
},
{
"brandName": "NEO",
"totalCnt": 10
},
{
"brandName": "逍客",
"totalCnt": 10
},
{
"brandName": "酷奇",
"totalCnt": 9
},
{
"brandName": "西部数据",
"totalCnt": 9
},
{
"brandName": "哔哩哔哩",
"totalCnt": 9
},
{
"brandName": "麦克赛尔",
"totalCnt": 9
},
{
"brandName": "steam",
"totalCnt": 9
},
{
"brandName": "幻响",
"totalCnt": 9
},
{
"brandName": "猛豹",
"totalCnt": 8
},
{
"brandName": "AP",
"totalCnt": 8
},
{
"brandName": "博卡",
"totalCnt": 8
},
{
"brandName": "优利康",
"totalCnt": 8
},
{
"brandName": "力飞",
"totalCnt": 8
},
{
"brandName": "富德",
"totalCnt": 8
},
{
"brandName": "QDC",
"totalCnt": 8
},
{
"brandName": "TCL",
"totalCnt": 8
},
{
"brandName": "金田",
"totalCnt": 8
},
{
"brandName": "网易云音乐",
"totalCnt": 7
},
{
"brandName": "赛腾",
"totalCnt": 7
},
{
"brandName": "乐享",
"totalCnt": 7
},
{
"brandName": "舒尔",
"totalCnt": 7
},
{
"brandName": "谜姬",
"totalCnt": 7
},
{
"brandName": "九猫",
"totalCnt": 7
},
{
"brandName": "凌度",
"totalCnt": 6
},
{
"brandName": "酷博",
"totalCnt": 6
},
{
"brandName": "NT",
"totalCnt": 6
},
{
"brandName": "爱图仕",
"totalCnt": 6
},
{
"brandName": "动森",
"totalCnt": 6
},
{
"brandName": "晟崴",
"totalCnt": 5
},
{
"brandName": "康纽莱",
"totalCnt": 5
},
{
"brandName": "瑞昱",
"totalCnt": 5
},
{
"brandName": "惠威",
"totalCnt": 5
},
{
"brandName": "致旗",
"totalCnt": 5
},
{
"brandName": "臻迪",
"totalCnt": 5
},
{
"brandName": "FANBIYA",
"totalCnt": 5
},
{
"brandName": "卓美",
"totalCnt": 4
},
{
"brandName": "欧奔",
"totalCnt": 4
},
{
"brandName": "小寻",
"totalCnt": 4
},
{
"brandName": "蓝盛",
"totalCnt": 4
},
{
"brandName": "艾美特",
"totalCnt": 4
},
{
"brandName": "海贝",
"totalCnt": 4
},
{
"brandName": "贝贝佳",
"totalCnt": 4
},
{
"brandName": "传奇之路",
"totalCnt": 4
},
{
"brandName": "HTC",
"totalCnt": 3
},
{
"brandName": "正大",
"totalCnt": 3
},
{
"brandName": "GOOVIS",
"totalCnt": 3
},
{
"brandName": "金鸽",
"totalCnt": 3
},
{
"brandName": "悦尔法",
"totalCnt": 3
},
{
"brandName": "希捷",
"totalCnt": 3
},
{
"brandName": "宝来",
"totalCnt": 3
},
{
"brandName": "山泽",
"totalCnt": 3
},
{
"brandName": "沙宣",
"totalCnt": 2
},
{
"brandName": "蓝悦",
"totalCnt": 2
},
{
"brandName": "凯立",
"totalCnt": 2
},
{
"brandName": "XM",
"totalCnt": 1
},
{
"brandName": "网易",
"totalCnt": 1
},
{
"brandName": "艾苏恩",
"totalCnt": 1
},
{
"brandName": "涂鸦智能",
"totalCnt": 1
},
{
"brandName": "豌豆荚",
"totalCnt": 1
},
{
"brandName": "AMI",
"totalCnt": 1
},
{
"brandName": "德兰",
"totalCnt": 1
},
{
"brandName": "3M",
"totalCnt": 1
},
{
"brandName": "永诺",
"totalCnt": 1
},
{
"brandName": "朗玛",
"totalCnt": 1
},
{
"brandName": "自由光",
"totalCnt": 1
}
],
"pageSize": 1000,
"page": 1,
"total": 597,
"time": 2445
}
}6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
| 状态码 | 描述 |
|---|---|