> ## 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.

# カスタム Analytics クエリ

> selections、フィルター、集計を指定できる柔軟な Analytics クエリで、Autocomplete、Chat、Command、PCW データを対象とします。

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

Custom Analytics API は、Autocomplete、Chat、Command のデータに対して、柔軟なクエリ機能を提供します。カスタマイズ可能な selections、フィルタ、集計、並び順を指定できます。

<div id="request">
  ## Request
</div>

<ParamField body="service_key" type="string" required>
  「Analytics Read」権限を持つサービスキー
</ParamField>

<ParamField body="group_name" type="string">
  特定のグループのユーザーに結果を絞り込みます（オプション）
</ParamField>

<ParamField body="query_requests" type="array" required>
  取得するデータを定義する query request オブジェクトの配列

  <Expandable title="Query Request オブジェクト">
    <ParamField body="data_source" type="string" required>
      クエリするデータソース。指定可能な値:

      * `QUERY_DATA_SOURCE_USER_DATA` - Autocomplete データ
      * `QUERY_DATA_SOURCE_CHAT_DATA` - Chat データ
      * `QUERY_DATA_SOURCE_COMMAND_DATA` - Command データ
      * `QUERY_DATA_SOURCE_PCW_DATA` - Percent Code Written データ
    </ParamField>

    <ParamField body="selections" type="array" required>
      取得するフィールド選択の配列

      <Expandable title="Selection オブジェクト">
        <ParamField body="field" type="string" required>
          選択するフィールド名（「Available Fields」セクションを参照）
        </ParamField>

        <ParamField body="name" type="string">
          フィールドのエイリアス。未指定の場合、デフォルトは `{aggregation_function}_{field_name}`（すべて小文字）です
        </ParamField>

        <ParamField body="aggregation_function" type="string">
          適用する集計関数:

          * `QUERY_AGGREGATION_UNSPECIFIED`（デフォルト）
          * `QUERY_AGGREGATION_COUNT`
          * `QUERY_AGGREGATION_SUM`
          * `QUERY_AGGREGATION_AVG`
          * `QUERY_AGGREGATION_MAX`
          * `QUERY_AGGREGATION_MIN`
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="filters" type="array">
      適用するフィルターの配列

      <Expandable title="Filter オブジェクト">
        <ParamField body="name" type="string" required>
          フィルターを適用するフィールド名
        </ParamField>

        <ParamField body="filter" type="string" required>
          フィルター条件:

          * `QUERY_FILTER_EQUAL`
          * `QUERY_FILTER_NOT_EQUAL`
          * `QUERY_FILTER_GREATER_THAN`
          * `QUERY_FILTER_LESS_THAN`
          * `QUERY_FILTER_GE`（以上）
          * `QUERY_FILTER_LE`（以下）
        </ParamField>

        <ParamField body="value" type="string" required>
          比較対象の値
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="aggregations" type="array">
      グループ化に使用する集計の配列

      <Expandable title="Aggregation オブジェクト">
        <ParamField body="field" type="string" required>
          グループ化のキーとするフィールド名
        </ParamField>

        <ParamField body="name" type="string" required>
          集計フィールドのエイリアス
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<div id="query-request-structure">
  ## クエリリクエストの構造
</div>

各クエリリクエストオブジェクトには以下が含まれます:

* **data\_source** (必須): クエリ対象のデータソース
* **selections** (必須): 取得するフィールド selections の配列
* **filters** (任意): 適用するフィルターの配列
* **aggregations** (任意): グループ化に使用する集計の配列

<div id="selections">
  ## Selections
</div>

Selections は、取得するフィールドとその集計方法を定義します。

* **field** (必須): 選択するフィールド名
* **name** (任意): フィールドのエイリアス
* **aggregation\_function** (任意): 適用する集計関数

<div id="selection-example">
  ### 選択例
</div>

```json theme={null}
{
  "field": "num_acceptances",
  "name": "total_acceptances",
  "aggregation_function": "QUERY_AGGREGATION_SUM"
}
```

<div id="filters">
  ## フィルター
</div>

フィルターは、特定の条件を満たす要素だけにデータを絞り込みます。

* **name** (必須): フィルター対象とするフィールド名
* **filter** (必須): フィルター演算
* **value** (必須): 比較する値

<div id="filter-example">
  ### フィルターの例
</div>

