メインコンテンツへスキップ
POST
/
api
/
v1
/
Analytics
カスタム Analytics クエリ
curl --request POST \
  --url https://server.codeium.com/api/v1/Analytics \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "query_requests": [
    {
      "data_source": "<string>",
      "selections": [
        {
          "field": "<string>",
          "name": "<string>",
          "aggregation_function": "<string>"
        }
      ],
      "filters": [
        {
          "name": "<string>",
          "filter": "<string>",
          "value": "<string>"
        }
      ],
      "aggregations": [
        {
          "field": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}
'
{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {}
        }
      ]
    }
  ]
}

​
概要

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

​
Request

​
service_key
string
必須
「Analytics Read」権限を持つサービスキー
​
group_name
string
特定のグループのユーザーに結果を絞り込みます（オプション）
​
query_requests
array
必須
取得するデータを定義する query request オブジェクトの配列

​
クエリリクエストの構造

各クエリリクエストオブジェクトには以下が含まれます:
  • data_source (必須): クエリ対象のデータソース
  • selections (必須): 取得するフィールド selections の配列
  • filters (任意): 適用するフィルターの配列
  • aggregations (任意): グループ化に使用する集計の配列

​
Selections

Selections は、取得するフィールドとその集計方法を定義します。
  • field (必須): 選択するフィールド名
  • name (任意): フィールドのエイリアス
  • aggregation_function (任意): 適用する集計関数

​
選択例

{
  "field": "num_acceptances",
  "name": "total_acceptances",
  "aggregation_function": "QUERY_AGGREGATION_SUM"
}

​
フィルター

フィルターは、特定の条件を満たす要素だけにデータを絞り込みます。
  • name (必須): フィルター対象とするフィールド名
  • filter (必須): フィルター演算
  • value (必須): 比較する値

​
フィルターの例

{
  "name": "language",
  "filter": "QUERY_FILTER_EQUAL",
  "value": "PYTHON"
}

​
集計

aggregations パラメータは、指定した条件でデータをグループ化（集計）します。
  • field (必須): グループ化の対象となるフィールド名
  • name (必須): 集計対象フィールドに付与するエイリアス名

​
集約の例

{
  "field": "ide",
  "name": "ide_type"
}

​
利用可能なフィールド

​
ユーザーデータ

すべてのユーザーデータはユーザーごとに、1時間単位で集計されます。
フィールド名説明有効な集計
api_keyユーザーのAPIキーのハッシュUNSPECIFIED, COUNT
dateAutocompleteのUTC日付UNSPECIFIED, COUNT
date UTC-xタイムゾーンオフセット付きの日付（例: “date UTC-8” はPST）UNSPECIFIED, COUNT
hourAutocompleteのUTC時UNSPECIFIED, COUNT
languageプログラミング言語UNSPECIFIED, COUNT
ide使用しているIDEUNSPECIFIED, COUNT
versionWindsurfのバージョンUNSPECIFIED, COUNT
num_acceptancesAutocompleteの受入回数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

​
Chat データ

Chat データは Cascade データとは分離されており、旧来の非エージェント型プラグインの利用状況を表します
すべての Chat データはユーザーの質問ではなく、Chat の AI モデルの応答を表します。
Field NameDescriptionValid Aggregations
api_keyユーザー API キーのハッシュUNSPECIFIED, COUNT
model_idChat のモデル IDUNSPECIFIED, COUNT
dateChat 応答の UTC 日付UNSPECIFIED, COUNT
date UTC-xタイムゾーンオフセット付きの日付UNSPECIFIED, COUNT
ide使用中の IDEUNSPECIFIED, COUNT
versionWindsurf のバージョンUNSPECIFIED, COUNT
latest_intent_typeChat のインテント種別（下記の 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_usedChat から使用されたコード行数SUM, MAX, MIN, AVG

​
Chat のインテント種別

  • 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 - 関数のユニットテスト用コードレンズ

​
Command データ

Command データには、却下されたものを含むすべてのコマンドが含まれます。accepted フィールドを使用して、受け入れられたコマンドのみに絞り込んでください。
Field NameDescriptionValid Aggregations
api_keyユーザーの API キーのハッシュUNSPECIFIED, COUNT
dateコマンドの UTC 日付UNSPECIFIED, COUNT
timestampコマンドの UTC タイムスタンプUNSPECIFIED, COUNT
languageプログラミング言語UNSPECIFIED, COUNT
ide使用中の IDEUNSPECIFIED, COUNT
versionWindsurf のバージョンUNSPECIFIED, COUNT
command_sourceCommand のトリガー元（下記の 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

​
Command の発行元

  • 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

​
プロバイダーのソース

  • PROVIDER_SOURCE_COMMAND_GENERATE - 生成モード
  • PROVIDER_SOURCE_COMMAND_EDIT - 編集モード

​
PCW データ

Autocomplete と Command の寄与を個別に追跡した Percent Code Written データ。
Field NameDescriptionValid Aggregations
percent_code_writtencodeium_bytes / (codeium_bytes + user_bytes) で算出UNSPECIFIED
codeium_bytesCodeium が生成した合計バイト数UNSPECIFIED
user_bytesユーザーが作成した合計バイト数UNSPECIFIED
total_bytescodeium_bytes + user_bytesUNSPECIFIED
codeium_bytes_by_autocompleteAutocomplete による Codeium のバイト数UNSPECIFIED
codeium_bytes_by_commandCommand による Codeium のバイト数UNSPECIFIED

​
PCW フィルター

フィールド名説明例
languageプログラミング言語KOTLIN, GO, JAVA
ide使用している IDEjetbrains, vscode
versionWindsurf のバージョン1.28.0, 130.0
PCW のクエリで日付による絞り込みを行うには、メインのリクエストボディで start_timestamp と end_timestamp を使用します。

​
例リクエスト

​
ユーザー データの例

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

​
Chat データの例

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

​
Command データの例

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

​
PCW データ例

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

​
レスポンス

​
queryResults
array
各クエリリクエストに対応するクエリ結果の配列
​
responseItems
array
結果項目の配列
​
item
object
選択されたフィールドとその値を持つオブジェクト

​
返答例

​
ユーザーデータの応答

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "total_acceptances": "125",
            "total_lines": "863"
          }
        }
      ]
    }
  ]
}

​
Chat データ レスポンス

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "lines_used": "74",
            "ide_type": "jetbrains"
          }
        },
        {
          "item": {
            "lines_used": "41",
            "ide_type": "vscode"
          }
        }
      ]
    }
  ]
}

​
Command データのレスポンス

{
  "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"
          }
        }
      ]
    }
  ]
}

​
PCW データ レスポンス

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

​
重要な注意事項

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