Agent の最近のアクティビティを取得

1人または複数のAgentについて、直近N分間の新しいセッション数やユーザーの質問数を取得できます。定期的な稼働確認に適しています。一度に最大50のAgentを照会可能です。

リクエスト方法

GET

呼び出しURL

https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity

認証方法

アカウントレベルのDevKey / DevSecretを使用したBasic認証：Authorization: Basic ${BASIC_TOKEN}。ここで${BASIC_TOKEN}はDevKey:DevSecretのBase64エンコードです。

呼び出しアカウントは、org_idに対応する組織のメンバーであり、「使用量確認」の権限を持っている必要があります（組織オーナーや管理者はデフォルトで権限あり）。さらに、該当Agentを閲覧できる必要があります：Agent作成者、組織オーナー、またはそのAgent（またはすべてのAgent）権限を付与されたメンバー。
組織が所属するデータセンターのアドレスを利用してください。${endpoint}には組織一覧を照会で返されるregionを指定します（SG → sg、TH → th、JP → jp）。他のデータセンターを呼び出すと「組織のメンバーではない」というエラーが返されます。

呼び出し頻度

各開発者キーで本APIを呼び出せるのは1分あたり最大60回です。
各呼び出しは組織プランの「統計系API」の1分あたりの制限にカウントされ、Agent API Keyによる統計系APIの呼び出しと共通の制限を使用します。
クエリ結果は30秒間キャッシュされます。1分に1回の呼び出しを推奨し、複数のAgentを1つのリクエストに統合してください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 後の Basic トークンを使用。

リクエストパラメータ

フィールド	タイプ	必須	説明
org_id	String	はい	組織 ID。
agent_id	String	はい	Agent ID、複数ある場合は英語のカンマで区切り、最大 50 個まで、重複は1回のみカウント。Workflow はサポートしていません。
minutes	Integer	いいえ	最近の何分間を集計するか、1 から 60 まで、デフォルトは 5。

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": { "minutes": 5, "window_start": 1790664900000, "window_end": 1790665200000, "agents": [ { "agent_id": "65f0c2a1b4e8d93a1c7e5b21", "new_conversation_count": 3, "new_message_count": 27 } ] } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "minutes": 5,
        "window_start": 1790664900000,
        "window_end": 1790665200000,
        "agents": [
            {
                "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                "new_conversation_count": 3,
                "new_message_count": 27
            }
        ]
    }
}

このコードブロックをポップアップで表示

成功レスポンス

フィールド	型	説明
minutes	Integer	集計ウィンドウの長さ（分）。
window_start	Long	ウィンドウ開始時点（ミリ秒タイムスタンプ）。
window_end	Long	ウィンドウ終了時点（ミリ秒タイムスタンプ、含まない）。
agents[].agent_id	String	エージェントID、リクエスト内の `agent_id` と同じ順序。
agents[].new_conversation_count	Long	ウィンドウ内で新規作成され、かつ既に会話があったセッション数。
agents[].new_message_count	Long	ウィンドウ内でユーザーが送った質問数（AIの返信は含まない）。

失敗レスポンス

フィールド	型	説明
code	Integer	エラーコード。
message	String	エラーの詳細。

エラーコード

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

エラーコード	説明
40000	パラメータエラー：必須パラメータが欠落している、またはパラメータの値が不正。
40001	呼び出し過多：この開発者キーは本APIの1分あたり上限を超過。
40008	組織のプラン「統計系API」の1分あたり上限を超過。
40010	一時的にインターフェースが閉鎖中です。後で再試行してください。
40100	権限なし：使用量の閲覧権限がない、またはこのエージェントを閲覧する権限がない（エージェントが組織に属していない場合を含む）。
40105	組織のメンバーではない、または別のデータセンターのURLを呼び出した。
40324	DevKey または DevSecret が間違っている。
40378	エージェントが削除されている。
403132	時間範囲が無効です：開始時間が終了時間より前ではないか、または最大検索範囲を超えています。

統計基準

両方の数字を確認する：インスタントメッセージチャンネルの会話は、60分間新しいメッセージがない場合、同じ会話を使い続けます。アクティブなチャンネルのエージェントも、長時間新しい会話がない場合があります。新しい会話数だけを見ると、非アクティブと誤判断されることがあります。
統計範囲：開発スペースのチャンネルのみを統計対象とします。API、共有ページ、ウェブ埋め込み、バブルコンポーネント、LiveDesk、各インスタントメッセージおよび電話チャンネルを含みます。開発スペース内のデバッグプレビューや、そのエージェントがワークスペースで使用した分は含まれません。
更新頻度：リアルタイムで計算します。