```json theme={null}
{
  "name": "language",
  "filter": "QUERY_FILTER_EQUAL",
  "value": "PYTHON"
}
```

<div id="aggregations">
  ## 集計
</div>

`aggregations` パラメータは、指定した条件でデータをグループ化（集計）します。

* **field** (必須): グループ化の対象となるフィールド名
* **name** (必須): 集計対象フィールドに付与するエイリアス名

<div id="aggregation-example">
  ### 集約の例
</div>

```json theme={null}
{
  "field": "ide",
  "name": "ide_type"
}
```

<div id="available-fields">
  ## 利用可能なフィールド
</div>

<div id="user-data">
  ### ユーザーデータ
</div>

すべてのユーザーデータはユーザーごとに、1時間単位で集計されます。

| フィールド名                     | 説明                                     | 有効な集計              |
| -------------------------- | -------------------------------------- | ------------------ |
| `api_key`                  | ユーザーのAPIキーのハッシュ                        | UNSPECIFIED, COUNT |
| `date`                     | AutocompleteのUTC日付                     | UNSPECIFIED, COUNT |
| `date UTC-x`               | タイムゾーンオフセット付きの日付（例: "date UTC-8" はPST） | UNSPECIFIED, COUNT |
| `hour`                     | AutocompleteのUTC時                      | UNSPECIFIED, COUNT |
| `language`                 | プログラミング言語                              | UNSPECIFIED, COUNT |
| `ide`                      | 使用しているIDE                              | UNSPECIFIED, COUNT |
| `version`                  | Windsurfのバージョン                         | UNSPECIFIED, COUNT |
| `num_acceptances`          | Autocompleteの受入回数                      | SUM, MAX, MIN, AVG |
| `num_lines_accepted`       | 受入れられたコード行数                            | SUM, MAX, MIN, AVG |
| `num_bytes_accepted`       | 受入れられたバイト数                             | SUM, MAX, MIN, AVG |
| `distinct_users`           | 一意のユーザー数                               | UNSPECIFIED, COUNT |
| `distinct_developer_days`  | 一意の（ユーザー、日）組                           | UNSPECIFIED, COUNT |
| `distinct_developer_hours` | 一意の（ユーザー、時）組                           | UNSPECIFIED, COUNT |

<div id="chat-data">
  ### Chat データ
</div>

<Info>Chat データは Cascade データとは分離されており、旧来の非エージェント型プラグインの利用状況を表します</Info>

すべての Chat データはユーザーの質問ではなく、Chat の AI モデルの応答を表します。

| Field Name                | Description                         | Valid Aggregations |
| ------------------------- | ----------------------------------- | ------------------ |
| `api_key`                 | ユーザー API キーのハッシュ                    | UNSPECIFIED, COUNT |
| `model_id`                | Chat のモデル ID                        | UNSPECIFIED, COUNT |
| `date`                    | Chat 応答の UTC 日付                     | UNSPECIFIED, COUNT |
| `date UTC-x`              | タイムゾーンオフセット付きの日付                    | UNSPECIFIED, COUNT |
| `ide`                     | 使用中の IDE                            | UNSPECIFIED, COUNT |
| `version`                 | Windsurf のバージョン                     | UNSPECIFIED, COUNT |
| `latest_intent_type`      | Chat のインテント種別（下記の Intent Types を参照） | UNSPECIFIED, COUNT |
| `num_chats_received`      | 受信したチャットメッセージ数                      | SUM, MAX, MIN, AVG |
| `chat_accepted`           | チャットが承認されたか（サムズアップ）                 | SUM, COUNT         |
| `chat_inserted_at_cursor` | 「Insert」ボタンがクリックされたか                | SUM, COUNT         |
| `chat_applied`            | 「Apply Diff」ボタンがクリックされたか            | SUM, COUNT         |
| `chat_loc_used`           | Chat から使用されたコード行数                   | SUM, MAX, MIN, AVG |

<div id="chat-intent-types">
  #### Chat のインテント種別
</div>

* `CHAT_INTENT_GENERIC` - 通常の Chat
* `CHAT_INTENT_FUNCTION_EXPLAIN` - 関数の説明用コードレンズ
* `CHAT_INTENT_FUNCTION_DOCSTRING` - 関数のドックストリング用コードレンズ
* `CHAT_INTENT_FUNCTION_REFACTOR` - 関数のリファクタリング用コードレンズ
* `CHAT_INTENT_CODE_BLOCK_EXPLAIN` - コードブロックの説明用コードレンズ
* `CHAT_INTENT_CODE_BLOCK_REFACTOR` - コードブロックのリファクタリング用コードレンズ
* `CHAT_INTENT_PROBLEM_EXPLAIN` - 問題説明用コードレンズ
* `CHAT_INTENT_FUNCTION_UNIT_TESTS` - 関数のユニットテスト用コードレンズ

