Agent のピーク RPM を取得
Agent のピーク RPM を取得
一定期間にわたるエージェントのピーク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会員であり、組織の所有者や管理者にデフォルトで「使用表示」権限を持ち、エージェントを閲覧できる必要があります。エージェントの作成者、組織の所有者、またはエージェント(またはすべてのエージェント)に権限を与えられたメンバーが。 - 組織が所属するデータセンターのアドレスを使用してください。
${endpoint}には 組織一覧の照会 で返されるregionを指定します（SG→sg、TH→th、JP→jp）。別のデータセンターにリクエストすると「組織のメンバーではありません」というエラーが返されます。
通話頻度
- 各開発者キーはこのインターフェースを1分間最大60回呼び出すことができます。
- 各通話は組織のパッケージの「Statistics API」分単位のクォータにもカウントされ、このクォータはエージェントAPIキーコールクラスインターフェースと共有されます。
- データは毎時間更新されます。同じ時間内に繰り返し問い合わせても同じ結果が返ってきます。1時間に1回の呼び出しが推奨されます。
リクエスト
リクエストの例
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 トークンを使用します。 |
リクエストパラメータ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 | エージェントID。 |
| range_start | Long | 実際の統計期間の開始点：start_time が下に整列された時点のミリ秒タイムスタンプ。 |
| range_end | Long | 実際の統計期間の終了点（含まれない）：end_time が上に整列された時点のミリ秒タイムスタンプ。 |
| data_until | Long | データが統計された時刻（ミリ秒タイムスタンプ）。期間中でこの時刻より後の部分にはまだデータがありません。 |
| peak_rpm | Long | ピーク RPM：各チャネルの同じ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 が間違っています。 |
| 40378 | エージェントは削除されました。 |
| 403132 | 時間範囲が無効です：開始時間が終了時間より前ではない、または最大検索範囲を超えています。 |
統計範囲
- リクエスト：ユーザーが送信した質問メッセージ、および対話エラー（呼び出し頻度超過による拒否リクエストを含む）で、コンソールの「Agent インサイト → 平均分解によるリクエスト数」と一致します。これは HTTP リクエスト数ではなく、プランの制限カウントとは異なる場合があります。
- 統計対象：開発スペース内のチャネルのみを統計対象とし、API、共有ページ、ウェブ埋め込み、バブルコンポーネント、LiveDesk、および各種インスタントメッセージ・電話チャネルを含みます。開発スペース内のデバッグプレビュー、Workflow 実行、またはエージェントをワークスペースに公開した後のワークスペース内での使用は含まれません。
- 更新頻度：データは毎時整点で統計され、約 1 時間の遅延があります。
data_untilを基準とします。2026-03-09 以前のデータには分単位の詳細はなく、検索結果は 0 となります。