全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多

API参考(新)

更新时间:2018-05-03 15:53:28

一、通用说明

所有的返回结果中,都会附带以下系统级返回参数,用于判断接口调用是否出错及相应的出错信息。

系统级返回字段说明

参数名 参数类型 说明
success boolean 接口处理是否成功的标识
errorCode int 如果出错,表示出错状态码
other string 额外提示信息
msgCode int 提示信息状态码
msgInfo string 提示信息
messages array[string] 如果出错,表示出错信息。如果成功,也可能为成功的提示信息
result json 该对象封装了业务对象实体。如果success为true时,此对象才有值。 具体参数见各接口中说明

二、主题接口

1、查询主题

API功能:查询一个业务方的所有主题列表,或者根据名称模糊匹配主题列表。

接口名称:QueryTopics

入参说明

参数名 参数类型 是否必填 说明
Name String 专题名称搜索词
ToPage Integer 页码
PageSize Integer 页长

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1543"
  9. "TopicResult":[{
  10. "PageIndex":1,
  11. "PageSize":20,
  12. "TotalCount":1,
  13. "Pages":1,
  14. "Details":[{
  15. "Id":24134,
  16. "Name":"降温监测",
  17. "Desc":"各地区温度监测",
  18. "Status":"VALID",
  19. "CreatedAt":"2017-09-24 10:23",
  20. "UpdatedAt":"2017-09-24 10:25"
  21. }]
  22. }]
  23. }

返回参数说明

参数名 参数类型 说明
RequestId String 访问跟踪ID
PageIndex Integer 页码
PageSize Integer 页长
TotalCount Integer 总数
Pages Integer 页数
Id Long 专题ID
Name String 专题内容
Desc String 描述
Status String 状态,VALID-有效,INVALID-无效
CreatedAt String 创建时间yyyy-MM-dd HH:mm
UpdatedAt String 更新时间yyyy-MM-dd HH:mm

2、查询单个主题

API功能:根据主题id 查询主题具体信息。

接口名称:GetTopic

入参说明

参数名 参数类型 是否必填 说明
id Long 主题id

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1543"
  9. "TopicResult":[{
  10. "Id":24134
  11. "Name":"降温监测"
  12. "Desc":"各地区温度监测"
  13. "Status":"VALID"
  14. "CreatedAt":"2017-09-24 10:23"
  15. "UpdatedAt":"2017-09-24 10:25"
  16. }]
  17. }

返回参数说明

参数名 参数类型 说明
RequestId String 访问跟踪ID
Id Long 主题ID
Name String 专题内容
Desc String 描述
Status String 状态,VALID-有效,INVALID-无效
CreatedAt String 创建时间yyyy-MM-dd HH:mm
UpdatedAt String 更新时间yyyy-MM-dd HH:mm

3、添加主题

API功能:用于创建一个新的主题。

接口名称:CreateTopic

入参说明

参数名 参数类型 是否必填 说明
Name String 专题名称
Desc String 专题描述

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1544", //访问跟踪ID
  9. "Result":6543 //专题ID
  10. }

返回参数说明

参数名 参数类型 说明
RequestId String 访问跟踪ID
Result Long 专题ID

4、更新主题内容

API功能:对现有主题更新,可对主题名称和主题描述两个属性修改。

接口名称:UpdateTopicContent

入参说明

参数名 参数类型 是否必填 说明
Id Long 专题ID
Name String 专题名称
Desc String 专题描述

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1545" //访问跟踪ID
  9. }

返回参数说明

参数名 参数类型 说明
RequestId String 访问跟踪ID

5、更新主题状态

API功能:对现有主题是否开启监控状态属性。

接口名称:UpdateTopicStatus

入参说明

参数名 参数类型 是否必填 说明
Status String 专题状态,VALID/INVALID
Id Long 专题ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1546" //访问跟踪ID
  9. }

6、删除主题

API功能:逻辑删除一个主题。非物理删除,如果不小心物理删除,请提工单进行修正。

