Skip to main content
GET
Get feedback by page

使用方法

使用此端点导出按文档页面路径汇总的用户反馈。每条记录显示一个页面的反馈总数,并按类型细分。

筛选

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

速率限制

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

授权

Authorization
string
header
必填

The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.

路径参数

projectId
string
必填

Your project ID. Can be copied from the API keys page in your dashboard.

查询参数

dateFrom
string

Date in ISO 8601 or YYYY-MM-DD format

示例:

"2024-01-01"

dateTo
string

Date in ISO 8601 or YYYY-MM-DD format. dateTo is an exclusive upper limit. Results include dates before, but not on, the specified date.

示例:

"2024-01-01"

limit
number
默认值:10

Max results per page

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

Filter by feedback source

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

Comma-separated list of statuses to filter by

响应

Per-page feedback aggregates with pagination flag

feedback
object[]
必填

Feedback counts aggregated by documentation page path.

hasMore
boolean
必填

Whether additional results are available beyond this page.