参数名称	必选	类型	参数示例	描述
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	["大宝男士磁力净痘洁面泥"]	标准商品名称列表
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", "sentimentPolarity"]	agg查询维度字段，仅支持开放的字段：brandName（品牌）、categoryName（品类）、commodityName（标品）、siteName（站点）、skuId（商品id）、date（发表时间、采集时间）、sentimentPolarity（通用情感极性），非法参数会报错
interval	否	string	day	发表时间agg查询时间单位，默认：day。当前仅支持day和month

4.3 ResponseData

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

4.3.1 CommentGenericSentimentMetrics

参数名	必选	类型	参数示例	描述
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	正面	通用情感极性
commentCnt	否	integer	17899	评论记录数（声量）
nsr	否	string	85.68%	通用情感NSR，保留2位小数

5. 示例

示例1 查看标准商品名的评论通用情感汇总详情

输入示例

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

输出示例

{
    "success": true,
    "openStrategy": false,
    "code": 0,
    "msg": "接口返回成功！",
    "data": {
        "meta": {
            "datasetType": "aggregation"
        },
        "dataset": [
            {
                "siteId": 10,
                "siteName": "天猫",
                "metricDate": "2023-09-29",
                "commentCnt": 3,
                "nsr": "100%"
            },
            {
                "siteId": 10,
                "siteName": "天猫",
                "metricDate": "2023-09-28",
                "commentCnt": 13,
                "nsr": "100%"
            },
            {
                "siteId": 10,
                "siteName": "天猫",
                "metricDate": "2023-09-27",
                "commentCnt": 3,
                "nsr": "100%"
            },
            {
                "siteId": 10,
                "siteName": "天猫",
                "metricDate": "2023-09-26",
                "commentCnt": 4,
                "nsr": "100%"
            },
            {
                "siteId": 5,
                "siteName": "京东",
                "metricDate": "2023-09-26",
                "commentCnt": 2,
                "nsr": "100%"
            }
        ],
        "pageSize": 5,
        "page": 1,
        "total": 38,
        "time": 510
    },
    "message": null
}

6. 状态码

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

状态码	描述