消息服务总线3.0在线接口文档
  1. 3、发文分析相关接口
消息服务总线3.0在线接口文档
  • 1、服务总线-字典接口组
    • 1、国家英文码值对照相关接口
      • 1)国家三字英文码值对照列表
      • 2)根据三字英文码值获取国家名称列表
    • 2、ISO 639语言编码相关接口
      • 1)ISO 639语言编码信息列表
      • 2)指定Code集合获取名称和简称
    • 3、媒体类型相关接口
      • 1)指定境内外类型查询媒体类型【树型结构】
      • 2)指定Code集合获取名称
      • 3)指定Code集合获取字段
      • 4)根据地域查询渠道信息
    • 4、地域相关接口
      • 1)指定区域父级节点查询子集(中国)
      • 2)查询地域树(全国)
      • 3)内容提及查询
      • 4)内容提及-指定区域父级节点查询子集
    • 5、媒体信源标签相关接口
      • 1)媒体标签信息TOP25
      • 2)分页检索媒体标签列表
    • 6、标签相关接口
      • 1)标签根节点列表查询
      • 2)指定标签上一级唯一值查询该标签下子集列表
      • 3)指定标签层级查询该层级下子标签列表
    • 7、分类相关接口
      • 1)分类列表查询
  • 2、消息服务-业务接口组
    • 1、发文检索相关接口
      • 1)分页检索发文信息列表
      • 2)检索发文详情信息
      • 3)通过uuid批量查询发文信息列表
      • 4)相似文章列表查询
      • 5)获取渠道发文转发/评论关系
      • 6)根据文章ID分页获取评论列表
      • 7)Scroll创建接口
      • 8)ScrollID查询接口
      • 9)ScrollID删除接口
      • 10)根据uuid获取OCR信息
      • 11)OCR内容识别
      • 12)相似文章列表查询
    • 2、媒体账号检索相关接口
      • 附件说明
        • 境内账号字段值对应说明
        • 境外账号字段值对应说明
      • 1)分页检索媒体账号信息列表
      • 2)检索媒体账号详情信息
      • 3)根据渠道和账号ID查询是否采集该媒体账号信息
    • 3、发文分析相关接口
      • 1)通用-数据总量获取
        POST
      • 2)通用-指定分析字段返回其中某一种聚合分析
        POST
      • 3)通用-指定分析字段返回所有聚合分析
        POST
      • 4)通用-指定两个分析字段返回其中某一种聚合分析
        POST
      • 5)通用-指定字段分析日期直方图聚合
        POST
      • 6)通用-指定字段聚合和指定字段排序返回对应Top数据信息
        POST
      • 7)通用-数据字段累计求和获取
        POST
      • 8)通用-指定两个分析字段分析日期直方图聚合
        POST
      • 9)指定语义指纹获取数据量
        POST
      • 10)通用-各互动量字段总和获取
        POST
      • 11)通用-指定度量字段去重统计
        POST
      • 12)通用-指定分析字段返回其中某一种去重统计聚合分析
        POST
      • 13)通用-指定分析字段返回COUNT和SUM聚合分析
        POST
      • 14)指定渠道和发布时间字段分析日期直方图聚合
        POST
    • 4、媒体账号分析相关接口
      • 1)通用-账号总量获取
    • 5、热榜相关接口
      • 附件说明
        • 不同渠道对应同城热榜信息采集情况说明
      • 1)热搜榜信息检索
      • 2)实时热搜榜信息
      • 3)同城-热搜榜信息检索
      • 4)同城-实时热搜榜信息
      • 5)热榜详情信息获取
      • 6)根据榜单类型+渠道实时获取榜单信息
      • 7)根据榜单类型+渠道检索榜单信息
      • 8)境外热榜趋势-指定渠道获取实时热榜趋势信息
      • 9)境外热榜趋势-多条件获取热榜趋势信息
    • 7、数据推送相关接口
      • 1)分页排序多条件检索专题列表查询
      • 2)添加专题信息
      • 3)更新专题信息
      • 4)更新专题状态
      • 5)删除专题信息
      • 6)根据用户ID获取Kafka信息
  • 服务总线-附件
    • Java客户调用接口生成签名工具类
    • Python客户调用接口生成签名工具类
    • 原生服务错误码值说明
  • 产品API
    • 主题订阅
      • 订阅ID
    • 分析组件
      • 事件/话题简介
      • 热点主题
      • 概述
      • 专家观点
      • 信息内容分类
      • 发布地域
      • 发文习惯
      • 媒体曝光趋势对比
      • 媒体等级分布
      • 微博网民观点
      • 提及地域分布
      • 传播路径
      • 账号认证分布
      • 账号性别分布
      • 热点榜单
      • 热点短语
      • 热点词语
      • 情感倾向
      • 热点文章
      • 媒体曝光趋势
      • 影响力指数
      • 互动趋势
      • 热门组织
      • 热门人物
    • AI雷达
      • 主题信息列表
      • 主题信息类型+信息属性
      • 主题信息监测事件列表
  1. 3、发文分析相关接口

