Logo
    立即注册
    开放平台
    产品文档
    评论三元组情感数据汇总
    最近更新时间:2023-10-26 16:39:18

    1. 接口描述

    接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.comment.metric.by.triple.sentiment 请求方式:POST

    描述:通过该接口可查看电商商品的评论数据汇总详情,包括:品牌、品类、评论记录数、站点名、站点ID、三元组情感相关等等,具体输出内容可查看输出参数示例。

    2. 输入参数

    参数名称 必选 默认值 类型 参数示例 描述
    appkey string predeploy 权限校验标识
    filters RequestCommentSentimentFilters (见接口示例) 查询过滤条件
    metrics RequestBaseMetrics (见接口示例) 查询过滤条件
    openStrategy boolean false 是否接受缓存
    page integer 1 分页查询的页码,默认1
    pageSize integer 100 分页查询的单页数据条数,默认100

    3. 输出参数

    参数名称 必选 类型 参数示例 描述
    code integer 0 返回状态码,内部定义
    data ResponseData (见接口示例) 结果
    msg string 接口返回成功! 接口返回信息说明,在接口返回失败时会有
    openStrategy boolean false 是否接受缓存
    success boolean true 接口返回是否成功

    4. 数据结构

    4.1 RequestCommentSentimentFilters

    参数名 必选 类型 参数示例 描述
    brandId integer 68 品牌名ID
    brandName string 小米 品牌名
    categoryId integer 68 品类id
    categoryIds array [5643,6515,6519,6521] 品类ID
    categoryName string 奶粉 品类标准名 。注:仅支持末级品类,该参数准备废弃,建议使用spCategoryNames
    spCategoryName string 3c数码 品类标准名(查询该品类下所有的子品类)
    spCategoryNames array ["3C数码"] 品类标准名列表(查询该品类下所有的子品类)。注:优先级高于spCategoryName
    commodityNames array ["大宝男士磁力净痘洁面泥"] 标准商品名称列表
    tripleDimension string 效果 三元组一级维度
    tripleProperty string 抗皱/抗氧化 三元组二级维度
    sentimentPolarity integer 1 三元组情感,-1-负面/0-中性/1-正面
    publishDate object {"end":1635695999000,"start":1627747200000} 评论发表时间
    siteId integer 5 站点ID,天猫:10,京东:5
    skuId long 637338326057 商品SkuId

    4.2 RequestBaseMetrics

    参数名 必选 类型 参数示例 描述
    categoryLevel integer 5 品类聚合的层级粒度,范围1—5,5代表最末级,默认5
    dimensions array ["siteName", "date", "tripleDimension", "sentimentPolarity"] agg查询维度字段,仅支持开放的字段:brandName(品牌)、categoryName(品类)、commodityName(标品)、siteName(站点)、skuId(商品id)、date(发表时间、采集时间)、tripleDimension(三元组一级维度)、tripleProperty(三元组二级维度)、sentimentPolarity(三元组情感极性),非法参数会报错
    interval string day 发表时间agg查询时间单位,默认:day。当前仅支持day和month

    4.3 ResponseData

    参数名 必选 类型 参数示例 描述
    dataset array of CommentTripleSentimentMetrics (见接口示例) 结果集
    meta object {"datasetType":"aggregation"} 返回数据格式:list、aggregation、graph
    page integer 1 分页查询的页码
    pageSize integer 20 分页查询的单页数据条数
    time integer 955 查询总耗时,单位毫秒
    total integer 34500230 查询数据总量

    4.3.1 CommentTripleSentimentMetrics

    参数名 必选 类型 参数示例 描述
    brandId string 10622 品牌ID
    brandName string 苹果 品牌名称
    categoryId integer 10621 末级品类ID
    categoryName string 洗发水 末级品类名称
    firstCategoryId integer 1 一级品类Id
    firstCategoryName string 美妆个护 一级品类名称
    secondCategoryId integer 43 二级品类Id
    secondCategoryName string 个护 二级品类名称
    thirdCategoryId integer 4312 三级品类Id
    thirdCategoryName string 美发护发 三级品类名称
    fourthCategoryId integer 232443 四级品类Id
    fourthCategoryName string 洗发 四级品类名称
    metricDate string 2022-01 汇总时间,格式化为月
    skuId long 526498885740 商品Sku_Id
    title string iPad保护套 商品标题
    commodityId integer 4670 产品id
    commodityName string 雅诗兰黛DW持妆粉底液 产品名
    siteId integer 10 站点id
    siteName string 天猫 站点名称
    sentimentPolarity string 正面 三元组情感极性
    tripleDimension string 效果 三元组一级维度
    tripleProperty string 抗皱/抗氧化 三元组二级维度
    commentCnt integer 17899 评论记录数(声量)
    nsr string 85.68% 三元组情感NSR,保留2位小数

    5. 示例

    示例1 查看标准商品名的评论三元组情感汇总详情

    输入示例

    {
        "filters":
        {
           "publishDate": {
               "start": 1693497600000,
               "end": 1696003200000
           },
           "commodityNames": ["海信激光电视75L5G"],
           "tripleFeature": "画面清晰"
        },
        "metrics": {
            "dimensions": ["siteName", "date", "tripleDimension", "sentimentPolarity"]
        },
        "page": 1,
        "pageSize": 5
    }

    输出示例

    {
        "success": true,
        "openStrategy": false,
        "code": 0,
        "msg": "接口返回成功!",
        "data": {
            "meta": {
                "datasetType": "aggregation"
            },
            "dataset": [
                {
                    "siteId": 10,
                    "siteName": "天猫",
                    "metricDate": "2023-09-29",
                    "sentimentPolarity": "正面",
                    "commentCnt": 2,
                    "nsr": "100%",
                    "tripleDimension": "感官"
                },
                {
                    "siteId": 10,
                    "siteName": "天猫",
                    "metricDate": "2023-09-29",
                    "sentimentPolarity": "正面",
                    "commentCnt": 1,
                    "nsr": "100%",
                    "tripleDimension": "产品质量"
                },
                {
                    "siteId": 10,
                    "siteName": "天猫",
                    "metricDate": "2023-09-29",
                    "sentimentPolarity": "正面",
                    "commentCnt": 1,
                    "nsr": "100%",
                    "tripleDimension": "使用"
                },
                {
                    "siteId": 10,
                    "siteName": "天猫",
                    "metricDate": "2023-09-29",
                    "sentimentPolarity": "正面",
                    "commentCnt": 1,
                    "nsr": "100%",
                    "tripleDimension": "卖家"
                },
                {
                    "siteId": 10,
                    "siteName": "天猫",
                    "metricDate": "2023-09-28",
                    "sentimentPolarity": "正面",
                    "commentCnt": 6,
                    "nsr": "100%",
                    "tripleDimension": "价格"
                }
            ],
            "pageSize": 5,
            "page": 1,
            "total": 110,
            "time": 638
        },
        "message": null
    }

    6. 状态码

    以下仅列出了接口业务逻辑相关的状态码。

    状态码 描述

    微信扫描二维码在线咨询