メインコンテンツへスキップ
POST
/
api
/
v1
/
UserPageAnalytics
ユーザーページのAnalyticsを取得する
curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>"
}
'
{
  "userTableStats": [
    {
      "name": "<string>",
      "email": "<string>",
      "lastUpdateTime": "<string>",
      "apiKey": "<string>",
      "activeDays": 123,
      "disableCodeium": true,
      "role": "<string>",
      "signupTime": "<string>",
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>",
      "promptCreditsUsed": 123,
      "teamStatus": "<string>"
    }
  ],
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>",
  "error": "<string>"
}

​
概要

Teams ページに表示されるユーザーアクティビティ統計を取得します。ユーザー名、emails、最終アクティビティ時刻、アクティブ日数、使用されたプロンプトクレジットが含まれます。

​
リクエスト

​
service_key
string
必須
Teams Read-only 権限を持つサービスキー
​
group_name
string
特定のグループのユーザーに結果を絞り込み（任意）
​
start_timestamp
string
RFC 3339 形式の開始時刻（例: 2023-01-01T00:00:00Z）。 activeDays の計算にのみ影響します。 指定しない場合、デフォルトは 1 年前になります。
​
end_timestamp
string
RFC 3339 形式の終了時刻（例: 2023-12-31T23:59:59Z）。 activeDays の計算にのみ影響します。 指定しない場合、デフォルトは現在時刻になります。

​
リクエストの例

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-31T23:59:59Z"
}' \
https://server.codeium.com/api/v1/UserPageAnalytics

​
レスポンス

​
userTableStats
array
ユーザー統計オブジェクトの配列
​
billingCycleStart
string
現在の請求サイクルの開始時刻（RFC 3339 形式）。userTableStats 内の promptCreditsUsed の値は、この請求サイクル中の利用に対応します。
​
billingCycleEnd
string
現在の請求サイクルの終了時刻（RFC 3339 形式）。userTableStats 内の promptCreditsUsed の値は、この請求サイクル中の利用に対応します。

​
返答例

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@windsurf.com",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178,
      "role": "admin",
      "signupTime": "2024-01-15T08:30:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T22:56:10Z",
      "lastChatUsageTime": "2024-10-10T20:30:00Z",
      "promptCreditsUsed": 12500,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Bob",
      "email": "bob@windsurf.com",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 210,
      "role": "member",
      "signupTime": "2024-02-01T10:00:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T18:11:23Z",
      "lastChatUsageTime": "2024-10-09T14:22:00Z",
      "lastCommandUsageTime": "2024-10-08T09:15:00Z",
      "promptCreditsUsed": 8300,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    }
  ],
  "billingCycleStart": "2024-10-01T00:00:00Z",
  "billingCycleEnd": "2024-11-01T00:00:00Z"
}

​
エラー応答

​
error
string
何が問題だったかを説明するエラーメッセージ
代表的なエラー例:
  • 無効なサービスキーまたは権限不足
  • 無効なタイムスタンプ形式
  • グループが見つからない
  • レート制限を超過した場合