跳转到主要内容
GET
/
api
/
external
/
v1
/
analytics
/
{projectId}
/
assistant
获取 AI 助手会话记录
curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/assistant \
  --header 'Authorization: Bearer <token>'
{
  "conversations": [
    {
      "id": "<string>",
      "timestamp": "<string>",
      "query": "<string>",
      "response": "<string>",
      "sources": [
        {
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "queryCategory": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​
使用方法

使用此端点从你的文档中导出 AI 助手的会话历史。每个会话都包括用户查询、助手回复、引用的来源以及查询类别。 使用响应中返回的 cursor 参数对结果进行分页。当 hasMore 为 true 时继续获取。

​
筛选

使用 dateFrom 和 dateTo 参数按日期范围过滤会话。

​
会话数据

每个会话包含：
  • query: 用户的问题
  • response: AI 助手的回答
  • sources: 回答中引用的页面，包括标题和 URL
  • queryCategory: query 的类型分类（如果可用）

授权

​
Authorization
string
header
必填

Authorization 请求头中需要携带 Bearer token。有关如何获取 API key 的详细信息，请参阅 API 认证 文档。

路径参数

​
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"

​
limit
number
默认值:100

每页返回的最大结果数量

必填范围: 1 <= x <= 1000
​
cursor
string<ulid>

分页游标（ULID 格式）

响应

分页的会话数据

​
conversations
object[]
必填

AI 助手会话列表。

​
nextCursor
string | null
必填

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

​
hasMore
boolean
必填

指示在当前页之外是否还有更多可用结果。