<div id="command-data">
  ### Command データ
</div>

Command データには、却下されたものを含むすべてのコマンドが含まれます。`accepted` フィールドを使用して、受け入れられたコマンドのみに絞り込んでください。

| Field Name        | Description                             | Valid Aggregations |
| ----------------- | --------------------------------------- | ------------------ |
| `api_key`         | ユーザーの API キーのハッシュ                       | UNSPECIFIED, COUNT |
| `date`            | コマンドの UTC 日付                            | UNSPECIFIED, COUNT |
| `timestamp`       | コマンドの UTC タイムスタンプ                       | UNSPECIFIED, COUNT |
| `language`        | プログラミング言語                               | UNSPECIFIED, COUNT |
| `ide`             | 使用中の IDE                                | UNSPECIFIED, COUNT |
| `version`         | Windsurf のバージョン                         | UNSPECIFIED, COUNT |
| `command_source`  | Command のトリガー元（下記の Command Sources を参照） | UNSPECIFIED, COUNT |
| `provider_source` | 生成モードまたは編集モード                           | UNSPECIFIED, COUNT |
| `lines_added`     | 追加されたコード行数                              | SUM, MAX, MIN, AVG |
| `lines_removed`   | 削除されたコード行数                              | SUM, MAX, MIN, AVG |
| `bytes_added`     | 追加されたバイト数                               | SUM, MAX, MIN, AVG |
| `bytes_removed`   | 削除されたバイト数                               | SUM, MAX, MIN, AVG |
| `selection_lines` | 選択行数（生成時は 0）                            | SUM, MAX, MIN, AVG |
| `selection_bytes` | 選択バイト数（生成時は 0）                          | SUM, MAX, MIN, AVG |
| `accepted`        | コマンドが受け入れられたかどうか                        | SUM, COUNT         |

<div id="command-sources">
  #### Command の発行元
</div>

* `COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS`
* `COMMAND_REQUEST_SOURCE_DEFAULT` - 一般的な Command の使い方
* `COMMAND_REQUEST_SOURCE_RIGHT_CLICK_REFACTOR`
* `COMMAND_REQUEST_SOURCE_FUNCTION_CODE_LENS`
* `COMMAND_REQUEST_SOURCE_FOLLOWUP`
* `COMMAND_REQUEST_SOURCE_CLASS_CODE_LENS`
* `COMMAND_REQUEST_SOURCE_PLAN`
* `COMMAND_REQUEST_SOURCE_SELECTION_HINT_CODE_LENS`

<div id="provider-sources">
  #### プロバイダーのソース
</div>

* `PROVIDER_SOURCE_COMMAND_GENERATE` - 生成モード
* `PROVIDER_SOURCE_COMMAND_EDIT` - 編集モード

<div id="pcw-data">
  ### PCW データ
</div>

Autocomplete と Command の寄与を個別に追跡した Percent Code Written データ。

| Field Name                      | Description                                         | Valid Aggregations |
| ------------------------------- | --------------------------------------------------- | ------------------ |
| `percent_code_written`          | codeium\_bytes / (codeium\_bytes + user\_bytes) で算出 | UNSPECIFIED        |
| `codeium_bytes`                 | Codeium が生成した合計バイト数                                 | UNSPECIFIED        |
| `user_bytes`                    | ユーザーが作成した合計バイト数                                     | UNSPECIFIED        |
| `total_bytes`                   | codeium\_bytes + user\_bytes                        | UNSPECIFIED        |
| `codeium_bytes_by_autocomplete` | Autocomplete による Codeium のバイト数                      | UNSPECIFIED        |
| `codeium_bytes_by_command`      | Command による Codeium のバイト数                           | UNSPECIFIED        |

<div id="pcw-filters">
  #### PCW フィルター
</div>

| フィールド名     | 説明              | 例                 |
| ---------- | --------------- | ----------------- |
| `language` | プログラミング言語       | KOTLIN, GO, JAVA  |
| `ide`      | 使用している IDE      | jetbrains, vscode |
| `version`  | Windsurf のバージョン | 1.28.0, 130.0     |

