获取用户反馈

返回用户反馈的分页结果，并可按条件筛选。

GET /api/external/v1/analytics/{projectId}/feedback

获取用户反馈

cURL

curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'

200

{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "source": "code_snippet",
      "status": "pending"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​

用法

使用此端点导出从文档中收集的用户反馈。反馈包括来自页面评分的上下文反馈以及代码片段反馈。

使用响应中返回的 cursor 参数对结果进行分页。当 hasMore 为 true 时继续获取数据。

​

筛选

可以按以下维度筛选反馈：

• 日期范围：使用 dateFrom 和 dateTo 将结果限定在特定时间段内
• 来源：按 code_snippet 或 contextual 等反馈来源类型进行筛选
• 状态：按状态值进行筛选，例如 pending、in_progress、resolved 或 dismissed

​

响应类型

响应会根据不同的 source 包含不同类型的反馈：

• 上下文反馈：包含 helpful 布尔值和可选的 contact 邮箱
• 代码片段反馈：包含 code、filename 和 lang 字段

授权

Authorization · string · header · 必填

Authorization 请求头需要使用 Bearer Token。请使用管理员 API key（以 mint_ 开头）。这是仅供服务端使用的密钥。你可以在控制台的 API keys 页面 中生成。

路径参数

projectId · string · 必填

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

查询参数

dateFrom · string

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

示例:

"2024-01-01"

dateTo · string

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

示例:

"2024-01-01"

source · enum<string>

按反馈来源过滤

可用选项: code_snippet, contextual

status · string

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

limit · number · 默认值: 50

每页返回的最大结果数

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

cursor · string

分页游标

响应

200

application/json

分页后的反馈数据

feedback · object[] · 必填

反馈条目的列表。

Option 1

Option 2

Option 3

显示 子属性

nextCursor · string | null · 必填

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

hasMore · boolean · 必填

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