跳转到主要内容
GET
/
v1
/
analytics
/
{projectId}
/
assistant
/
caller-stats
获取 AI 助手调用方统计
curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats"

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}/assistant/caller-stats', 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}/assistant/caller-stats",
  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}/assistant/caller-stats"

	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}/assistant/caller-stats")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.mintlify.com/v1/analytics/{projectId}/assistant/caller-stats")

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
{
  "web": 123,
  "api": 123,
  "other": 123,
  "total": 123
}
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}
{
  "error": "<string>",
  "details": [
    {
      "message": "<string>"
    }
  ]
}

使用方法

使用此端点查看助手查询在不同调用方类型之间的分布情况。响应将总查询次数细分为:
  • web:来自文档站点的查询
  • api:来自直接 API 调用的查询
  • other:来自其他来源的查询(例如集成、SDK)
  • total:所有查询类型的总和

筛选

使用 dateFromdateTo 参数按日期范围筛选。

速率限制

此端点允许每个组织每小时最多 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"

响应

按调用方类型划分的助手查询次数

web
number
必填

来自网页端(文档站点)的助手查询次数。

api
number
必填

来自 API 调用的助手查询次数。

other
number
必填

来自其他来源(例如集成、SDK)的助手查询次数。

total
number
必填

所有调用方类型的助手查询总数。