> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trae.cn/llms.txt?lang=zh
> Use this file to discover all available pages before exploring further.

查询指定时间范围内，指定成员在各个模型中的 Token 用量和扣费金额。

## 所需权限 {#hD5leSQPI}

`statistics:read`

## 请求说明 {#2a5ff28e}

* 请求方式：`POST`
* 请求地址：`{域名}/openapi/v1/statistics/user-model-usage`

## 注意事项 {#hnN74Eogt}


* 时间跨度最长为 180 天。
* `user_ids` 与 `emails` 至少传入一个。系统会分别去除重复的成员 ID 和邮箱；去重后，两个数组的元素总数不得超过 100。同一成员同时通过 ID 和邮箱传入时，仍按两个元素计数，但响应中该成员只返回一次。

## 请求参数 {#请求参数}

### 请求头参数 {#请求头参数}

<!-- @cols-width: 172,122,596 -->
| **Header 参数**  | **是否必填**  | **描述**  |
| --- | --- | --- |
| `Authorization`  | 是  | 固定取值为 `Bearer {access_token}`。关于如何获取访问令牌，参考[鉴权](enterprise_authentication)。  |
| `Content-Type`  | 是  | 固定取值为 `application/json`。  |

### 请求体参数 {#3fe003ca}

<!-- @cols-width: 141,133,105,100,409 -->
| **参数**  | **类型**  | **是否必填**  | **默认值**  | **描述**  |
| --- | --- | --- | --- | --- |
| `start_time`  | int64  | 是  | \-  | 查询开始时间，Unix 秒时间戳。  |
| `end_time`  | int64  | 是  | \-  | 查询结束时间，Unix 秒时间戳。  |
| `user_ids`  | string[] 或 int[]  | 条件必填  | \-  | 目标成员的 ID 列表。与 `emails` 至少传一个。 | \
| | | | | | \
| | | | | 成员的 ID 可以通过 “[获取成员列表](/enterprise_get-user-list)” 接口获取。  |
| `emails`  | string[]  | 条件必填  | \-  | 目标成员的邮箱列表。与 `user_ids` 至少传一个。 | \
| | | | | | \
| | | | | 成员的邮箱可以通过 “[获取成员列表](/enterprise_get-user-list)” 接口获取。  |

## 响应参数 {#19c99c7b}

该接口独有的响应参数如下，参数位于 `data` 数组中。通用响应参数参考[此文档](/enterprise_general-response-schema)。

<!-- @cols-width: 340,116,456 -->
| **参数**  | **类型**  | **描述**  |
| --- | --- | --- |
| `items`  | array  | 成员维度的结果列表。  |
| `items[].user_id`  | string  | 成员的用户 ID。  |
| `items[].email`  | string  | 成员的邮箱。  |
| `items[].account_type`  | int  | 成员的账号类型，取值： | \
| | | | \
| | | * `1`：全端账号 | \
| | | * `2`：Work 专属账号  |
| `items[].model_usage`  | array  | 成员的用量信息，按模型汇总。  |
| `items[].model_usage[].model_name`  | string  | 产生用量的模型名称。  |
| `items[].model_usage[].model_type`  | string  | 产生用量的模型能力类型，取值： | \
| | | | \
| | | * `Chat`：AI 问答 | \
| | | * `CUE`：代码补全  |
| `items[].model_usage[].model_source`  | string  | 模型来源，取值： | \
| | | | \
| | | * `Trae`：TRAE 内置模型 | \
| | | * `Custom`：企业自定义模型  |
| `items[].model_usage[].usage`  | object  | Token 用量汇总信息。  |
| `items[].model_usage[].usage.input_tokens`  | uint64  | 输入 Token 消耗总数。  |
| `items[].model_usage[].usage.output_tokens`  | uint64  | 输出 Token 消耗总数。  |
| `items[].model_usage[].amount`  | object  | 折算后的实际扣费金额。 | \
| | | | \
| | | ***提示***：`amount` 对象中的参数仅统计 TRAE 内置模型消耗的金额。若为企业自定义模型，皆返回 “`0.000000`”。  |
| `items[].model_usage[].amount.basic_amount`  | string  | 折算后，所使用的基础会话额度对应的金额消耗。返回十进制金额字符串，固定保留 6 位小数，例如 `1.500000`。  |
| `items[].model_usage[].amount.pay_go_amount`  | string  | 折算后的按量计费消耗金额。返回十进制金额字符串，固定保留 6 位小数，例如 `1.500000`。  |
| `items[].model_usage[].amount.total_amount`  | string  | 折算后的总消耗金额，即 `basic_amount` 与 `pay_go_amount` 之和。返回十进制金额字符串，固定保留 6 位小数，例如 `1.500000`。  |
| `items[].model_usage[].amount.currency`  | string  | 扣费金额的币种，取值： | \
| | | | \
| | | * `CNY`：人民币 | \
| | | * `USD`：美金  |

## 示例 {#示例}

### 请求示例 {#5de0bd2b}

```Bash
curl -X POST "${HOST}/openapi/v1/statistics/user-model-usage" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "start_time": 1780000000,
    "end_time": 1780600000,
    "user_ids": [
      "123456"
    ]
  }'
```

### 响应示例 {#dbb31a0b}

```JSON
{
  "code": 0,
  "message": "success",
  "request_id": "req_xxx",
  "data": {
    "items": [
      {
        "user_id": "123456",
        "email": "alice@example.com",
        "account_type": 1,
        "model_usage": [
          {
            "model_name": "model-a",
            "model_type": "Chat",
            "model_source": "Trae",
            "usage": {
              "input_tokens": 120000,
              "output_tokens": 34000
            },
            "amount": {
              "basic_amount": "12.500000",
              "pay_go_amount": "3.200000",
              "total_amount": "15.700000",
              "currency": "CNY"
            }
          }
        ]
      }
    ]
  }
}
```

## 错误码 {#错误码}

若该接口的请求返回错误码，参考[错误码](/enterprise_error-codes)文档进行排查。