メインコンテンツへスキップ
POST
/
api
/
v1
/
UserPageAnalytics
ユーザーページ分析を取得
curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Authorization: Bearer <token>' \
  --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>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
概要

Teamsページに表示されるユーザーアクティビティの統計情報を取得します。これには、ユーザー名、メールアドレス、最終アクティビティ時刻、アクティブだった日数、利用したプロンプトクレジットが含まれます。

​
リクエスト

​
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
問題の内容を説明するエラーメッセージ
一般的なエラー例:
  • サービスキーが無効、または権限が不足している
  • タイムスタンプの形式が無効
  • グループが見つかりません
  • レート制限を超えました