接口名称:DeleteTopic

入参说明

参数名 参数类型 是否必填 说明
Id Long 专题ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1547" //访问跟踪ID
  9. }

三、源站类型

1、查询源站类型列表

API功能:该接口用于在添加关键字或主题时,选择关联的源站类型。

接口名称:GetSystemSiteTypes

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1543"
  9. "SysSiteTypes":[{
  10. "Name":"新闻",
  11. "Id":20
  12. },{
  13. "Name":"微博",
  14. "Id":21
  15. }...]
  16. }

返回参数说明

参数名 参数类型 说明
Name String 站点类型
Id Integer 站点id

四、关键词接口

1、查询关键字

API功能:分页查询一个主题下面的所有已经添加的关键字并排序。

接口名称:QueryKeywords

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
OrderField String 排序字段
OrderSort String 排序方式
ToPage Integer 页码
PageSize Integer 页长

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":1548
  9. "KeywordResult":[{
  10. "PageIndex":1,
  11. "PageSize":20,
  12. "TotalCount":2,
  13. "Pages":1,
  14. "Details":[{
  15. "Id":1423,
  16. "Name":"杭州旅游",
  17. "TopicId":1242,
  18. "CreatedAt":"2017-09-12 22:10:00",
  19. "UpdatedAt":"2017-09-12 22:10:00",
  20. "SiteTypes":[{
  21. "Id":"1234",
  22. "Name":"新闻",
  23. }]
  24. "Keywords":[{
  25. "words":"杭州 国庆节旅游"
  26. }]
  27. }]
  28. }]
  29. }

返回参数说明

参数名 参数类型 说明
Id Long 关键词规则ID
Name String 所在关键词组名称
TopicId Long 专题ID
CreatedAt String 创建时间(yyyy-MM-dd HH:mm:ss)
UpdatedAt String 更新时间(yyyy-MM-dd HH:mm:ss)
SiteTypes List < String> 站点类型 Id为类型ID,Name为类型名称
words String 关键词

2、添加关键字

API功能:用于向一个主题添加关键字。

接口名称:CreateKeyword

入参说明

参数名 参数类型 是否必填 说明
Name String 关键词组名称
Keyword List< List< String>> 具体关键词,多个关键字请用json数组封装,内层的List< String>表示一个关键词如”茅台 飞天”
TopicId Long 专题ID
SiteTypeId List< Long> 站点类型ID列表,多个请用json数组封装,如 [8,9]

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":1549 //访问跟踪ID
  9. }

3、删除关键字

API功能:逻辑删除关键字。删除后,系统将在约20分钟内生效;20分钟后,便不会再抓取该词,但是历史抓取记录会被保留。

接口名称:DeleteKeyword

入参说明

参数名 参数类型 是否必填 说明
Id Long 关键词ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. }

4、修改关键字内容

API功能:用于修改单个关键字的属性。支持对内容、所属关键词组名称、所属专题、抓取的源站类型4个属性的修改。

接口名称:UpdateKeywordContent

入参说明

参数名 参数类型 是否必填 说明
Name String 关键词组名称
Keyword List< List< String>> 具体关键词,多个关键字请用json数组封装,内层的List< String>表示一个关键词如”茅台 飞天”
Id Long 关键词ID
SiteTypeId List< Long> 站点类型ID列表
TopicId Long 专题ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1551" //访问跟踪ID
  9. }

5、更新关键字状态

API功能:更新关键字状态。

接口名称:UpdateKeywordStatus

入参说明

参数名 参数类型 是否必填 说明
Id Long 关键词ID
Status String 关键词状态,VALID/INVALID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. }

五、过滤规则接口

1、获取过滤规则

API功能:获取过滤规则详细设置。

接口名称:GetFilterRule

入参说明

