跳转到主要内容
GET
/
v1
/
analytics
/
{projectId}
/
feedback
/
by-page
按页面获取反馈
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/feedback/by-page \
  --header 'Authorization: Bearer <token>'
{
  "feedback": [
    {
      "path": "<string>",
      "thumbsUp": 123,
      "thumbsDown": 123,
      "code": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

​
用法

使用此端点导出按文档页面路径汇总的用户反馈。每个条目显示某个页面的反馈总数，并按类型进行细分。 使用响应中的 hasMore 标志对结果进行分页。

​
筛选

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

​
响应数据

每个页面条目包含：
  • path：文档页面路径
  • 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

不包含在内的上界

示例:

"2024-01-01"

​
limit
number
默认值:10

每页返回的最大结果数

必填范围: 1 <= x <= 100
​
source
enum<string>

按反馈来源筛选

可用选项:
code_snippet,
contextual
​
status
string

以逗号分隔的状态列表

响应

按页面汇总的反馈数据

​
feedback
object[]
必填

Feedback counts aggregated by documentation page path.

​
hasMore
boolean
必填

Whether additional results are available beyond this page.