​
概览

Windsurf Analytics API 使企业客户能够以编程方式访问团队的详细使用分析。可从 Autocomplete、Chat、Command 功能以及 Cascade 中查询数据，并可使用灵活的筛选、分组和聚合选项。
Analytics API 仅面向 Enterprise 计划
API 数据每 3 小时更新一次

​
基础 URL

所有 API 请求应发送到： 
https://server.codeium.com/api/v1/

​
身份验证

Analytics API 使用服务密钥进行身份验证。所有 API 调用都必须在请求正文中包含服务密钥。

​
创建服务密钥

  1. 前往你的团队设置页面
  2. 进入“服务密钥（Service Keys）”部分
  3. 按需授予权限并创建新的服务密钥
  4. 复制生成的服务密钥用于 API 请求

​
所需权限

所有 Analytics API 端点都需要“Teams Read-only”权限。

​
使用服务密钥

在所有 API 调用中，将你的服务密钥放在请求正文中： 
{
  "service_key": "your_service_key_here",
  // ... 其他参数
}
请妥善保管你的服务密钥，切勿在客户端代码或公共代码仓库中泄露

​
常用参数

大多数 Analytics API 端点支持以下常用参数：
参数类型是否必填说明
service_keystring是用于身份验证的服务密钥
group_namestring否按特定群组过滤结果
start_timestampstring视情况而定RFC 3339 格式的开始时间（例如：2023-01-01T00:00:00Z）
end_timestampstring视情况而定RFC 3339 格式的结束时间（例如：2023-12-31T23:59:59Z）

​
可用端点

Analytics API 提供三个主要端点：
  1. User Page Analytics - 从 Teams 页面获取用户活动数据
  2. Cascade Analytics - 查询 Cascade 专属的使用指标
  3. Custom Analytics - 使用自定义 selections、过滤器和 aggregations 进行灵活查询

​
速率限制

为确保服务稳定，API 请求会受到速率限制。如果超出限制，将返回 429 Too Many Requests 响应。

​
支持

如需 API 支持或有任何问题，请联系 Windsurf 支持。