参数名 参数类型 是否必填 说明
Id Long 过滤规则ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1552"
  9. "FilterRuleResult":[{
  10. "PageIndex":1,
  11. "PageSize":20,
  12. "TotalCount":2,
  13. "Pages":1,
  14. "Details":[{
  15. "Id":1424,
  16. "Name":"规则1" ,
  17. "TopicId":1242,
  18. "CreatedAt":"2017-09-12 22:10:00",
  19. "UpdatedAt":"2017-09-12 22:10:00",
  20. "UrlRule":"!09873",
  21. "AuthorRule":"!游戏",
  22. "IsRegex":"Y",
  23. "Status":"VALID",
  24. "TitleRule":"茅台",
  25. "ContentRule":"茅台"
  26. }]
  27. }]
  28. }

返回参数说明

参数名 参数类型 说明
Id Long 过滤规则ID
Name String 过滤规则名称
TopicId Long 专题ID
CreatedAt String 创建时间(yyyy-MM-dd HH:mm:ss)
UpdatedAt String 更新时间(yyyy-MM-dd HH:mm:ss)
UrlRule String URL规则
AuthorRule String 作者规则
IsRegex String URL规则是否正则表达式
Status String 启用状态(VALID/INVALID)
TitleRule String[] 标题规则
ContentRule String[] 内容规则

2、设置过滤规则

API功能:添加过滤规则过滤不想抓取的内容。

接口名称:CreateFilterRule

入参说明

参数名 参数类型 是否必填 说明
IsToDustbin Boolean 是否进入回收站
Name String 过滤规则名称
TopicId Long 专题ID
TitleRule List 标题规则
AuthorRule String 作者规则
UrlRule String URL规则
SiteTypeId List 站点类型ID列表
ContentRule List 内容规则
IsRegex Boolean URL规则是否正则表达

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1547", //访问跟踪ID
  9. "Result":312 //过滤规则ID
  10. }

3、删除过滤规则

API功能:删除存在的过滤规则。

接口名称:DeleteFilterRules

入参说明

参数名 参数类型 是否必填 说明
Id List 待删除过滤规则ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1551" //访问跟踪ID
  9. }

4、禁用过滤规则

API功能:禁用过滤规则。

接口名称:DisableFilterRules

入参说明

参数名 参数类型 是否必填 说明
Id List 待禁用的过滤规则ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1552" //访问跟踪ID
  9. }

5、启用禁用过滤规则

API功能:启用过滤规则。

接口名称:EnableFilterRules

入参说明

参数名 参数类型 是否必填 说明
Id List< Long> 待启用的过滤规则ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1553" //访问跟踪ID
  9. }

6.更新过滤规则

API功能:更新过滤规则。

接口名称:UpdateFilterRule

入参说明

参数名 参数类型 是否必填 说明
IsToDustbin Boolean 是否进入回收站
Name String 过滤规则名称
TopicId Long 专题ID
TitleRule.[n] null[] 标题规则
AuthorRule String 作者规则
UrlRule String URL规则
SiteTypeId.[n] null[] 站点类型ID列表
Id Long 过滤规则ID
ContentRule.[n] null[] 内容规则
IsRegex Boolean URL规则是否正则表达式

返回参数说明

名称 类型 描述
RequestId String 访问跟踪ID

六、预警规则接口

1、创建告警

API功能:创建对应主题警告。

接口名称:CreateAlarm

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
Email List< String> 告警通知的邮件地址
LinkRatioAmount Integer 触发告警的比例
Name String 告警名称
KeywordRule String 关键词规则
SiteTypeId List< Long> 站点类型ID列表
StatsCyle Integer 告警信息统计周期(分钟)
EndTime Integer 告警推送结束时间 (分钟)
StartTime Integer 告警开始时间(分钟)
EmotionType List< String> 情感类型
TriggerAmount Integer 触发告警的绝对量
Telephone List< String> 告警消息发送的电话号码
DailyAlarmLimit Integer 日推送告警数限制

