取得 Agent 峰值 RPM
取得 Agent 峰值 RPM
按時間區間獲取某個 Agent 的峰值 RPM(每分鐘請求數),同時返回峰值發生的時刻、平均 RPM 和請求總數。
注意:最多查詢 31 天的數據;只統計開發空間的渠道,統計範圍見下方「統計口徑」。
請求方式
GET
調用地址
https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm
調用驗證
使用帳號級 DevKey / DevSecret 的 Basic 鑑權:Authorization: Basic ${BASIC_TOKEN},其中 ${BASIC_TOKEN} 為 DevKey:DevSecret 的 Base64 編碼。
- 調用帳號必須是
org_id對應組織的成員,並具備「用量查看」權限(組織 Owner、管理員預設具備),同時要能查看該 Agent:Agent 創建者、組織 Owner,或被授予了該 Agent(或全部 Agent)權限的成員。 - 請調用組織所在資料中心的地址,
${endpoint}取 查詢組織列表 返回的region(SG→sg、TH→th、JP→jp)。調用了其它資料中心會返回「不是該組織成員」。
調用頻率
- 每個開發者金鑰調用本接口每分鐘最多 60 次。
- 每次調用同時計入組織套餐「統計類 API」的每分鐘額度,與 Agent API Key 調用統計類接口共用該額度。
- 數據每小時更新一次,同一小時內重複查詢返回同一份結果,建議每小時調用一次。
請求
請求示例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm?org_id=${org_id}&agent_id=${agent_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm?org_id=${org_id}&agent_id=${agent_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。 |
| agent_id | String | 是 | Agent ID。不支援 Workflow。 |
| start_time | Long | 是 | 開始時間,毫秒時間戳。向下對齊到整點。 |
| end_time | Long | 是 | 結束時間(不含),毫秒時間戳。向上對齊到整點。對齊後的區間不能超過 31 天。 |
| conversation_type | String | 否 | 只看某個渠道,如 API、SHARE、EMBED、WIDGET、LIVEDESK。只能是開發空間的渠道;不傳則統計全部開發空間渠道。 |
回應
回應示例
{
"code": 0,
"message": "OK",
"data": {
"agent_id": "65f0c2a1b4e8d93a1c7e5b21",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"peak_rpm": 42,
"peak_at": 1788512460000,
"avg_rpm": 3.18,
"total_requests": 18234
}
}
{
"code": 0,
"message": "OK",
"data": {
"agent_id": "65f0c2a1b4e8d93a1c7e5b21",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"peak_rpm": 42,
"peak_at": 1788512460000,
"avg_rpm": 3.18,
"total_requests": 18234
}
}
此代碼塊在浮窗中顯示
成功響應
| 字段 | 類型 | 描述 |
|---|---|---|
| agent_id | String | Agent ID。 |
| range_start | Long | 實際統計區間的起點:start_time 向下對齊到整點後的毫秒時間戳。 |
| range_end | Long | 實際統計區間的終點(不含):end_time 向上對齊到整點後的毫秒時間戳。 |
| data_until | Long | 數據已經統計到的時刻(毫秒時間戳)。區間裡晚於該時刻的部分還沒有數據。 |
| peak_rpm | Long | 峰值 RPM:各渠道在同一分鐘的請求數相加後,區間內最大的那一分鐘的請求數。 |
| 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 | 沒有權限:缺少用量查看權限,或無權查看該 Agent(包括 Agent 不屬於該組織)。 |
| 40105 | 不是該組織成員,或調用了其它資料中心的地址。 |
| 40324 | DevKey 或 DevSecret 錯誤。 |
| 40378 | Agent 已刪除。 |
| 403132 | 時間範圍無效:開始時間不早於結束時間,或超過了最大查詢範圍。 |
統計口徑
- 請求:使用者發出的提問訊息,加上對話報錯(包括因超過呼叫頻率被拒絕的請求),與控制台「Agent 洞察 → 分均發起請求」一致。它不是 HTTP 請求數量,與套餐限流的計數可能不同。
- 統計範圍:只統計開發空間的渠道,包括 API、分享頁、網頁嵌入、氣泡組件、LiveDesk 以及各即時通訊和電話渠道;不包括開發空間裡的調試預覽、Workflow 運行,以及該 Agent 發布到工作空間後在工作空間裡的使用。
- 更新頻率:資料每小時整點統計一次,約有 1 小時延遲,以
data_until為準。2026-03-09 之前的資料沒有分鐘級明細,查詢結果為 0。
