本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.ecommerce.comment.triple.high-frequency-word
请求方式：POST
描述：通过该接口可查看电商商品的评论数据三元组特征词词云，具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见?公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| filters | 是 | Array of RequestCommentHighFrequencyWordFilters | (见接口示例) | 查询过滤条件 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | Array of ResponseDataOfCommentHighFrequencyWordVo | (见接口示例) | 查询过滤条件 |
| msg | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
| success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestCommentHighFrequencyWordFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| brandName | 否 | string | "小米" | 品牌名 |
| categoryIds | 否 | list | [5643,6515,6519,6521] | 品类ID |
| categoryName | 否 | string | "奶粉" | 品类标准名。注：仅支持末级品类，该参数准备废弃，建议使用spCategoryNames |
| commodityNames | 否 | array | ["大宝男士磁力净痘洁面泥"] | 标准商品名称列表 |
| spCategoryName | 否 | string | 3C数码 | 品类标准名(查询该品类下所有的子品类) |
| spCategoryNames | 否 | array | ["3C数码"] | 品类标准名列表(查询该品类下所有的子品类)。注：优先级高于spCategoryName |
| tripleDimension | 否 | string | 效果 | 三元组一级维度名 |
| tripleProperty | 否 | string | 抗皱/抗氧化 | 三元组二级维度名 |
| sentimentPolarity | 否 | integer | 1 | 三元组情感，-1-负面/0-中性/1-正面 |
| publishDate | 是 | array | {"end":1635695999000,"start":1627747200000} | 评论发表时间 |
| siteId | 否 | integer | 5 | 站点ID，天猫：10，京东：5 |
| skuId | 否 | integer | "637338326057" | 商品SkuId |
| title | 否 | string | "苹果8plus" | 商品标题，不传则查询时不限制商品标题 |
| topN | 否 | integer | "100" | 高频词TopN |
4.2 ResponseDataOfCommentHighFrequencyWordVo #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | array | [{"keyword":"质量很好","frequencyCnt":14},{"keyword":"客服服务很好","frequencyCnt":11},{"keyword":"清晰","frequencyCnt":10}] | 返回数据集 |
| meta | 否 | object | {"datasetType":"list"} | 返回数据格式：list、aggregation、graph |
| time | 否 | integer | 420 | 查询总耗时，单位毫秒 |
| total | 否 | integer | 1 | 查询数据总量 |
5. 示例 #
示例1 查询标准商品下正面三元组情感的三元组特征词词云 #
输入示例
{
"filters":
{
"commodityNames": ["海信激光电视75L5G"],
"sentimentPolarity": 1,
"topN": 3
}
}输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功！",
"data": {
"meta": {
"datasetType": "list"
},
"dataset": [
{
"keyword": "质量很好",
"frequencyCnt": 14
},
{
"keyword": "客服服务很好",
"frequencyCnt": 11
},
{
"keyword": "清晰",
"frequencyCnt": 10
}
],
"total": 1,
"time": 830
},
"message": null
}6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
| 状态码 | 描述 |
|---|---|