​
概要

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 までお問い合わせください。