更新时间:2023-07-18 GMT+08:00
分享

查询热搜词

功能介绍

查询热搜词。不适用于办公搜索。

URI

POST /v1/{project_id}/search/hotword

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID和名称

最小长度:1

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

请求体参数类型,该字段必须设置为:application/json。

最小长度:0

最大长度:20

application_id

String

应用ID。

最小长度:1

最大长度:255

表3 请求Body参数

参数

是否必选

参数类型

描述

startDate

String

开始日期,格式为:yyyy-MM-dd。

缺省值:当前日期的前一个月

最小长度:0

最大长度:10

endDate

String

结束日期,格式为:yyyy-MM-dd。

缺省值:当前日期

最小长度:0

最大长度:10

pagination

pagination object

分页信息。

表4 pagination

参数

是否必选

参数类型

描述

page

Integer

查询起始页面。

缺省值:1

hitsPerPage

Integer

每页数量。仅支持站内搜索。

缺省值:50

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

requestId

String

请求ID。仅站内场景下返回。

totalHotwords

Integer

结果总数。

hotwords

Array of hotwords objects

热搜词结果。

表6 hotwords

参数

参数类型

描述

query

String

热搜词。

count

Integer

搜索次数。

请求示例

查询热搜词

https://koosearch.myhuaweicloud.com/v1/{project_id}/search/hotword

{
  "startDate" : "2022-01-01",
  "endDate" : "2022-01-07",
  "pagination" : {
    "page" : 1,
    "hitsPerPage" : 10
  }
}

响应示例

状态码: 200

返回信息。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "requestId" : "467e13ad5abf4bf8a5d04b4bb235f276",
    "totalHotwords" : 3,
    "hotwords" : [ {
      "query" : "test",
      "count" : 58
    }, {
      "query" : "HBase连接池",
      "count" : 41
    }, {
      "query" : "离散数学",
      "count" : 33
    } ]
  }
}

状态码: 400

详见错误码分类。

{
  "status" : "3014",
  "message" : "请求参数校验不通过",
  "data" : null
}

状态码: 500

服务器请求失败。

{
  "status" : "1000",
  "message" : "服务异常",
  "data" : null
}

状态码

状态码

描述

200

返回信息。

400

详见错误码分类。

500

服务器请求失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品