跳转到主要内容
GET
/
v1
/
analytics
/
{projectId}
/
feedback
获取用户反馈列表
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.mintlify.com/v1/analytics/{projectId}/feedback"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mintlify.com/v1/analytics/{projectId}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mintlify.com/v1/analytics/{projectId}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mintlify.com/v1/analytics/{projectId}/feedback"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/analytics/{projectId}/feedback")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/analytics/{projectId}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "helpful": true,
      "contact": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

​
用法

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

​
筛选

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

​
响应类型

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

​
速率限制

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

授权

​
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,
agent,
thumbs_only
​
status
string

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

​
limit
number
默认值:50

每页返回的最大结果数

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

分页游标

响应

包含分页信息的反馈数据

​
feedback
object[]
必填

反馈条目的列表。

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

​
nextCursor
string | null
必填

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

​
hasMore
boolean
必填

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