品牌指标汇总

本页内容

1. 接口描述 #

接口URL：https://open.datastory.com.cn/api/datastory.knowledge.brand.indicator
请求方式：POST
描述：通过该接口可查询弹性知识服务的品牌指标数据，包括：发表时间、声量、互动量、nsr等等，具体输出内容可查看输出参数示例。

2. 输入参数 #

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 默认值 类型 参数示例 描述
appkey 否 string "predeploy" 权限校验标识
filters 是 RequestBrandIndicatorFilters (见接口示例) 查询过滤条件
matrix 否 RequestBrandIndicatorMatrix (见接口示例) 查询聚合、分页条件
openStrategy 否 boolean false 是否接受缓存

3. 输出参数 #

参数名称 必选 类型 参数示例 描述
code 否 integer 0 返回状态码，内部定义
data 否 ResponseData (见接口示例) 返回数据结果，包含meta、dataset
message 否 string "接口返回成功！" 接口返回信息说明，在接口返回失败时会有

4. 数据结构 #

4.1 RequestltemFilters #

参数名 必选 类型 参数示例 描述
publishTimestampLower 是 long 1672502400000 查询开始时间戳
publishTimestampUpper 是 long 1677513600000 查询结束时间戳
brandNames 是 array ["雅诗兰黛"] 品牌名，支持传多个
categoryNames 否 array ["护肤"] 品类名，(不限层级,但此接口支持传单个品类）
catNames 否 array ["问答","论坛","视频","短视频","小红书","新闻","微博","微信"] 阵地名，可选的都已列举
catIds 否 array [7,3,4,12,2,10,1,9] 阵地id，与catNames二选一即可
siteNames 否 array ["知乎","快手app","今日头条","抖音app","火山小视频","小红书","新浪微博","哔哩哔哩"] 站点名（目前只是MVP热门话题页面联动话题词用到）
siteIds 否 array [101944,1334510,1001569,1003583,1011469,146510,101993,44] 站点id，与siteNames二选一即可
sentimentNames 否 array ["正面","负面","中性"] 情感类型名，可选的都已列举
sentiments 否 array [1,0,-1] 情感，与sentimentNames二选一即可
volumeTypeNames 否 array ["PGC","UGC","BGC"] 声量类型名，可选的都已列举
volumeTypes 否 array [1,2,3] 声量类型，与volumeTypeNames二选一即可
volumeQualityNames 否 array ["自发创作","追星文","其它","内容营销广告","新闻公关","垃圾广告"] 声量质量名，可选的都已列举
volumeQualities 否 array [10,7,9] 声量质量，与volumeQualityNames二选一即可

4.2 RequestBaseMatrix #

参数名 必选 类型 参数示例 描述
dimensions 是 array [ "brandName","catId" ] 需要聚合的维度：publishDate、catId、siteId、sentiment、volumeQuality、volumeType、brandName，非法参数会报错
metrics 是 array ["volumeCnt","interactionCnt"] 需要查询的指标数据集：volumeCnt（声量）、interactionCnt（互动量）、nsr（NSR）、interactionRate（互动率）、psr、posVolumeRate（正面率）、negVolumeRate（负面率）
interval 否 string "month" 发表时间agg查询时间单位，默认：day,仅支持：day、week、month、quarter，（目前没用到，可忽略）
order 否 string "DESC" 排序方式：ASC(升序)、DESC(降序)，非法参数会报错
sort 否 string "volumeCnt" 排序字段,使用metrics查询的字段排序，非法参数会报错
currentPage 否 integer 1 分页查询的页码(查全部可不传)
pageSize 否 integer 20 分页查询的单页数据条数(查全部可不传)

4.3 ResponseData #

参数名 必选 类型 参数示例 描述
dataset 否 ResponseDataset (见接口请求示例) 返回数据集，不同接口返回结果的格式不一样
dorisTime 否 integer "458" 查询Doris耗时，单位毫秒
meta 否 object "list" 返回数据的描述信息，主要是字段信息，非方舟接口，请忽略
time 否 integer "955" 查询总耗时，单位毫秒

4.3.1 ResponseDataset #

参数名 必选 类型 参数示例 描述
total 否 integer "34500230" 查询数据总量
currentPage 否 integer 1 分页查询的页码
pageSize 否 integer "20" 分页查询的单页数据条数
rowdata 否 BrandIndicatorVO (见接口请求示例) 返回数据集，不同接口返回结果的格式不一样

4.3.2 BrandIndicatorVO #

参数名 必选 类型 参数示例 描述
brandName 否 string "雅诗兰黛" 品牌名
catId 否 integer 9 阵地id
catName 否 string "微博" 阵地
siteId 否 integer "101993" 站点ID
siteName 否 string "新浪微博" 站点名称
publishDate 否 string "2023-01-01" 发表时间
volumeTypeName 否 string "UGC" 声量类型，UGC：普通用户，PGC：专业用户，BGC：品牌官方账号
volumeType 否 int 2 阵地id
volumeQualityName 否 string "新闻公关" 声量质量名
volumeQuality 否 int 2 声量质量id
sentimentName 否 string "正面" 情感
sentiment 否 int 2 情感id
volumeCnt 否 long 2 声量值
interactionCnt 否 long 2 互动量
nsr 否 number 2 NSR(正面情感值-负面情感值)/(正面情感值+负面情感值)
interactionRate 否 number 2 互动率
psr 否 number 2 PSR正面情感值/(正面情感值+负面情感值)

5. 示例 #

示例1 查看品牌在每个阵地每天的声量趋势 #

输入示例

{
    "filters": {
        "publishTimestampLower": 1672502400000,
        "publishTimestampUpper": 1677513600000,
        "catNames": [
            "问答",
            "论坛",
            "视频",
            "短视频",
            "小红书",
            "新闻",
            "微博",
            "微信"
        ],
        "brandNames": [
            "迪奥"
        ],
        "sentimentNames": [
            "正面",
            "负面",
            "中性"
        ],
        "volumeTypeNames": [
            "PGC",
            "UGC",
            "BGC"
        ],
        "volumeQualityNames": [
            "自发创作",
            "追星文",
            "其它",
            "内容营销广告",
            "新闻公关",
            "垃圾广告"
        ],
        "needResMeta": false
    },
    "matrix": {
        "dimensions": [
            "publishDate",
            "catId"
        ],
        "metrics": [
            "volumeCnt",
            "interactionCnt"
        ],
        "sort": "volumeCnt",
        "order": "DESC"
    }
}

输出示例

{
    "code": 20000,
    "message": "success",
    "data": {
        "dataset": {
            "total": 0,
            "pageSize": 0,
            "currentPage": 0,
            "rowdata": [
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-25",
                    "volumeCnt": 3194092,
                    "interactionCnt": 14795114
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-01-25",
                    "volumeCnt": 3013884,
                    "interactionCnt": 12941202
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-01-26",
                    "volumeCnt": 2528805,
                    "interactionCnt": 9703922
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-01-20",
                    "volumeCnt": 2503559,
                    "interactionCnt": 11187266
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-06",
                    "volumeCnt": 2503341,
                    "interactionCnt": 12564371
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-26",
                    "volumeCnt": 2198569,
                    "interactionCnt": 3954229
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-24",
                    "volumeCnt": 2112494,
                    "interactionCnt": 4955310
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-21",
                    "volumeCnt": 2006784,
                    "interactionCnt": 3904021
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-23",
                    "volumeCnt": 1871437,
                    "interactionCnt": 5764120
                },
                {
                    "catId": 9,
                    "catName": "微博",
                    "publishDate": "2023-02-05",
                    "volumeCnt": 1856491,
                    "interactionCnt": 2476587
                }
            ]
        },
        "time": 136,
        "dorisTime": 136
    }
}

6. 状态码 #

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

状态码 描述