1)通用-数据总量获取

POST
/v1/analysis/getCount
1、发文分析相关接口
支持多条件筛选统计该索引下数据量

请求参数

Header 参数
appKey
string 
AppKey
必需
nonce
string 
随机数
必需
timestamp
string 
时间戳
必需
signature
string 
必需
签名,详见附件客户签名生成工具类
Body 参数application/json
数据量入参
articleInfo
object (ArticleInfo) 
发文相关信息
必需
searchMode
object (SearchMode) 
可选
检索模式【如果searchType=0,keywordExps必填;如果searchType=1,simpleKeyword必填】
searchTime
object (SearchTime) 
必需

搜索时间
注意:取决于realTime,如果自定义以传入开始和结束时间生效,非自定义,系统根据now字段计算。
startPubTime<=发文时间<endPubTime

dataSources
array[string]
可选
渠道/媒体类型,详见《字典接口模块》指定境内外类型查询媒体类型接口【取返回结果code字段值】
matchMethods
array[integer <int32>]
可选
匹配方式【默认文本匹配,1-文本(正文|标题)、2-OCR、3-语音、4-场景、5-人脸、6-标题、7-正文(内容)】
articleTypes
array[integer <int32>]
可选
数据类型【0-对话、1-原创、2-转发、3-评论】
ipAreaCountry
array[string]
可选
IP归属地所在国家,详见《字典接口模块》国家三字英文码值对照列表【取返回结果pek字段值】
ipAreaProvinces
array[string]
可选
IP归属地所在省,详见《字典接口模块》指定区域父级节点查询信息【取返回结果id字段值】
urls
array[string]
可选
发文链接【最多支持5个url】
insertTime
object (InsertTime) 
数据入队列时间
可选
esInsertTime
object (EsInsertTime) 
发文入ES时间
可选
signInAreas
array[object (SignInArea) {4}] 
可选
签到地域信息,详见《字典接口模块》,各个字段取值详见字段说明
isPaid
integer <int32>
可选
是否付费,【空/-1默认全部、-1-全部、0-免费、1-付费】注意:付费数据是需开通权限,如果未开权限数据会返回空,免费数据默认都有。
>= -1<= 1
示例值:
-1
isAdvertisement
integer <int32>
可选
是否为广告数据【0-否、1-是】
>= -1<= 1
author
array[string]
可选
作者,最多支持20个(包含20,总长度300)
topicTags
array[string]
可选
话题标签,最多支持20个(包含20,总长度300)
mediaTypes
array[integer <int32>]
可选
发文类型【1-文本、2-图文、3-视频】
mediaTypeMatch
integer <int32>
可选
发文类型匹配关系【0-任意包含,1-必须包含】,默认为任意包含
rootArticleIds
array[string]
可选
根博文id集合【最多支持10个root_article_id】
articlePlatform
object (ArticlePlatform) 
发文站点相关信息
可选
mediaInfos
array[object (MediaInfo) {10}] 
可选
指定媒体组,注意:详见分页检索账号信息列表接口【如果是长文本的建议把接口返回的platform下所有字段对应传入,社交额外带上账号ID值,若单独指定渠道检索不生效(查询全部渠道),若想生效请使用articleInfo.dataSources字段】
isForeignMedia
integer <int32>
可选
是否境内外媒体【0-境内、1-境外(外国媒体+港澳台媒体)、-1-境内外(全部)】
>= -1<= 1
示例值:
-1
country
array[string]
可选
媒体国家,详见《字典接口模块》国家三字英文码值对照列表【取返回结果pek字段值】,最多支持20个(包含20,总长度100)
mediaAreas
array[object (MediaArea) {3}] 
可选
媒体地域信息,详见《字典接口模块》,各个字段取值详见字段说明
mediaTags
array[string]
可选
媒体标签,详见《字典接口模块》媒体信源标签信息列表【取返回结果tagName字段值】,最多支持20个(包含20,总长度100)注意:articlePlatform.mediaTags与articlePlatform.excludeMediaTags字段同时有值,articlePlatform.excludeMediaTags不会生效不能同时存在,其中一个可不传
excludeMediaTags
array[string]
可选
排除媒体标签,详见《字典接口模块》媒体信源标签信息列表【取返回结果tagName字段值】,最多支持20个(包含20,总长度100)注意:articlePlatform.mediaTags与articlePlatform.excludeMediaTags字段同时有值,articlePlatform.excludeMediaTags不会生效不能同时存在,其中一个可不传
articleUser
object (ArticleUser) 
发文账号相关信息
可选
userIds
array[string]
可选
账号ID,最多支持20个(包含20,总长度300)
customIds
array[string]
可选
平台账号ID,最多支持20个(包含20,总长度300)
userNames
array[string]
可选
账号名称,最多支持20个(包含20,总长度300)
userSex
string 
可选
账号博主性别,m:男 f:女
isVerified
integer <int32>
可选
是否账号认证,【空/-1默认全部、-1-全部、0-未认证、1-已认证】
>= -1<= 1
示例值:
-1
verifiedTypes
array[integer <int32>]
可选
认证类型【0-未认证、1-个人、2-机构组织、3-公司企业、4-其他】
fanRange
object (FanRange) 
可选
粉丝数量范围入参【包头包尾】
userRegisterAreas
array[object (UserRegisterArea) {4}] 
可选
账号注册地域信息,具体详见《字典接口模块》,各个字段取值详见字段说明
articleAnalysis
object (ArticleAnalysis) 
发文分析相关信息
可选
languages
array[string]
可选
语种,详见《字典接口模块》ISO639语言编码信息列表【取返回结果code字段值】
categories
array[string]
可选
分类,详见《字典接口模块》分类列表查询【取返回结果categoryName字段值】,最多支持20个(包含20,总长度100)
polarities
array[integer <int32>]
可选
内容情感【0-中立、1-正面、2-负面】
isSensitive
integer <int32>
可选
是否敏感【为空默认全部,0-否、1-是】
>= 0<= 1
subjectSentiments
array[string]
可选
主体情感【格式:汉字-数字,数字只支持0-中立、1-正面、2-负面、3-无关、4-未知】
contentAreas
array[object (ContentArea) {4}] 
可选
内容提及地域信息,各个字段取值详见字段说明
mediaGradeTags
array[object (MediaGradeTag) {7}] 
可选
标签信息分类,各个字段取值详见字段说明
fingerprint
string 
可选
语义指纹【用于对相似文章进行排重】
isFingerprintHead
integer <int32>
可选
语义指纹标记是否簇头【为空默认不构建,1-是、0-否】
>= 0<= 1
subjectExtract
array[string]
可选
提及人,最多支持20个(包含20,总长度100)
contentClassify
array[string]
内容分类
可选
areaType
string 
可选
IP归属地所在国家+IP归属地所在省+内容提及地域信息+媒体国家+媒体地域信息+账号注册地域信息+签到地域信息构建关系【默认AND关系,1-AND、2-OR】
示例值:
1
hiddenMark
object (HiddenMark) 
可选
发文显隐标记信息注意:hideMarkId和isHidden两个字段都不为空,才会生效
hideMark
string 
可选
隐藏字段标识【格式:用户ID-方案ID】
正则匹配:
^\d{1,11}-\d{1,11}$
isHidden
boolean 
可选
是否显示剔除内容【true-显示剔除内容、false-不显示剔除内容】
accountMatchDTO
object (AccountMatch) 
可选
自定义匹配方式入参注意:支持根据站点名称、账号名称等六个字段进行检索明确需求,需要用到哪些字段,匹配的字段越少越好,否则浪费系统资源!账号匹配方式matchType可以对输入的关键词进行精确匹配或模糊匹配默认操作符defaultOperator可以决定不同关键词间的关系是and或or
matchType
integer <int32>
可选
账号匹配方式【0-精确匹配、1-模糊匹配】
>= 0<= 1
示例值:
0
defaultOperator
integer <int32>
可选
默认操作符【空/0默认AND、1-OR】
>= 0<= 1
示例值:
1
websiteNames
string 
可选
站点名称【支持关键词长度最大100】
subWebsiteNames
string 
可选
子站点名称【支持关键词长度最大100】
userNames
string 
可选
账号名称【支持关键词长度最大100】
authors
string 
可选
作者【支持关键词长度最大100】
userIds
string 
可选
账号ID【支持关键词长度最大100】
channelNames
string 
可选
站点渠道名称【支持关键词长度最大100】
customId
string 
可选
个性化账号id【支持关键词长度最大100】
secUid
string 
可选
用户第二uid【支持关键词长度最大100】,账号检索可用,发文检索不可用
host
string 
可选
域名【支持关键词长度最大100】
isCollapse
boolean 
可选
是否排重【默认不排重,true-排重(!!!注意:使用排重后结果值是一个近似值,不是准确值,若有特殊需求慎用)、false-不排重】
示例值:
false
isOneHundredThousandReadCount
boolean 
可选
是否10W+阅读排序【默认否,true-是、false-否】
示例值:
false
collapseType
integer <int32>
可选
排重字段【默认语义指纹,1-语义指纹、2-站点名称、3-账号名称、4-媒体国家、5-语种】
>= 1<= 5
默认值:
1
gid
integer <int64>
可选
全局有序ID【注意:配合拉取数据使用防止数据遗漏】
示例
{
  "articleInfo": {
    "searchMode": {
      "searchType": 0,
      "keywordExps": [
        "string"
      ],
      "simpleKeyword": {
        "mustKeyWord": [
          "string"
        ],
        "mustKeyWordComplex": [
          "string"
        ],
        "anyKeyWord": [
          "string"
        ],
        "needExclude": [
          "string"
        ]
      },
      "queryType": true
    },
    "searchTime": {
      "realTime": 1,
      "now": "yyyy-MM-dd HH:mm:ss",
      "startPubTime": "yyyy-MM-dd HH:mm:ss",
      "endPubTime": "yyyy-MM-dd HH:mm:ss"
    },
    "dataSources": [
      "string"
    ],
    "matchMethods": [
      0
    ],
    "articleTypes": [
      0
    ],
    "ipAreaCountry": [
      "string"
    ],
    "ipAreaProvinces": [
      "string"
    ],
    "urls": [
      "string"
    ],
    "insertTime": {
      "startInsertTime": "yyyy-MM-dd HH:mm:ss",
      "endInsertTime": "yyyy-MM-dd HH:mm:ss"
    },
    "esInsertTime": {
      "startEsInsertTime": "yyyy-MM-dd HH:mm:ss",
      "endEsInsertTime": "yyyy-MM-dd HH:mm:ss"
    },
    "signInAreas": [
      {
        "signInCountry": "string",
        "signInProvince": "string",
        "signInCity": "string",
        "signInCounty": "string"
      }
    ],
    "isPaid": -1,
    "isAdvertisement": -1,
    "author": [
      "string"
    ],
    "topicTags": [
      "string"
    ],
    "mediaTypes": [
      0
    ],
    "mediaTypeMatch": 0,
    "rootArticleIds": [
      "string"
    ]
  },
  "articlePlatform": {
    "mediaInfos": [
      {
        "include": true,
        "dataSource": "string",
        "websiteName": "string",
        "host": "string",
        "subHost": "string",
        "channelName": "string",
        "mediaType": "string",
        "hostType": "string",
        "userId": "string",
        "userName": "string"
      }
    ],
    "isForeignMedia": -1,
    "country": [
      "string"
    ],
    "mediaAreas": [
      {
        "mediaAreaProvince": "string",
        "mediaAreaCity": "string",
        "mediaAreaCounty": "string"
      }
    ],
    "mediaTags": [
      "string"
    ],
    "excludeMediaTags": [
      "string"
    ]
  },
  "articleUser": {
    "userIds": [
      "string"
    ],
    "customIds": [
      "string"
    ],
    "userNames": [
      "string"
    ],
    "userSex": "string",
    "isVerified": -1,
    "verifiedTypes": [
      0
    ],
    "fanRange": {
      "fromFan": 0,
      "toFan": 0
    },
    "userRegisterAreas": [
      {
        "userCountry": "string",
        "userProvince": "string",
        "userCity": "string",
        "userCounty": "string"
      }
    ]
  },
  "articleAnalysis": {
    "languages": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "polarities": [
      0
    ],
    "isSensitive": 0,
    "subjectSentiments": [
      "string"
    ],
    "contentAreas": [
      {
        "contentAreaCountry": "string",
        "contentAreaProvince": "string",
        "contentAreaCity": "string",
        "contentAreaCounty": "string"
      }
    ],
    "mediaGradeTags": [
      {
        "tags1": [
          "string"
        ],
        "tags2": [
          "string"
        ],
        "tags3": [
          "string"
        ],
        "tags4": [
          "string"
        ],
        "tags5": [
          "string"
        ],
        "tags6": [
          "string"
        ],
        "tags7": [
          "string"
        ]
      }
    ],
    "fingerprint": "string",
    "isFingerprintHead": 0,
    "subjectExtract": [
      "string"
    ],
    "contentClassify": [
      "string"
    ]
  },
  "areaType": "1",
  "hiddenMark": {
    "hideMark": "string",
    "isHidden": true
  },
  "accountMatchDTO": {
    "matchType": 0,
    "defaultOperator": 1,
    "websiteNames": "string",
    "subWebsiteNames": "string",
    "userNames": "string",
    "authors": "string",
    "userIds": "string",
    "channelNames": "string",
    "customId": "string",
    "secUid": "string",
    "host": "string"
  },
  "isCollapse": false,
  "isOneHundredThousandReadCount": false,
  "collapseType": 1,
  "gid": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/analysis/getCount' \
--header 'appKey;' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "articleInfo": {
        "searchMode": {
            "searchType": 0,
            "keywordExps": [
                "string"
            ],
            "simpleKeyword": {
                "mustKeyWord": [
                    "string"
                ],
                "mustKeyWordComplex": [
                    "string"
                ],
                "anyKeyWord": [
                    "string"
                ],
                "needExclude": [
                    "string"
                ]
            },
            "queryType": true
        },
        "searchTime": {
            "realTime": 1,
            "now": "yyyy-MM-dd HH:mm:ss",
            "startPubTime": "yyyy-MM-dd HH:mm:ss",
            "endPubTime": "yyyy-MM-dd HH:mm:ss"
        },
        "dataSources": [
            "string"
        ],
        "matchMethods": [
            0
        ],
        "articleTypes": [
            0
        ],
        "ipAreaCountry": [
            "string"
        ],
        "ipAreaProvinces": [
            "string"
        ],
        "urls": [
            "string"
        ],
        "insertTime": {
            "startInsertTime": "yyyy-MM-dd HH:mm:ss",
            "endInsertTime": "yyyy-MM-dd HH:mm:ss"
        },
        "esInsertTime": {
            "startEsInsertTime": "yyyy-MM-dd HH:mm:ss",
            "endEsInsertTime": "yyyy-MM-dd HH:mm:ss"
        },
        "signInAreas": [
            {
                "signInCountry": "string",
                "signInProvince": "string",
                "signInCity": "string",
                "signInCounty": "string"
            }
        ],
        "isPaid": -1,
        "isAdvertisement": -1,
        "author": [
            "string"
        ],
        "topicTags": [
            "string"
        ],
        "mediaTypes": [
            0
        ],
        "mediaTypeMatch": 0,
        "rootArticleIds": [
            "string"
        ]
    },
    "articlePlatform": {
        "mediaInfos": [
            {
                "include": true,
                "dataSource": "string",
                "websiteName": "string",
                "host": "string",
                "subHost": "string",
                "channelName": "string",
                "mediaType": "string",
                "hostType": "string",
                "userId": "string",
                "userName": "string"
            }
        ],
        "isForeignMedia": -1,
        "country": [
            "string"
        ],
        "mediaAreas": [
            {
                "mediaAreaProvince": "string",
                "mediaAreaCity": "string",
                "mediaAreaCounty": "string"
            }
        ],
        "mediaTags": [
            "string"
        ],
        "excludeMediaTags": [
            "string"
        ]
    },
    "articleUser": {
        "userIds": [
            "string"
        ],
        "customIds": [
            "string"
        ],
        "userNames": [
            "string"
        ],
        "userSex": "string",
        "isVerified": -1,
        "verifiedTypes": [
            0
        ],
        "fanRange": {
            "fromFan": 0,
            "toFan": 0
        },
        "userRegisterAreas": [
            {
                "userCountry": "string",
                "userProvince": "string",
                "userCity": "string",
                "userCounty": "string"
            }
        ]
    },
    "articleAnalysis": {
        "languages": [
            "string"
        ],
        "categories": [
            "string"
        ],
        "polarities": [
            0
        ],
        "isSensitive": 0,
        "subjectSentiments": [
            "string"
        ],
        "contentAreas": [
            {
                "contentAreaCountry": "string",
                "contentAreaProvince": "string",
                "contentAreaCity": "string",
                "contentAreaCounty": "string"
            }
        ],
        "mediaGradeTags": [
            {
                "tags1": [
                    "string"
                ],
                "tags2": [
                    "string"
                ],
                "tags3": [
                    "string"
                ],
                "tags4": [
                    "string"
                ],
                "tags5": [
                    "string"
                ],
                "tags6": [
                    "string"
                ],
                "tags7": [
                    "string"
                ]
            }
        ],
        "fingerprint": "string",
        "isFingerprintHead": 0,
        "subjectExtract": [
            "string"
        ],
        "contentClassify": [
            "string"
        ]
    },
    "areaType": "1",
    "hiddenMark": {
        "hideMark": "string",
        "isHidden": true
    },
    "accountMatchDTO": {
        "matchType": 0,
        "defaultOperator": 1,
        "websiteNames": "string",
        "subWebsiteNames": "string",
        "userNames": "string",
        "authors": "string",
        "userIds": "string",
        "channelNames": "string",
        "customId": "string",
        "secUid": "string",
        "host": "string"
    },
    "isCollapse": false,
    "isOneHundredThousandReadCount": false,
    "collapseType": 1,
    "gid": 0
}'

返回响应

🟢200OK
application/json
Body
返回数据格式
code
integer <int32>
可选
响应码【200代表成功,其他参见错误码值表】)
success
boolean 
可选
是否成功【true代表成功,false代表失败】
message
string 
响应消息
可选
data
integer <int64>
响应数据
可选
errors
array[string]
错误信息集合
可选
time
string <date-time>
响应时间
可选
示例
{
  "code": 0,
  "success": true,
  "message": "string",
  "data": 0,
  "errors": [
    "string"
  ],
  "time": "2019-08-24T14:15:22Z"
}
上一页
3)根据渠道和账号ID查询是否采集该媒体账号信息
下一页
2)通用-指定分析字段返回其中某一种聚合分析
Built with