​
概要

Windsurf Analytics API は、Enterprise のお客様がチームの詳細な利用状況アナリティクスにプログラムでアクセスできるようにします。Autocomplete、Chat、Command、Cascade のデータを、柔軟なフィルタリング、グループ化、集計オプションでクエリできます。
Analytics API は Enterprise プランでのみ利用可能です
API データは 3 時間ごとに更新されます

​
ベースURL

すべての API リクエストは次の URL に送信してください： 
https://server.codeium.com/api/v1/

​
認証

Analytics API（アナリティクス API）は認証にサービスキーを使用します。サービスキーは、すべての API 呼び出しのリクエスト本文に含める必要があります。

​
サービス キーの作成

  1. チーム設定ページに移動します
  2. 「サービス キー」セクションに進みます
  3. 適切な権限で新しいサービスキーを作成します
  4. API リクエストで使用するために、生成されたサービスキーをコピーします

​
必要な権限

すべての Analytics API エンドポイントには「Teams Read-only」権限が必要です。

​
サービス キーの使用

すべての API 呼び出しのリクエストボディにサービスキーを含めてください。 
{
  "service_key": "your_service_key_here",
  // ... その他のパラメータ
}
サービスキーは厳重に保護し、クライアント側のコードや公開リポジトリで決して露出させないでください

​
共通パラメーター

ほとんどの Analytics API エンドポイントは、次の共通パラメーターに対応しています:
ParameterTypeRequiredDescription
service_keystringYes認証用のサービスキー
group_namestringNo特定のグループで結果をフィルタリング
start_timestampstringVariesRFC 3339 形式の開始時刻（例: 2023-01-01T00:00:00Z）
end_timestampstringVariesRFC 3339 形式の終了時刻（例: 2023-12-31T23:59:59Z）

​
利用可能なエンドポイント

Analytics API（アナリティクス API）は主に次の3つのエンドポイントを提供します:
  1. User Page Analytics - Teams ページのユーザー活動データを取得
  2. Cascade Analytics - Cascade 固有の利用指標を照会
  3. Custom Analytics - カスタム selections、フィルター、集計による柔軟なクエリ実行

​
レート制限

サービスの安定性を確保するため、API リクエストにはレート制限が適用されます。制限を超過すると、429 Too Many Requests のレスポンスが返されます。

​
サポート

API に関するサポートやご質問は、Windsurf Support までお問い合わせください。