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

# 获取用户页面分析数据

> 获取团队页面中的用户活动统计数据，包括姓名、电子邮件、上次活动时间、活跃天数以及已使用的提示额度。

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

获取团队页面上显示的用户活动统计信息，包括用户名、电子邮件、最近活动时间、活跃天数以及已使用的提示额度。

<div id="request">
  ## 请求
</div>

<ParamField body="service_key" type="string" required>
  具有“Teams 只读”权限的服务密钥
</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，或使用了命令，则该天计为活跃。
    </ResponseField>

    <ResponseField name="disableCodeium" type="boolean">
      表示该用户的 Devin Desktop 访问权限是否已被 Admin 禁用。仅当访问权限被明确禁用时，此字段才会出现，且在这种情况下其值始终为 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” 界面仅显示已批准的用户。
    </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>

常见错误情况：

* 服务密钥无效或权限不足
* 时间戳格式无效
* 未找到组
* 超出速率限制