请求示例

  1. {
  2. "topicId":25,
  3. "emails":[..,..],
  4. "linkRatioAmount":0,
  5. "name":"告警发送测试",
  6. "keywordRule":"雾霾",
  7. "siteTypeId":[
  8. {
  9. "id":4,
  10. "name":"新闻客户端"
  11. }
  12. ],
  13. "statsCyle":60,
  14. "endTime":1439,
  15. "startTime":44,
  16. "emotionType":[
  17. "POSITIVE",
  18. "NEUTRAL",
  19. "NEGATIVE"
  20. ],
  21. "triggerAmount":1,
  22. "Telephone":[..,..],
  23. "dailyAlarmLimit":100
  24. }

2、查询告警

API功能:获取单个告警。

接口名称:GetAlarm

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
Id Long 告警ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550",
  9. "Alarm":[{
  10. "Id":8759,
  11. "Name":"告警测试",
  12. "Status":"VALID",
  13. "StatsCyle":60,
  14. "StartTime":10,
  15. "EndTime":15,
  16. "DailyAlarmLimit":5,
  17. "TriggerAmount":5,
  18. "LinkRatioAmount":30,
  19. "KeywordRule":"交通事故",
  20. "CreateTime":27163,
  21. "ModifiedTime":"27163",
  22. "SiteTypes":[{
  23. "Name":"新闻",
  24. "Id":"1"
  25. },{
  26. "Name":"视频",
  27. "Id":"12"
  28. }]
  29. "Email":"xxx@alibaba-inc.com",
  30. "Telephone":"136XXXX",
  31. "EmotionType":"中性"
  32. }]

返回参数说明

参数名 参数类型 说明
Id Long 告警ID
Name String 告警名称
Status String 告警状态
StatsCyle Integer 告警数据统计周期(分钟)
StartTime Integer 告警通知开始时间(分钟)
EndTime Integer 告警通知结束时间(分钟)
DailyAlarmLimit Integer 日通知告警条数限制
TriggerAmount Integer 触发告警条数
LinkRatioAmount Integer 触发告警比例
KeywordRule String 关键词规则
CreateTime Long 告警创建时间
ModifiedTime Long 告警修改时间
SiteTypes List< Long> 站点类型
Email String[] 通知email
Telephone String[] 通知电话
EmotionType String[] 情感类型

3、分页查询所有预警

API功能:分页查询所有预警。

接口名称:QueryAlarms

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
ToPage Integer 页码
PageSize Integer 页长

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1553",
  9. "AlarmResult":[{
  10. "PageIndex":1,
  11. "PageSize":1
  12. "TotalCount":1
  13. "Pages":1
  14. "Details":[{
  15. "Id":123
  16. "Name":"杭州交通事故"
  17. "Status":"VALID"
  18. "StatsCyle":10
  19. "EndTime":20
  20. "DailyAlarmLimit":5
  21. "TriggerAmount":10
  22. "LinkRatioAmount":10,
  23. "KeywordRule":"杭州交通事故",
  24. "CreateTime":1023455236453,
  25. "ModifiedTime":1024563275421,
  26. "SiteTypes":[{
  27. "1":"新闻",
  28. "2":"微博"
  29. }]
  30. "Email":[],
  31. "Telephone":[],
  32. "EmotionType":["NATURAL","POSITIVE"]
  33. }]
  34. }]
  35. }

返回参数说明

参数名 参数类型 说明
Id Long 告警ID
Name String 告警名称
Status String 告警状态
StatsCyle Integer 告警数据统计周期(分钟)
StartTime Integer 告警通知开始时间(分钟)
EndTime Integer 告警通知结束时间(分钟)
DailyAlarmLimit Integer 日通知告警条数限制
TriggerAmount Integer 触发告警条数
LinkRatioAmount Integer 触发告警比例
KeywordRule String 关键词规则
CreateTime Long 告警创建时间
ModifiedTime Long 告警修改时间
SiteTypes List < String[]> 站点类型
Email String[] 通知email
Telephone String[] 通知电话
EmotionType String[] 情感类型

