> ## Documentation Index
> Fetch the complete documentation index at: https://docs.windsurf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cascade Analytics の取得

> Cascade 専用の利用メトリクス（提案/受け入れされた行数、AI モデルの利用状況、クレジット消費量、ツール利用統計など）を照会する

<div id="overview">
  ## 概要
</div>

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

<div id="request">
  ## リクエスト
</div>

<ParamField body="service_key" type="string" required>
  "Teams Read-only" 権限を持つサービスキー
</ParamField>

<ParamField body="group_name" type="string">
  特定のグループのユーザーに結果を絞り込みます。`emails` パラメータと同時には使用できません。
</ParamField>

<ParamField body="start_timestamp" type="string">
  RFC 3339 形式の開始時刻（例: `2023-01-01T00:00:00Z`）
</ParamField>

<ParamField body="end_timestamp" type="string">
  RFC 3339 形式の終了時刻（例: `2023-12-31T23:59:59Z`）
</ParamField>

<ParamField body="emails" type="array">
  結果をフィルタリングするためのメールアドレス配列。`group_name` パラメータと同時には使用できません。
</ParamField>

<ParamField body="ide_types" type="array">
  IDE の種類でフィルタリングします。使用可能なオプション:

  * `"editor"` - Windsurf Editor
  * `"jetbrains"` - JetBrains Plugin

  省略時は、両方の IDE のデータを返します。
</ParamField>

<ParamField body="query_requests" type="array" required>
  実行するデータソースクエリの配列。各オブジェクトには、サポート対象のいずれかのデータソースを含めてください。
</ParamField>

<div id="data-sources">
  ## データソース
</div>

<div id="cascade_lines">
  ### cascade\_lines
</div>

1日ごとの Cascade の提案行数と受け入れ行数をクエリします。

```json theme={null}
{
  "cascade_lines": {}
}
```

**レスポンス項目:**

* `day` - RFC 3339 形式の日付
* `linesSuggested` - 提案行数
* `linesAccepted` - 受け入れ行数

<div id="cascade_runs">
  ### cascade\_runs
</div>

AI モデルの使用状況、クレジット消費量、およびモードに関するデータをクエリします。

```json theme={null}
{
  "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` - 不明なモード

<div id="cascade_tool_usage">
  ### cascade\_tool\_usage
</div>

ツール使用統計（集計件数）を取得します。

```json theme={null}
{
  "cascade_tool_usage": {}
}
```

**レスポンスフィールド:**

* `tool` - ツール ID（下記のツールマッピングを参照）
* `count` - ツールが使用された回数

<div id="tool-usage-mappings">
  ## ツール利用マッピング
</div>

| Tool Identifier     | 表示名          |
| ------------------- | ------------ |
| `CODE_ACTION`       | コード編集        |
| `VIEW_FILE`         | ファイル表示       |
| `RUN_COMMAND`       | コマンド実行       |
| `FIND`              | 検索ツール        |
| `GREP_SEARCH`       | Grep 検索      |
| `VIEW_FILE_OUTLINE` | ファイルアウトライン表示 |
| `MQUERY`            | Riptide      |
| `WORKFLOWS_USED`    | 使用ワークフロー     |
| `LIST_DIRECTORY`    | ディレクトリ一覧     |
| `MCP_TOOL`          | MCP ツール      |
| `PROPOSE_CODE`      | コード提案        |
| `SEARCH_WEB`        | Web 検索       |
| `MEMORY`            | メモリ          |
| `PROXY_WEB_SERVER`  | ブラウザプレビュー    |
| `DEPLOY_WEB_APP`    | Web アプリデプロイ  |

<div id="example-request">
  ## リクエストの例
</div>

```bash theme={null}
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": ["user1@windsurf.com", "user2@windsurf.com"],
  "ide_types": ["editor"],
  "query_requests": [
    {
      "cascade_lines": {}
    },
    {
      "cascade_runs": {}
    },
    {
      "cascade_tool_usage": {}
    }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics
```

<div id="response">
  ## Response
</div>

<ResponseField name="queryResults" type="array">
  各クエリリクエストに対する結果の配列

  <Expandable title="Cascade Lines Result">
    <ResponseField name="cascadeLines" type="object">
      <ResponseField name="cascadeLines" type="array">
        日次の行数統計の配列

        <ResponseField name="day" type="string">
          RFC 3339 形式の日付
        </ResponseField>

        <ResponseField name="linesSuggested" type="string">
          この日に提案された行数
        </ResponseField>

        <ResponseField name="linesAccepted" type="string">
          この日に受け入れられた行数
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>

  <Expandable title="Cascade Runs Result">
    <ResponseField name="cascadeRuns" type="object">
      <ResponseField name="cascadeRuns" type="array">
        AI モデルの使用状況統計の配列

        <ResponseField name="day" type="string">
          RFC 3339 形式の日付
        </ResponseField>

        <ResponseField name="model" type="string">
          この実行で使用された AI モデル名
        </ResponseField>

        <ResponseField name="mode" type="string">
          Cascade のモード識別子
        </ResponseField>

        <ResponseField name="messagesSent" type="string">
          送信されたメッセージ数
        </ResponseField>

        <ResponseField name="cascadeId" type="string">
          一意の会話識別子
        </ResponseField>

        <ResponseField name="promptsUsed" type="string">
          消費したクレジット数（セント単位、例: "100" = 1 credit）
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>

  <Expandable title="Cascade Tool Usage Result">
    <ResponseField name="cascadeToolUsage" type="object">
      <ResponseField name="cascadeToolUsage" type="array">
        ツール使用状況統計の配列

        <ResponseField name="tool" type="string">
          ツール識別子
        </ResponseField>

        <ResponseField name="count" type="string">
          ツールが使用された回数
        </ResponseField>
      </ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>

<div id="example-response">
  ### 返答例
</div>

```json theme={null}
{
  "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"
          }
        ]
      }
    }
  ]
}
```

<div id="notes">
  ## 注意事項
</div>

* API は未加工のデータを返し、その中には「UNKNOWN」という値が含まれる場合があります
* メトリクス分析では、関心のある特定のフィールドごとに集計します（例: 使用パターン分析のために `promptsUsed` を合計する）
* Mode や prompt のデータは、複数のエントリに分割されている場合があります
* クレジット消費量（`promptsUsed`）はセント単位で返されます（100 = 1 クレジット）