PCW のクエリで日付による絞り込みを行うには、メインのリクエストボディで `start_timestamp` と `end_timestamp` を使用します。

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

<div id="user-data-example">
  ### ユーザー データの例
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_USER_DATA",
      "selections": [
        {
          "field": "num_acceptances",
          "name": "total_acceptances",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "num_lines_accepted",
          "name": "total_lines",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "date",
          "filter": "QUERY_FILTER_GE",
          "value": "2024-01-01"
        },
        {
          "name": "date",
          "filter": "QUERY_FILTER_LE",
          "value": "2024-02-01"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics
```

<div id="chat-data-example">
  ### Chat データの例
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_CHAT_DATA",
      "selections": [
        {
          "field": "chat_loc_used",
          "name": "lines_used",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "latest_intent_type",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "CHAT_INTENT_FUNCTION_DOCSTRING"
        }
      ],
      "aggregations": [
        {
          "field": "ide",
          "name": "ide_type"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics
```

<div id="command-data-example">
  ### Command データの例
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_COMMAND_DATA",
      "selections": [
        {
          "field": "lines_added",
          "name": "total_lines_added",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "lines_removed",
          "name": "total_lines_removed",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "provider_source",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "PROVIDER_SOURCE_COMMAND_EDIT"
        },
        {
          "name": "accepted",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "true"
        }
      ],
      "aggregations": [
        {
          "field": "language",
          "name": "programming_language"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics
```

<div id="pcw-data-example">
  ### PCW データ例
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-22T00:00:00Z",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_PCW_DATA",
      "selections": [
        {
          "field": "percent_code_written",
          "name": "pcw"
        },
        {
          "field": "codeium_bytes",
          "name": "ai_bytes"
        },
        {
          "field": "total_bytes",
          "name": "total"
        },
        {
          "field": "codeium_bytes_by_autocomplete",
          "name": "autocomplete_bytes"
        },
        {
          "field": "codeium_bytes_by_command",
          "name": "command_bytes"
        }
      ],
      "filters": [
        {
          "filter": "QUERY_FILTER_EQUAL",
          "name": "language",
          "value": "GO"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics
```

<div id="response">
  ## レスポンス
</div>

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

  <ResponseField name="responseItems" type="array">
    結果項目の配列

    <ResponseField name="item" type="object">
      選択されたフィールドとその値を持つオブジェクト
    </ResponseField>
  </ResponseField>
</ResponseField>

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

<div id="user-data-response">
  #### ユーザーデータの応答
</div>

```json theme={null}
{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "total_acceptances": "125",
            "total_lines": "863"
          }
        }
      ]
    }
  ]
}
```

<div id="chat-data-response">
  #### Chat データ レスポンス
</div>

```json theme={null}
{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "lines_used": "74",
            "ide_type": "jetbrains"
          }
        },
        {
          "item": {
            "lines_used": "41",
            "ide_type": "vscode"
          }
        }
      ]
    }
  ]
}
```

<div id="command-data-response">
  #### Command データのレスポンス
</div>

```json theme={null}
{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "programming_language": "PYTHON",
            "total_lines_added": "21",
            "total_lines_removed": "5"
          }
        },
        {
          "item": {
            "programming_language": "GO",
            "total_lines_added": "31",
            "total_lines_removed": "27"
          }
        }
      ]
    }
  ]
}
```

<div id="pcw-data-response">
  #### PCW データ レスポンス
</div>

```json theme={null}
{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "ai_bytes": "6018",
            "autocomplete_bytes": "4593",
            "command_bytes": "1425",
            "pcw": "0.61",
            "total": "9900"
          }
        }
      ]
    }
  ]
}
```

<div id="important-notes">
  ## 重要な注意事項
</div>

* PCW (Percent Code Written) は、日ごと・ユーザーごとの値のばらつきが大きいため、より有用なインサイトを得るには週単位で集計・分析することを推奨します
* すべての selection フィールドは、集計関数を持つかまったく持たないかのいずれかでなければなりません（混在させることはできません）
* `"distinct_*"` パターンを持つフィールドは集計には使用できません
* フィールドエイリアスは、すべての `selections` および 集計 を通して一意でなければなりません
* 集計関数が指定されていない場合、デフォルトは `UNSPECIFIED` になります