> ## 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ページから、名前、メールアドレス、最終アクティビティ時刻、アクティブ日数、使用したプロンプトクレジットを含むユーザーアクティビティの統計を取得します。

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

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

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

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

<ParamField body="group_name" type="string">
  特定のグループに属するユーザーに結果を絞り込みます (省略可)
</ParamField>

<ParamField body="start_timestamp" type="string">
  RFC 3339 形式の開始時刻 (例: `2023-01-01T00:00:00Z`) 。**`activeDays` の計算にのみ影響します。** 指定しない場合、デフォルトで 1 年前の時刻が使用されます。
</ParamField>

<ParamField body="end_timestamp" type="string">
  RFC 3339 形式の終了時刻 (例: `2023-12-31T23:59:59Z`) 。**`activeDays` の計算にのみ影響します。** 指定しない場合、デフォルトで現在時刻が使用されます。
</ParamField>

<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": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-31T23:59:59Z"
}' \
https://server.codeium.com/api/v1/UserPageAnalytics
```

<div id="response">
  ## 応答
</div>

<ResponseField name="userTableStats" type="array">
  ユーザー統計オブジェクトの配列

  <Expandable title="ユーザー統計オブジェクト">
    <ResponseField name="name" type="string">
      ユーザーの表示名
    </ResponseField>

    <ResponseField name="email" type="string">
      ユーザーのメールアドレス
    </ResponseField>

    <ResponseField name="lastUpdateTime" type="string">
      ユーザーの最後のアクティビティのタイムスタンプ (RFC 3339形式)
    </ResponseField>

    <ResponseField name="apiKey" type="string">
      ユーザーのAPIキーをハッシュ化した値
    </ResponseField>

    <ResponseField name="activeDays" type="number">
      クエリ対象の期間 (`start_timestamp` と `end_timestamp` で定義) 内で、ユーザーがアクティブだった日数です。オートコンプリートの受け入れ、Cascadeの使用、またはコマンドの使用がその日に1回でもあった場合、その日はアクティブとしてカウントされます。
    </ResponseField>

    <ResponseField name="disableCodeium" type="boolean">
      管理者によって、そのユーザーのDevin Desktopへのアクセスが無効にされているかどうかを示します。このフィールドは、アクセスが明示的に無効化されている場合にのみ含まれ、その場合の値は常にtrueです。
    </ResponseField>

    <ResponseField name="role" type="string">
      チーム内でのユーザーの役割 (例: `admin`, `member`)
    </ResponseField>

    <ResponseField name="signupTime" type="string">
      ユーザーが登録した日時のタイムスタンプ (RFC 3339形式)
    </ResponseField>

    <ResponseField name="lastAutocompleteUsageTime" type="string">
      Tab/Autocompleteモダリティが最後に使用された日時のタイムスタンプ (RFC 3339形式)
    </ResponseField>

    <ResponseField name="lastChatUsageTime" type="string">
      Cascadeモダリティが最後に使用された日時のタイムスタンプ (RFC 3339形式)
    </ResponseField>

    <ResponseField name="lastCommandUsageTime" type="string">
      Commandモダリティが最後に使用された日時のタイムスタンプ (RFC 3339形式)
    </ResponseField>

    <ResponseField name="promptCreditsUsed" type="number">
      このユーザーが**現在の請求サイクル**中に使用したプロンプトクレジットの合計で、**セント**単位で返されます (1クレジット = 100セント) 。実際のクレジット使用量を求めるには、この値を100で割ってください。この値は、`start_timestamp` や `end_timestamp` のリクエストパラメータの影響を**受けません**。請求サイクルの期間は、トップレベルの `billingCycleStart` フィールドと `billingCycleEnd` フィールドで示されます。
    </ResponseField>

    <ResponseField name="teamStatus" type="string">
      ユーザーのチームメンバーシップのステータスです。取りうる値: `USER_TEAM_STATUS_UNSPECIFIED`, `USER_TEAM_STATUS_PENDING`, `USER_TEAM_STATUS_APPROVED`, `USER_TEAM_STATUS_REJECTED`。APIはチームステータスに関係なくすべてのユーザーを返しますが、`Manage Members` UIには承認済みユーザーのみが表示される点に注意してください。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="billingCycleStart" type="string">
  現在の請求サイクルの開始時点 (RFC 3339形式) です。`userTableStats` 内の `promptCreditsUsed` の値は、この請求サイクル内の使用量に対応します。
</ResponseField>

<ResponseField name="billingCycleEnd" type="string">
  現在の請求サイクルの終了時点 (RFC 3339形式) です。`userTableStats` 内の `promptCreditsUsed` の値は、この請求サイクル内の使用量に対応します。
</ResponseField>

<div id="example-response">
  ### レスポンスの例
</div>

```json theme={null}
{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@cognition.ai",
      "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@cognition.ai",
      "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"
}
```

<div id="error-responses">
  ## エラーレスポンス
</div>

<ResponseField name="error" type="string">
  問題の内容を説明するエラーメッセージ
</ResponseField>

一般的なエラー例:

* サービスキーが無効、または権限が不足している
* タイムスタンプの形式が無効
* グループが見つかりません
* レート制限を超えました