按页面获取反馈

获取按文档页面聚合的反馈计数，包括点赞/点踩评分和代码片段反馈。

GET /v1/analytics/{projectId}/feedback/by-page

获取按页面分组的反馈

cURL

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

200

{
  "feedback": [
    {
      "path": "<string>",
      "thumbsUp": 123,
      "thumbsDown": 123,
      "code": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

​

用法

使用此端点获取文档各页面反馈量的概览。结果按页面路径聚合，并按反馈总数降序排列。

检查响应中的 hasMore 字段以确定是否有更多结果页面可用。增大 limit 参数可以在每次请求中获取更多结果。

​

筛选

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

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

​

响应字段

响应中的每个元素代表一个文档页面，包含：

• thumbsUp：正面（有帮助）上下文评分数量
• thumbsDown：负面（没有帮助）上下文评分数量
• code：代码片段反馈条目数量
• total：该页面所有类型反馈的总计数

授权

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 格式的日期。dateTo 为排他性上限。结果包含该日期之前的数据，但不包含该日期本身。

示例:

"2024-01-01"

source · enum<string>

按反馈来源筛选

可用选项: code_snippet, contextual

status · string

以逗号分隔的状态列表进行筛选

limit · number · 默认值: 10

每页最大结果数

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

响应

200

application/json

按页面分组的反馈聚合及分页标志

feedback · object[] · 必填

按页面分组的反馈聚合列表。

Show child attributes

hasMore · boolean · 必填

是否有超出当前页面的更多结果可用。