組織のピーク RPM を取得
組織のピーク RPM を取得
時間範囲ごとに組織のピーク RPM（1分あたりのリクエスト数）を取得します：まず組織に属するすべてのエージェントの同じ1分間のリクエスト数を合計し、その範囲内で最も多い1分を取得します。同時に、ピークが発生した時刻、平均 RPM、リクエスト総数も返します。
注意：最大で31日分のデータを取得可能です；開発スペースのチャネルのみを統計対象とし、統計範囲は下記「統計範囲」を参照してください。
リクエスト方法
GET
呼び出し URL
https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm
認証
アカウントレベルの DevKey / DevSecret を使用した Basic 認証：Authorization: Basic ${BASIC_TOKEN}、ここで ${BASIC_TOKEN} は DevKey:DevSecret の Base64 エンコードです。
- 呼び出しアカウントは
org_idに対応する組織のメンバーであり、「使用量確認」権限を持っている必要があります（組織のオーナー、管理者はデフォルトで権限あり）。 - 組織が所属するデータセンターのアドレスを使用してください。
${endpoint}は 組織一覧の取得 で返されるregionを参照します（SG→sg、TH→th、JP→jp）。他のデータセンターを呼び出すと「組織のメンバーではありません」と返されます。
呼び出し頻度
- 各開発者キーでの呼び出しは、1分あたり最大60回です。
- 各呼び出しは、組織プランの「統計API」1分あたりのクォータにカウントされ、Agent API Key での統計API呼び出しと共用します。
- データは1時間ごとに更新され、同じ時間帯に繰り返し照会しても同じ結果が返ります。1時間に1回の呼び出しを推奨します。
リクエスト
リクエスト例
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 トークンを使用します。 |
リクエストパラメータ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 が同じ1分間に処理したリクエスト数を合計し、その区間内で最も多い1分間のリクエスト数。 |
| peak_at | Long | ピークが発生した分の開始点（ミリ秒タイムスタンプ）。複数の分が並列の場合は最も早い分を取る；区間内にリクエストがない場合は null。 |
| avg_rpm | Number | 平均 RPM：リクエスト総数 ÷ リクエストがある分数、小数点以下2桁まで。 |
| total_requests | Long | 区間内のリクエスト総数。 |
失敗レスポンス
| フィールド | 型 | 説明 |
|---|---|---|
| code | Integer | エラーコード。 |
| message | String | エラー詳細。 |
エラーコード
HTTP ステータスコードの上3桁がエラーコードに該当。例：40000 は 400、40100 は 401、403132 は 403 に対応。
| エラーコード | 説明 |
|---|---|
| 40000 | パラメータエラー：必須パラメータの不足やパラメータ値が不正の場合。 |
| 40001 | 呼び出しが多すぎます：この開発者キーは本インターフェースの1分あたり上限を超えています。 |
| 40008 | 組織プラン「統計系 API」の1分あたりの上限を超えています。 |
| 40010 | インターフェースは一時的に閉鎖されています。後でもう一度試してください。 |
| 40100 | 権限がありません：使用量確認の権限が不足しています。 |
| 40105 | 組織のメンバーでない、または別のデータセンターのアドレスを呼び出しました。 |
| 40324 | DevKey または DevSecret が間違っています。 |
| 403132 | 時間範囲が無効です：開始時間が終了時間より早くない、または最大検索範囲を超えています。 |
統計基準
- リクエスト：ユーザーが送信した質問メッセージ、及び会話エラー（呼び出し頻度超過による拒否を含む）で、コンソールの「Agent インサイト → 分ごとのリクエスト数」と一致します。HTTPリクエスト数ではなく、プランの制限カウントとは異なる場合があります。
- 統計範囲：開発スペースのAgentが開発スペースチャネル上で行ったリクエストのみをカウントします。API、共有ページ、ウェブ埋め込み、バブルコンポーネント、LiveDesk、各インスタントメッセージングと電話チャネルを含みます。開発スペース内のデバッグプレビュー、Workflow（呼び出し頻度超過によるWorkflow APIコールを含む）、ワークスペースのAI検索、公開済みAgentのワークスペース内での使用は含まれません。
- データ範囲：機能リリース前31日からデータが存在します。それ以前の期間は
data_sinceに従います。 - 更新頻度：データは毎時00分に集計され、約1時間の遅延があります。
data_untilに従います。 - コンソールの「組織 → 使用量 → RPM」ページとの違い：コンソールでは1日24時間で表示されますが、本インターフェースは期間全体の単一ピーク値と発生時刻を返します。