4、删除告警

API功能:删除对应主题警告。

接口名称:DeleteAlarm

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 告警所属专题ID
Id List< Long> 告警ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1551" //访问追踪ID
  9. }

5、更新告警内容

API功能:更新告警内容。

接口名称:UpdateAlarm

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
Email String[] 告警通知的邮件地址
LinkRatioAmount Integer 触发告警的比例
Name String 告警名称
KeywordRule String 关键词规则
SiteTypeId List< Long> 站点类型ID列表
StatsCyle Integer 告警信息统计周期
Id Long 告警ID
EndTime Integer 告警推送结束时间 (小时)
StartTime Integer 告警开始时间(小时)
EmotionType String[] 情感类型
TriggerAmount Integer 触发告警的绝对量
Telephone String[] 告警消息发送的电话号码
DailyAlarmLimit Integer 日推送告警数限制

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1552" //访问追踪ID
  9. }

6、更新告警状态

API功能:更新告警状态。

接口名称:UpdateAlarmStatus

入参说明

参数名 参数类型 是否必填 说明
Status String 状态,VALID/INVALID
TopicId Long 专题ID
Id List< Long> 告警ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1553" //访问追踪ID
  9. }

七、舆情监测

1、搜索舆情数据

API功能:用于对抓取数据的同步搜索。注意:该接口仅在数据抓取到后,才可搜索,而非实时从互联网抓取。

接口名称:SearchOpinions

入参说明

参数名 参数类型 是否必填 说明
Title String 标题搜索词
OrderByType String 排序方式
OrderByField String 排序字段
Content String 正文搜索词
Author String 作者搜索词
SiteName String 站点名称搜索词
SiteTypeId Long 站点类型ID
KeywordId Long 关键词ID
TopicId Long 专题ID
EmotionType String 情感类型
CreatedAtBegin Long 创建开始时间
CreatedAtEnd Long 创建结束时间
PubTimeBegin Long 发布开始时间
PubTimeEnd Long 发布结束时间
ClusterFlag String 是否中心舆情,Y/N
FilterFlag String 是否过滤数据,Y/N
ToPage Integer 页码
PageSize Integer 页长

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":1550 //访问跟踪ID
  9. "OpinionResult":[{
  10. "PageIndex":1,
  11. "PageSize":20,
  12. "TotalCount":1,
  13. "Pages":1,
  14. "Details":[{
  15. "Id":24134,
  16. "KeywordId":3212,
  17. "KeywordName":"茅台",
  18. "TopicId":4212,
  19. "TopicName":"茅台统计",
  20. "Title":"80年代上海老照片...",
  21. "Content":"这是最高级的国际饭店的一桌菜,标价是23元...",
  22. "ClusterId":5463,
  23. "ClusterFlag":"false",
  24. "SimilarCount":23,
  25. "Url":"https://www.toutiao.com/a6484061826538537485/#p=1",
  26. "CreatedAt":1489939200000,
  27. "ModifiedAt":1689949200041,
  28. "PubTime":1689949200001,
  29. "Author":"再看历史",
  30. "SiteTypeId":1234,
  31. "SiteTypeName":"新闻",
  32. "SiteName":"今日头条",
  33. "IsFiltered":"Y",
  34. "FilterId":453,
  35. "FilterName":"其他",
  36. "EmotionType":"NEUTRAL",
  37. "EmotionValue":"43",
  38. "Sentence":"当时茅台8块钱一瓶,这23块钱...", //命中关键句
  39. "area":["浙江省","江苏省"]
  40. }]
  41. }]
  42. }

返回参数说明

