取得組織用量彙總

按時間區間獲取組織的點數消耗、新會話數和用戶提問數合計，並按 Agent / Workflow 分頁展開。一旦調用即可拿到組織下所有 Agent 的數據，不需要逐個 Agent 調用。

注意：最多查詢 31 天的數據；只統計開發空間，統計範圍見下方「統計口徑」。

請求方式

GET

調用地址

https://api-${endpoint}.gptbots.ai/v1/org/stat/summary

調用驗證

使用帳號級 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 調用統計類接口共用該額度。
包含今天或昨天的查詢結果緩存 5 分鐘，更早日期的結果緩存 1 小時，建議每 5 到 15 分鐘調用一次。

請求

請求示例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

此代碼塊在浮窗中顯示

請求頭

字段	類型	描述
Authorization	Basic ${BASIC_TOKEN}	使用 `DevKey:DevSecret` Base64 後的 Basic Token。

請求參數

字段	類型	必填	描述
org_id	String	是	組織 ID。
start_time	Long	是	開始時間，毫秒時間戳。按組織時區擴展到當天 0 點。
end_time	Long	是	結束時間（不含），毫秒時間戳。按組織時區取前一毫秒所在的自然日為最後一天。起止日期最多跨 31 天。
agent_type	String	否	只展開某一類：`AGENT` 或 `WORKFLOW`；不傳則兩類都列出。只影響 `agents` 列表，不影響 `total`。
page	Integer	否	頁碼，從 1 開始，默認 1，最大 10000。
page_size	Integer	否	每頁條數，默認 20，最大 100。

響應

響應示例

{ "code": 0, "message": "OK", "data": { "org_id": "65f0c2a1b4e8d93a1c7e5b20", "timezone": "+07:00", "range_start_date": "2026-10-16", "range_end_date": "2026-11-14", "data_since": "2026-10-15", "data_until": 1794614400000, "total": { "credits": 1234.5678, "unattributed_credits": 36.2011, "conversation_count": 5210, "message_count": 48213 }, "agents": { "page": 1, "page_size": 20, "total": 86, "list": [ { "agent_id": "65f0c2a1b4e8d93a1c7e5b21", "name": "客服助手", "agent_type": "AGENT", "credits": 402.1200, "conversation_count": 2104, "message_count": 19820 }, { "agent_id": "65f0c2a1b4e8d93a1c7e5b2a", "name": "订单查询", "agent_type": "WORKFLOW", "credits": 130.5000, "conversation_count": null, "message_count": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "timezone": "+07:00",
        "range_start_date": "2026-10-16",
        "range_end_date": "2026-11-14",
        "data_since": "2026-10-15",
        "data_until": 1794614400000,
        "total": {
            "credits": 1234.5678,
            "unattributed_credits": 36.2011,
            "conversation_count": 5210,
            "message_count": 48213
        },
        "agents": {
            "page": 1,
            "page_size": 20,
            "total": 86,
            "list": [
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                    "name": "客服助手",
                    "agent_type": "AGENT",
                    "credits": 402.1200,
                    "conversation_count": 2104,
                    "message_count": 19820
                },
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                    "name": "订单查询",
                    "agent_type": "WORKFLOW",
                    "credits": 130.5000,
                    "conversation_count": null,
                    "message_count": null
                }
            ]
        }
    }
}

此代碼塊在浮窗中顯示

成功響應

字段	類型	描述
org_id	String	組織 ID。
timezone	String	組織時區（UTC 偏移，如 `+07:00`），說明日期按哪個時區切分。
range_start_date	String	實際統計的起始日期 `yyyy-MM-dd`（組織時區，含）。
range_end_date	String	實際統計的結束日期 `yyyy-MM-dd`（組織時區，含）。
data_since	String	資料最早從哪一天開始完整（`yyyy-MM-dd`）：點數從功能上線日開始有，會話數和提問數從上線前 31 天開始有，取兩者中較晚的那天；早於它的日期資料不完整。還沒有任何資料時為 `null`。
data_until	Long	會話數和提問數已經統計到的時刻（毫秒時間戳）。點數是即時的。
total.credits	Number	組織點數消耗合計，包含 Workflow 與不歸屬任何 Agent 的消耗，保留 4 位小數。
total.unattributed_credits	Number	其中不歸屬任何 Agent 的部分（如知識庫存儲、語音識別），不會出現在 `agents` 列表裡。
total.conversation_count	Long	區間內新建的會話數合計。
total.message_count	Long	區間內用戶提問數合計，不含 AI 回覆。
agents.page	Integer	當前頁碼。
agents.page_size	Integer	每頁條數。
agents.total	Integer	區間內有數據的 Agent 與 Workflow 個數（按 `agent_type` 過濾後）。
agents.list[].agent_id	String	Agent 或 Workflow 的 ID。
agents.list[].name	String	名稱。
agents.list[].agent_type	String	`AGENT` 或 `WORKFLOW`。
agents.list[].credits	Number	點數消耗。
agents.list[].conversation_count	Long	區間內新建的會話數；Workflow 為 `null`。
agents.list[].message_count	Long	區間內的使用者提問數；Workflow 為 `null`。

失敗響應

欄位	類型	描述
code	Integer	錯誤碼。
message	String	錯誤詳情。

錯誤碼

HTTP 狀態碼為錯誤碼的前三位，例如 40000 對應 400、40100 對應 401、403132 對應 403。

錯誤碼	描述
40000	參數錯誤，如缺少必填參數、參數取值不合法。
40001	調用過於頻繁：該開發者密鑰超過了本接口的每分鐘上限。
40008	超過組織套餐「統計類 API」的每分鐘額度。
40010	接口暫時關閉，請稍後再試。
40100	沒有權限：缺少用量查看權限。
40105	不是該組織成員，或調用了其它資料中心的地址。
40324	DevKey 或 DevSecret 錯誤。
403132	時間範圍無效：開始時間不早於結束時間，或超過了最大查詢範圍。

統計口徑

統計範圍：只統計開發空間，包括 API、分享頁、網頁嵌入、氣泡組件、LiveDesk 以及各即時通訊和電話渠道，以及開發空間的 Workflow；不包括工作空間（GWork）的使用，也不包括已發布 Agent 在工作空間裡被使用的部分。
點數：所有消耗類型（不含點數過期與訂閱支付）。Workflow 的消耗記在 Workflow 自己名下，Agent 調用 Workflow 產生的消耗不計入該 Agent。點數資料從功能上線日（data_since）開始有，不回填歷史。
會話數：區間內新建、並且已經有過對話的會話數，不含開發空間調試預覽。Workflow 運行不產生會話；工作空間的 AI 搜索不計入。會話數和提問數從功能上線前 31 天開始有資料。
提問數：區間內用戶發出的提問訊息數，不含 AI 回覆。
排序：agents.list 按點數從高到低排序，點數相同時按會話數排序。區間內沒有任何點數、會話和提問的 Agent 不會列出。
更新頻率：點數即時更新；會話數和提問數每小時整點統計一次，約有 1 小時延遲。