Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
AgentX Support
AIエージェント
分析

AgentX Support - エクスポートAPI ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

内部分析、GDPRコンプライアンス、または保管のために、会話とメッセージをエクスポートできます。

Export APIには、次の2つのエンドポイントが含まれています。

  • 会話の取得: 会話のメタデータと属性を返します。
  • メッセージの取得: 顧客、エージェント、AIエージェント間でやり取りされた個々のメッセージを返します。

機能の提供状況

この機能は、特定の料金プランのユーザーのみが利用できます。 詳細については、ご利用の料金プランおよび契約を参照してください。

ベースURL ​

AgentX SupportにAPIリクエストを行うときは、次のベースURLを使用します。

plaintext
https://api.converseapps.com

利用状況の制限 ​

AgentX SupportのExport APIには、次の制限が適用されます。

  • レート制限: エンドポイントごとに1秒あたり3リクエスト。
  • ページサイズ: 各リクエストは最大1000レコードを返し、カーソルベースのページネーションを使用します。

APIキー ​

AgentX SupportのExport APIのエンドポイントにアクセスするには、APIキーが必要です。 APIキーはAccount（アカウント）> APIで確認でき、サイト管理者にのみ表示されます。

APIキーを取得APIキーを取得

会話の取得 ​

AIエージェントによって処理された顧客との会話に関するデータを返します。

plaintext
GET /conversations/export/v1/conversations

クエリパラメーター ​

パラメータータイプ説明
start_timeinteger
required		エクスポート期間の開始（Unixタイムスタンプ、秒単位）。
end_timeinteger
required		エクスポート期間の終了（Unixタイムスタンプ、秒単位）。
bot_namestring
必須		AIエージェントのボット名またはID。
per_pageinteger
optional		返すレコード数。 最大値は1000です。
cursorstring
任意		次の結果バッチを取得するためのページネーションに使用されます。

サンプルリクエスト ​

bash
curl -X GET 'https://api.converseapps.com/conversations/export/v1/conversations?start_time=1696118400&end_time=1696550400&bot_name=r3-218210&per_page=1000' \
  -H 'x-api-key: <api_key>'

結果の次のページを読み込むには、レスポンスで返されたcursor値がnullになるまで渡します。

レスポンス ​

json
{
    "data": [
        {
            "_id": "5c80416892d94e40a64cea7dc6406e25",
            "startTime": 1744750665,
            "locale": "en_us",
            "metadata": {
                "locale": "en_us",
                "browser_visitorType": "repeat",
                "browser_screenResolution": "1728x1117",
                "browser_localTime": 1744750695136,
                "draft": true,
                "question": "my camera is offline",
                "transcript": "User:\tmy camera is offline",
                "guideNodeCount": 5
            },
            "tags": [
                "guideInteraction"
            ],
            "userMessageCount": 6,
            "lastActionAt": "2025-04-15T20:58:15.384884"
        },
    ],
    "cursor": null
}
フィールド説明
_id会話の一意のID。
startTime会話の開始時刻。
lastActionAt会話内の最終更新のタイムスタンプ。
locale会話のロケール。
tags会話に適用されたタグ。 例: resolved、informed。
metadata会話中に追加されたシステムメタデータとカスタムメタデータの両方を含みます。

メッセージの取得 ​

メッセージタイプ、送信者、タイムスタンプ、コンテンツなど、会話内のメッセージレベルのデータを返します。

plaintext
GET /conversations/export/v1/messages

クエリパラメーター ​

パラメータータイプ説明
start_timeinteger
required		エクスポート期間の開始（Unixタイムスタンプ、秒単位）。
end_timeinteger
required		エクスポート期間の終了（Unixタイムスタンプ、秒単位）。
bot_namestring
必須		AIエージェントのボット名またはID。
per_pageinteger
optional		返すレコード数。 最大値は1000です。
cursorstring
任意		次の結果バッチを取得するためのページネーションに使用されます。
conversation_idstring
任意		特定の会話のメッセージをフィルター処理します。

サンプルリクエスト ​

bash
curl -X GET 'https://api.converseapps.com/conversations/export/v1/messages?start_time=1696118400&end_time=1696550400&bot_name=r3-218210&per_page=1000' \
  -H 'x-api-key: <api_key>'

結果の次のページを読み込むには、レスポンスで返されたcursor値がnullになるまで渡します。

レスポンス ​

json
{
  "data": [
    {
      "_id": "aee4189e0429449a9c8c3bba88bf140c",
      "time": 1744651778.652,
      "type": "Question",
      "outMsg": {
        "steps": [
          {
            "text": "Hello 👋 I am a virtual assistant. How can I help you?"
          }
        ]
      },
      "conversationId": "7eee0bbc78414f649a311c7ce4a87ead"
    },
    {
      "_id": "33f34335-bd8a-41a7-8ce1-73542fcc2b9c",
      "time": 1744651783,
      "type": "UserInput",
      "userInput": "Tell me about Comfort Headphones",
      "conversationId": "7eee0bbc78414f649a311c7ce4a87ead"
    },
    {
      "_id": "4514b1a468394c9f986ac8ffdad577ad",
      "time": 1744651793.839,
      "type": "Question",
      "outMsg": {
        "steps": [
          {
            "text": "Here are the details for Comfort Headphones:\n\n💲 Price: $89.99\n📦 In Stock: Yes"
          },
          {
            "text": "Did that answer your question?"
          }
        ],
        "options": [
          { "txt": "Yes" },
          { "txt": "No" }
        ]
      },
      "conversationId": "7eee0bbc78414f649a311c7ce4a87ead"
    }
  ],
  "cursor": null
}
フィールド説明
_idメッセージの一意のID。
timeメッセージが送信されたときのタイムスタンプ。
conversationIdこのメッセージが属する会話のID。
typeメッセージのタイプ。 例: UserInput、BotMessage。
outMsgAIエージェントからのメッセージのコンテンツ。
userActionTypeユーザーアクションのタイプ。 これはUserInputメッセージにのみ存在します。
userInputユーザー入力のコンテンツ。 例: メッセージテキスト、クイック返信、フォーム送信。

Last updated: