跳转到主要内容
GET
获取用户反馈列表

用法

使用此端点导出从文档中收集的用户反馈。反馈包括来自页面评分的上下文反馈、代码片段反馈和 Agent 反馈。 使用响应中返回的 cursor 参数对结果进行分页。当 hasMoretrue 时继续获取数据。

筛选

可以按以下维度筛选反馈:
  • 日期范围:使用 dateFromdateTo 将结果限定在特定时间段内
  • 来源:按 code_snippetcontextualagent 等反馈来源类型进行筛选
  • 状态:按状态值进行筛选,例如 pendingin_progressresolveddismissed

响应类型

响应会根据不同的 source 包含不同类型的反馈:
  • 上下文反馈:包含 helpful 布尔值和可选的 contact 邮箱
  • 代码片段反馈:包含 codefilenamelang 字段
  • Agent 反馈:包含 Agent 提交的反馈文本 comment 和相关页面的 path

速率限制

此端点允许每个组织每小时最多 100 次请求。所有分析端点共享此限制。

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

路径参数

projectId
string
必填

你的项目 ID,可在控制台的 API keys 页面中复制。

查询参数

dateFrom
string

ISO 8601 或 YYYY-MM-DD 格式的日期

示例:

"2024-01-01"

dateTo
string

ISO 8601 或 YYYY-MM-DD 格式的日期。dateTo 为不包含在内的上界。结果包括指定日期之前的所有日期,但不包括指定日期当天。

示例:

"2024-01-01"

source
enum<string>

按反馈来源进行筛选

可用选项:
code_snippet,
contextual,
agent,
thumbs_only
status
string

用于筛选的以逗号分隔的状态列表

limit
number
默认值:50

每页返回的最大结果数

必填范围: 1 <= x <= 100
cursor
string

分页游标

响应

包含分页信息的反馈数据

feedback
object[]
必填

反馈条目的列表。

当来源为 contextual 时返回。包含用户是否认为页面有帮助以及可选的联系邮箱。

nextCursor
string | null
必填

用于获取下一页结果的游标。如果没有更多结果,则为 null。

hasMore
boolean
必填

当前页之后是否还有更多结果。