获取组织峰值 RPM
获取组织峰值 RPM
按时间区间获取组织的峰值 RPM(每分钟请求数):先把组织下所有 Agent 在同一分钟的请求数相加,再取区间内最大的那一分钟,同时返回峰值发生的时刻、平均 RPM 和请求总数。
注意:最多查询 31 天的数据;只统计开发空间的渠道,统计范围见下方「统计口径」。
请求方式
GET
调用地址
https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm
调用验证
使用账号级 DevKey / DevSecret 的 Basic 鉴权:Authorization: Basic ${BASIC_TOKEN},其中 ${BASIC_TOKEN} 为 DevKey:DevSecret 的 Base64 编码。
- 调用账号必须是
org_id对应组织的成员,并具备「用量查看」权限(组织 Owner、管理员默认具备)。 - 请调用组织所在数据中心的地址,
${endpoint}取 查询组织列表 返回的region(SG→sg、TH→th、JP→jp)。调用了其它数据中心会返回「不是该组织成员」。
调用频率
- 每个开发者密钥调用本接口每分钟最多 60 次。
- 每次调用同时计入组织套餐「统计类 API」的每分钟额度,与 Agent API Key 调用统计类接口共用该额度。
- 数据每小时更新一次,同一小时内重复查询返回同一份结果,建议每小时调用一次。
请求
请求示例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm?org_id=${org_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm?org_id=${org_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
此代碼塊在浮窗中顯示
请求头
| 字段 | 类型 | 描述 |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | 使用 DevKey:DevSecret Base64 后的 Basic Token。 |
请求参数
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| org_id | String | 是 | 组织 ID。 |
| start_time | Long | 是 | 开始时间,毫秒时间戳。向下对齐到整点。 |
| end_time | Long | 是 | 结束时间(不含),毫秒时间戳。向上对齐到整点。对齐后的区间不能超过 31 天。 |
响应
响应示例
{
"code": 0,
"message": "OK",
"data": {
"org_id": "65f0c2a1b4e8d93a1c7e5b20",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"data_since": 1786125600000,
"peak_rpm": 186,
"peak_at": 1788512460000,
"avg_rpm": 12.40,
"total_requests": 2083411
}
}
{
"code": 0,
"message": "OK",
"data": {
"org_id": "65f0c2a1b4e8d93a1c7e5b20",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"data_since": 1786125600000,
"peak_rpm": 186,
"peak_at": 1788512460000,
"avg_rpm": 12.40,
"total_requests": 2083411
}
}
此代碼塊在浮窗中顯示
成功响应
| 字段 | 类型 | 描述 |
|---|---|---|
| org_id | String | 组织 ID。 |
| range_start | Long | 实际统计区间的起点:start_time 向下对齐到整点后的毫秒时间戳。 |
| range_end | Long | 实际统计区间的终点(不含):end_time 向上对齐到整点后的毫秒时间戳。 |
| data_until | Long | 数据已经统计到的时刻(毫秒时间戳)。区间里晚于该时刻的部分还没有数据。 |
| data_since | Long | 组织 RPM 最早从哪个整点开始有数据(毫秒时间戳,同一数据中心所有组织相同,约为功能上线前 31 天)。区间里早于该时刻的部分没有数据;还没有任何数据时为 null。 |
| peak_rpm | Long | 峰值 RPM:组织下所有 Agent 在同一分钟的请求数相加后,区间内最大的那一分钟的请求数。 |
| peak_at | Long | 峰值所在分钟的起点(毫秒时间戳)。多个分钟并列时取最早的一分钟;区间内没有请求时为 null。 |
| avg_rpm | Number | 平均 RPM:请求总数 ÷ 有请求的分钟数,保留 2 位小数。 |
| total_requests | Long | 区间内的请求总数。 |
失败响应
| 字段 | 类型 | 描述 |
|---|---|---|
| code | Integer | 错误码。 |
| message | String | 错误详情。 |
错误码
HTTP 状态码为错误码的前三位,例如 40000 对应 400、40100 对应 401、403132 对应 403。
| 错误码 | 描述 |
|---|---|
| 40000 | 参数错误,如缺少必填参数、参数取值不合法。 |
| 40001 | 调用过于频繁:该开发者密钥超过了本接口的每分钟上限。 |
| 40008 | 超过组织套餐「统计类 API」的每分钟额度。 |
| 40010 | 接口暂时关闭,请稍后再试。 |
| 40100 | 没有权限:缺少用量查看权限。 |
| 40105 | 不是该组织成员,或调用了其它数据中心的地址。 |
| 40324 | DevKey 或 DevSecret 错误。 |
| 403132 | 时间范围无效:开始时间不早于结束时间,或超过了最大查询范围。 |
统计口径
- 请求:用户发出的提问消息,加上对话报错(包括因超过调用频率被拒绝的请求),与控制台「Agent 洞察 → 分均发起请求」一致。它不是 HTTP 请求数,与套餐限流的计数可能不同。
- 统计范围:只统计开发空间 Agent 在开发空间渠道上的请求,包括 API、分享页、网页嵌入、气泡组件、LiveDesk 以及各即时通讯和电话渠道;不包括开发空间里的调试预览、Workflow(包括因超过调用频率被拒绝的 Workflow API 调用)、工作空间的 AI 搜索,以及已发布 Agent 在工作空间里的使用。
- 数据范围:从功能上线前 31 天开始有数据,更早的区间以
data_since为准。 - 更新频率:数据每小时整点统计一次,约有 1 小时延迟,以
data_until为准。 - 与控制台「组织 → 用量 → RPM」页的区别:控制台按一天 24 个小时段展示,本接口返回整个区间的单一峰值和发生时刻。
