組織の利用状況サマリーを取得

指定期間における組織のクレジット消費、新規会話数、ユーザーの質問数を集計し、Agent / Workflow 別にページ分けして表示します。組織内のすべての Agent のデータを一度の API 呼び出しで取得できます。

注:最大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会員であり、「使用履歴閲覧」権限を持つ必要があります(デフォルトでは組織のTଓନerや管理者が持っています)。
• 組織が所属するデータセンターのアドレスを使用してください。${endpoint} には 組織一覧の照会 で返される region を指定します（SG → sg、TH → th、JP → jp）。別のデータセンターにリクエストすると「組織のメンバーではありません」というエラーが返されます。

通話頻度

• 各開発者キーはこのインターフェースを1分間最大60回呼び出すことができます。
• 各通話は組織のパッケージの「Statistics API」分単位のクォータにもカウントされ、このクォータはエージェントAPIキーコールクラスインターフェースと共有されます。
• 今日または昨日のクエリ結果を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}'

                    

リクエストヘッダー

リクエストパラメータ

レスポンス

レスポンス例

                      
                      {
    "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
                }
            ]
        }
    }
}

                    

成功レスポンス

失敗レスポンス

エラーコード

HTTP ステータスコードはエラーコードの上3桁に対応。例えば 40000 は 400、40100 は 401、403132 は 403 に対応。

統計基準

• 統計範囲：開発スペースのみを統計対象とし、API、共有ページ、ウェブ埋め込み、バブルコンポーネント、LiveDesk、および各種インスタントメッセージや電話チャネル、さらに開発スペースの Workflow を含む。ワークスペース（GWork）の使用は含まれず、公開済みエージェントがワークスペースで使用された部分も含まれません。
• クレジット：すべての消費タイプ（クレジットの有効期限切れやサブスクリプション支払いを除く）。Workflow の消費は Workflow 自身に記録され、Agent が Workflow を呼び出して発生した消費はその Agent に含まれません。クレジットデータは機能開始日（data_since）からあり、過去のデータは遡って埋めません。
• セッション数：期間内に新規作成され、かつ会話があったセッション数。開発スペースでのデバッグプレビューは含まれません。Workflow の実行はセッションを生成せず、ワークスペースの AI 検索も含まれません。セッション数と質問数のデータは、機能開始前 31 日から存在します。
• 質問数：期間内にユーザーが送信した質問メッセージの数。AI の返信は含まれません。
• 並び順：agents.list はクレジットの高い順で並び替え、クレジットが同じ場合はセッション数で並び替えます。期間内にクレジット、セッション、質問が全くないエージェントは表示されません。
• 更新頻度：クレジットはリアルタイムで更新されます。セッション数と質問数は毎時の正時に集計され、約 1 時間の遅延があります。