参数名 参数类型 说明
Id Long 舆情ID
KeywordId Long 关键词ID
KeywordName String 关键词名称
TopicId Long 专题ID
TopicName String 专题名称
Title String 标题
Content String 正文
ClusterId Long 中心舆情ID
ClusterFlag String 是否中心舆情
SimilarCount Long 相似舆情数量,中心舆情非零
Url String 原文地址
CreatedAt Long 创建时间毫秒
ModifiedAt Long 修改时间毫秒
PubTime Long 发布时间毫秒
Author String 作者
SiteTypeId Long 站点类型ID
SiteTypeName String 站点类型名称
SiteName String 站点名称
IsFiltered String 是否过滤,Y/N
FilterId Long 过滤规则ID
FilterName String 过滤规则名称
EmotionType String 情感类型,POSITIVE/NEGATIVE/NEUTRAL
EmotionValue String 情感值
Sentence String 命中关键句
Area String[] 地区信息

2、获取相似舆情数据

API功能:用于搜索相似舆情。

接口名称:SearchSimilarOpinions

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
OrderByType String 排序方式,DESC/ASC
OrderByField String 排序字段,pub_time,similar_count,emotion_value
ToPage Integer 页码
PageSize Integer 页长
Id Long 舆情ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":1550 //访问跟踪ID
  9. "OpinionResult":[{
  10. "OpinionResult":[{
  11. "PageIndex":1,
  12. "PageSize":20,
  13. "TotalCount":1,
  14. "Pages":1,
  15. "Details":[{
  16. "Id":24156,
  17. "KeywordId":3212,
  18. "KeywordName":"茅台",
  19. "TopicId":4212,
  20. "TopicName":"茅台统计",
  21. "Title":"80年代上海老照片...",
  22. "Content":"这是最高级的国际饭店的一桌菜,标价是23元...",
  23. "ClusterId":5463,
  24. "ClusterFlag":"false",
  25. "SimilarCount":23,
  26. "Url":"http://www.sohu.com/a/202066879_100029035",
  27. "CreatedAt":1489939200000,
  28. "ModifiedAt":1689949200041,
  29. "PubTime":1689949200001,
  30. "Author":"再看历史",
  31. "SiteTypeId":1234,
  32. "SiteTypeName":"新闻",
  33. "SiteName":"今日头条",
  34. "IsFiltered":"Y",
  35. "FilterId":453,
  36. "FilterName":"其他",
  37. "EmotionType":"NEUTRAL",
  38. "EmotionValue":"43",
  39. "Sentence":"当时茅台8块钱一瓶,这23块钱..." //命中关键句
  40. "area":["浙江省","江苏省"]
  41. }]
  42. }]
  43. }

3、设置舆情情感类型

API功能:更新舆情情感类型:正面情感、中性情感和负面情感。

接口名称:SetOpinionEmotion

入参说明

参数名 参数类型 是否必填 说明
EmotionType String 情感类型,POSITIVE/NEGATIVE/NEUTRAL
TopicId Long 专题ID
Id List< Long> 舆情ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1553" //访问跟踪ID
  9. }

4、设置舆情状态

API功能:设置舆情状态,INVALID进入回收站,VALID正常。

接口名称:SetOpinionStatus

入参说明

参数名 参数类型 是否必填 说明
Status String 状态,VALID/INVALID
TopicId Long 专题ID
Id List< Long > 舆情ID列表

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1553" //访问跟踪ID
  9. }

八、舆情分析

1、地区分布报表

API功能:获取某专题在特定发布时间和源站类型内舆情的地区分布报表。

接口名称:GetAreaReport

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
EndTime Long 结束时间(毫秒)
StartTime Long 开始时间(毫秒)
SiteTypeId Long 站点类型ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. "Data":[{
  10. "AreaName":"浙江省",
  11. "Count":5212
  12. },{
  13. "AreaName":"广东省",
  14. "Count":3212
  15. }]
  16. }

返回参数说明

参数名 参数类型 说明
AreaName String 地区名称(省级别)
Count Long 地区相关舆情量

2、情感类型分布报表

API功能:获取某专题在特定发布时间和源站类型内舆情的情感类型分布报表。

