​
概述

Windsurf Analytics API 让 Enterprise 客户能够以编程方式获取其团队的详细使用数据分析。你可以通过灵活的筛选、分组和聚合选项，查询来自 Autocomplete、Chat、Command 功能以及 Cascade 的数据。
Analytics API 仅对 Enterprise 方案开放
API 数据每 3 小时更新一次

​
基础 URL

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

​
身份验证

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

​
创建服务密钥

  1. 前往你的团队设置页面
  2. 转到“服务密钥”部分
  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、filters 和 aggregations 进行灵活查询

​
频率限制

为确保服务稳定，API 请求会受到频率限制。若超出限制，你将收到 429 Too Many Requests 响应。

​
支持

如需 API 支持或有相关问题，请联系 Windsurf 支持团队。