メインコンテンツへスキップ
POST
https://server.codeium.com
/
api
/
v1
/
CascadeAnalytics
Cascade Analytics の取得
curl --request POST \
  --url https://server.codeium.com/api/v1/CascadeAnalytics \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>",
  "emails": [
    {}
  ],
  "ide_types": [
    {}
  ],
  "query_requests": [
    {}
  ]
}
'
{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "<string>",
            "linesSuggested": "<string>",
            "linesAccepted": "<string>"
          }
        ]
      },
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "<string>",
            "model": "<string>",
            "mode": "<string>",
            "messagesSent": "<string>",
            "cascadeId": "<string>",
            "promptsUsed": "<string>"
          }
        ]
      },
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "<string>",
            "count": "<string>"
          }
        ]
      }
    }
  ]
}

​
概要

提案された行数・受け入れられた行数、AI モデルの利用状況、クレジット消費量、ツールの利用統計など、Cascade 固有の Analytics データを取得します。

​
リクエスト

​
service_key
string
必須
“Teams Read-only” 権限を持つサービスキー
​
group_name
string
特定のグループのユーザーに結果を絞り込みます。emails パラメータと同時には使用できません。
​
start_timestamp
string
RFC 3339 形式の開始時刻（例: 2023-01-01T00:00:00Z）
​
end_timestamp
string
RFC 3339 形式の終了時刻（例: 2023-12-31T23:59:59Z）
​
emails
array
結果をフィルタリングするためのメールアドレス配列。group_name パラメータと同時には使用できません。
​
ide_types
array
IDE の種類でフィルタリングします。使用可能なオプション:
  • "editor" - Windsurf Editor
  • "jetbrains" - JetBrains Plugin
省略時は、両方の IDE のデータを返します。
​
query_requests
array
必須
実行するデータソースクエリの配列。各オブジェクトには、サポート対象のいずれかのデータソースを含めてください。

​
データソース

​
cascade_lines

1日ごとの Cascade の提案行数と受け入れ行数をクエリします。 
{
  "cascade_lines": {}
}
レスポンス項目:
  • day - RFC 3339 形式の日付
  • linesSuggested - 提案行数
  • linesAccepted - 受け入れ行数

​
cascade_runs

AI モデルの利用状況、クレジット消費量、モードに関するデータを照会します。 
{
  "cascade_runs": {}
}
レスポンスフィールド:
  • day - 日付（RFC 3339 形式）
  • model - 使用された AI モデル名
  • mode - Cascade のモード（下記のモードを参照）
  • messagesSent - 送信メッセージ数
  • cascadeId - 一意の会話 ID
  • promptsUsed - 消費クレジット（セント単位）
Cascade モード:
  • CONVERSATIONAL_PLANNER_MODE_DEFAULT - 書き込みモード
  • CONVERSATIONAL_PLANNER_MODE_READ_ONLY - 読み取りモード
  • CONVERSATIONAL_PLANNER_MODE_NO_TOOL - 旧モード
  • UNKNOWN - 不明なモード

​
cascade_tool_usage

ツール利用状況の統計（集計件数）を照会します。 
{
  "cascade_tool_usage": {}
}
レスポンスフィールド:
  • tool - ツール識別子（以下のツールマッピングを参照）
  • count - ツールの使用回数

​
ツール利用マッピング

ツール識別子表示名
CODE_ACTIONコード編集
VIEW_FILEファイル表示
RUN_COMMANDコマンド実行
FIND検索ツール
GREP_SEARCHGrep 検索
VIEW_FILE_OUTLINEファイルのアウトライン表示
MQUERYRiptide
WORKFLOWS_USED使用ワークフロー
LIST_DIRECTORYディレクトリ一覧
MCP_TOOLMCP ツール
PROPOSE_CODEコード提案
SEARCH_WEBWeb 検索
MEMORYメモリ
PROXY_WEB_SERVERブラウザプレビュー
DEPLOY_WEB_APPWeb アプリをデプロイ

​
リクエストの例

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2025-01-01T00:00:00Z",
  "end_timestamp": "2025-01-02T00:00:00Z",
  "emails": ["[email protected]", "[email protected]"],
  "ide_types": ["editor"],
  "query_requests": [
    {
      "cascade_lines": {}
    },
    {
      "cascade_runs": {}
    },
    {
      "cascade_tool_usage": {}
    }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics

​
レスポンス

​
queryResults
array
各クエリリクエストに対する結果の配列

​
返答例

{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "2025-05-01T00:00:00Z",
            "linesSuggested": "206",
            "linesAccepted": "157"
          },
          {
            "day": "2025-05-02T00:00:00Z",
            "linesSuggested": "16"
          }
        ]
      }
    },
    {
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "Claude 3.7 Sonnet (Thinking)",
            "mode": "CONVERSATIONAL_PLANNER_MODE_DEFAULT",
            "messagesSent": "1",
            "cascadeId": "0d35c1f7-0a85-41d0-ac96-a04cd2d64444"
          }
        ]
      }
    },
    {
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "CODE_ACTION",
            "count": "15"
          },
          {
            "tool": "LIST_DIRECTORY",
            "count": "20"
          }
        ]
      }
    }
  ]
}

​
注意事項

  • API は生データを返し、その中には「UNKNOWN」の値が含まれる場合があります
  • メトリクス分析では、関心のある特定のフィールドで集約してください（例: 利用傾向を把握するために promptsUsed を合計）
  • モードやプロンプトのデータは、複数のエントリに分割されている場合があります
  • クレジット消費量（promptsUsed）はセント単位で返されます（100 = 1 クレジット）