接口名称:GetEmotionReport

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
EndTime Long 结束时间(毫秒)
StartTime Long 开始时间(毫秒)
SiteTypeId Long 站点类型ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. "Data":[{
  10. "EmotionType":"NEGATIVE",
  11. "DataDate":"2017-09-24",
  12. "Count": 1210
  13. },{
  14. "EmotionType":"NEUTRAL",
  15. "DataDate":"2017-09-24",
  16. "Count": 2510
  17. },{
  18. "EmotionType":"POSITIVE",
  19. "DataDate":"2017-09-24",
  20. "Count": 5510
  21. }]
  22. }

返回参数说明

参数名 参数类型 说明
EmotionType String 情感类型(NEGATIVE、NEUTRAL,POSITIVE)
DataDate String 数据时间(YYYY-MM-DD HH:00或者YYYY-MM-DD)
Count Long 对应情感类型的舆情量

3、热词报表

API功能:获取某专题在特定发布时间和源站类型内舆情对于的热词报表。

接口名称:GetHotWordReport

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
EndTime Long 结束时间(毫秒)
StartTime Long 开始时间(毫秒)
SiteTypeId Long 站点类型ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. "Data":[{
  10. "HotWord":"阿里巴巴",
  11. "Count":86541
  12. },{
  13. "HotWord":"芝麻信用",
  14. "Count": 52510
  15. },{
  16. "HotWord":"蚂蚁金服",
  17. "Count": 15510
  18. }]
  19. }

返回参数说明

参数名 参数类型 说明
HotWord String 热词
Count Long 热词对应的舆情量

4、站点统计报表

API功能:获取某专题在特定发布时间和源站类型内舆情对应站点统计报表。

接口名称:GetSiteReport

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
EndTime Long 结束时间(毫秒)
StartTime Long 开始时间(毫秒)
SiteTypeId Long 站点类型ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. "Data":[{
  10. "SiteTypeId":"243" ,
  11. "SiteTypeName":"微博",
  12. "SiteName":"新浪微博",
  13. "Count": 69186
  14. },{
  15. "SiteTypeId":"246",
  16. "SiteTypeName":"新闻",
  17. "SiteName":"网易新闻",
  18. "Count": 623186
  19. },{
  20. "SiteTypeId":"241",
  21. "SiteTypeName":"贴吧",
  22. "SiteName":"百度贴吧",
  23. "Count": 19186
  24. }]
  25. }

返回参数说明

参数名 参数类型 说明
SiteTypeId Long 站点类型ID
SiteTypeName String 站点类型名称
SiteName String 站点名称
Count Long 站点对应舆情量

5、声量趋势报表

API功能:获取某专题在特定发布时间和源站类型内舆情声量趋势报表。

接口名称:GetTrendReport

入参说明

参数名 参数类型 是否必填 说明
TopicId Long 专题ID
EndTime Long 结束时间(毫秒)
StartTime Long 开始时间(毫秒)
SiteTypeId Long 站点类型ID

返回示例

  1. {
  2. "success":true,
  3. "errorCode":null,
  4. "other":null,
  5. "msgCode":null,
  6. "msgInfo":null,
  7. "messages":[],
  8. "RequestId":"1550" //访问跟踪ID
  9. "Data":[{
  10. "DataDate":"2017-10-23",
  11. "Count":3425
  12. },{
  13. "DataDate":"2017-10-24",
  14. "Count":3875
  15. },{
  16. "DataDate":"2017-10-25",
  17. "Count":3426
  18. },{
  19. "DataDate":"2017-10-26",
  20. "Count":1425
  21. },{
  22. "DataDate":"2017-10-27",
  23. "Count":3125
  24. },{
  25. "DataDate":"2017-10-28",
  26. "Count":3325
  27. },{
  28. "DataDate":"2017-10-29",
  29. "Count":2425
  30. }]
  31. }

返回参数说明

参数名 参数类型 说明
DataDate String 数据日期
Count Long 舆情量
本文导读目录