logo
開發者文件
搜尋
取得組織峰值 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 個小時段展示,本接口返回整個區間的單一峰值和發生時刻。