Conversation object

A conversation object is created any time a new chatter engages with Ada, or a returning chatter starts a new conversation in accordance with your persistence settings in Ada. A conversation is a higher-order object that contains messages, which you can access via the Messages endpoint.

Attributes

Responses

Below are some examples of the data returned in a conversation. A conversation can be created, and then later updated, with values changing based on the latest message within it.

📘

Only CSAT v2 data is supported in responses from the Conversations endpoint.

Get all conversations created within 1 week of created_since (v1.2)

GET /api/data_api/v1.2/conversations?created_since=2022-03-16T17:59:28.201000&page_size=100

{
    "data": [
        {
            "_id": "62322580b151ff975f1eb495",
            "agent_id": [
                "60cb3ef9b72ebfacb39408da",
                "619d95c0c063a5bf2b1efb7c",
            ],
            "agent_name": [
                "Hanif J",
                "Abby L"
            ],
            "browser": "chrome",
            "browser_version": "98.0.4758.102",
            "chatter_id": "6232257fb197d1ff65ea92fe",
            "csat": {},
            "date_created": "2022-03-16T17:59:28.201000+00:00",
            "date_updated": "2022-03-16T18:11:46.988000+00:00",
            "device": "macos",
            "is_engaged": true,
            "is_escalated": true,
            "is_test_user": false,
            "language": "en",
            "metavariables": {
                "browser": "chrome",
                "browser_version": "98.0.4758.102",
                "device": "macos",
                "followupresponseid": "6216a263c0c9f28ed7a16c1d",
                "introshown": "False",
                "ip_address": "184.146.191.63",
                "language": "en",
                "last_answer_id": "622bacf18d48fea09fe32fc8",
                "last_question_asked": "thanks!",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
            },
            "oauth_channel": "chat",
            "platform": "chat",
            "variables": {
                "chat_transcript": "BOT: picture message\r\nBOT: 👋 Welcome to Ada Interact! \r\nBOT: If you're curious about any of the reports that Mike mentions, click \"Read the reports\" or just type in 'get the reports'. \r\nBOT: picture message\r\nBOT: 👋 Welcome to Ada Interact! \r\nBOT: If you're curious about any of the reports that Mike mentions, click \"Read the reports\" or just type in 'get the reports'. \r\n\r\nUSER: my manager cant get into the event\r\n\r\n\r\nSUMMARY: my manager cant get into the event."
            }
        }
    ],
    "message": "OK",
    "next_page_uri": "/data_api/v1.2/conversations?created_since=2022-03-16T18%3A05%3A27.536000&created_to=2022-03-23T17%3A59%3A28.201000&page_size=100"
}

Get all conversations created within 1 week of created_since (v1.1)

GET /data_api/v1.1/conversations?created_since=2020-09-21T04%3A30%3A22.681000%2B00%3A00&page_size=100

{
  "data": [
    {
      "_id": "<mongodb_12_byte_object_id>",
      "chatter_id": "<mongodb_12_byte_object_id>",
      "csat": {
        "comment": null,
        "feedback": [
          "(helpful_resolution)"
        ],
        "is_positive": true,
        "resolved": true,
        "score": 5,
        "style": "EMOJI",
        "survey_type": "end_chat"
      },
      "date_created": "2020-09-21T04:30:22.681000+00:00",
      "date_updated": "2020-09-21T04:33:57.614000+00:00",
      "is_engaged": true,
      "is_escalated": false,
      "metavariables": {
        "browser": "chrome",
        "browser_version": "85.0.4183.102",
        "device": "macos",
        "introshown": "False",
        "language": "en",
        "last_answer_id": "<mongodb_12_byte_object_id>",
        "last_question_asked": "Ada",
        "test_user": "1",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
      },
      "platform": "chat",
      "variables": {
        "name": "Ada"
      }
    }
  ],
  "message": "OK",
  "next_page_uri": "/data_api/v1.1/conversations?created_since=2020-09-25T15%3A00%3A26.906000&created_to=2020-09-28T00%3A00%3A00&page_size=100"
}

Get all conversations created within 1 week of created_since (v1)

GET /data_api/v1/conversations?created_since=2020-09-21T04%3A30%3A22.681000%2B00%3A00&page_size=100

{
  "data": [
    {
      "_id": "<mongodb_12_byte_object_id>",
      "chatter_id": "<mongodb_12_byte_object_id>",
      "csat": {
        "comment": null,
        "feedback": [
          "(helpful_resolution)"
        ],
        "is_positive": true,
        "resolved": true,
        "score": 5,
        "style": "EMOJI",
        "survey_type": "end_chat"
      },
      "date_created": "2020-09-21T04:30:22.681000+00:00",
      "date_updated": "2020-09-21T04:33:57.614000+00:00",
      "is_engaged": true,
      "is_escalated": false,
      "metavariables": {
        "browser": "chrome",
        "browser_version": "85.0.4183.102",
        "device": "macos",
        "introshown": "False",
        "language": "en",
        "last_answer_id": "<mongodb_12_byte_object_id>",
        "last_question_asked": "Ada",
        "test_user": "1",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
      },
      "platform": "chat",
      "variables": {
        "name": "Ada"
      }
    }
  ],
  "message": "OK",
  "next_page_uri": "/data_api/v1/conversations?created_since=2020-09-25T15%3A00%3A26.906000&created_to=2020-09-28T00%3A00%3A00&page_size=100"
}