Return conversations matching the parameters

import requests
url = "https://example.ada.support/api/v2/export/conversations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "items": [
    {
      "_id": "5d8a7d080afd19b55945c8ab",
      "agent_id": [
        "619d95c0c063a5bf2b1efb7c"
      ],
      "agent_handle_time": 4,
      "agent_name": [
        "Ada Lovelace"
      ],
      "automated_resolution_classification": "Resolved",
      "automated_resolution_classification_reason": "The bot provided a detailed step-by-step guide on how to disable auto deposits",
      "bot_handle_time": 4,
      "browser": "chrome",
      "browser_version": "95.0.4638.69",
      "chatter_id": "5dbaef7283d791f585563d84",
      "csat": {
        "is_positive": false,
        "score": 3,
        "style": "EMOJI",
        "survey_type": "end_chat",
        "customer_effort_score": 4,
        "ces_max": 5,
        "net_promoter_score": 8
      },
      "date_created": "2019-10-31T14:28:02",
      "date_updated": "2019-10-31T14:29:02",
      "device": "macos",
      "end_user_id": "619d95c0c063a5bf2b1efb64e",
      "generated_topic_id": "654952d3e90767ff49713fbf",
      "generated_topic_label": "Billing Inquiries",
      "generated_topic_v2_id": "654952d3e90767ff49713fb1",
      "generated_topic_v2_title": "Password Reset Inquiries",
      "generated_topic_v2_desc": "All conversations regarding resetting passwords",
      "generated_topic_v2_parent_id": "654952d3e90767ff49713fb2",
      "inquiry_summary": "The customer wanted to know how to temporarily disable auto deposits",
      "is_engaged": true,
      "is_escalated": false,
      "is_test_user": false,
      "language": "en",
      "metavariables": {
        "browser": "chrome",
        "language": "en"
      },
      "oauth_channel": "sms",
      "platform": "chat",
      "record_last_updated": {},
      "variables": {
        "account_number": "1234"
      }
    }
  ],
  "meta": {
    "next_page_uri": "https://example.ada.support/api/v2/export/conversations?created_since=2023-07-08T06%3A01%3A39%2B00%3A00&created_to=2023-07-22T00%3A00%3A00%2B00%3A00"
  }
}

Returns a list of conversation objects along with a next_page_uri if applicable

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_sincestringOptionalformat: "date-time"

Return records that were created after this date. If created_to is not specified, only records within 7 days of this timestamp are returned. To retrieve data beyond that window, set created_to explicitly. Note that updated_since and created_since are mutually exclusive, so you must only use one in a request. Must be an ISO 8601 UTC timestamp ending with ‘Z’ (e.g., 2024-07-01T00:00:00Z); required for valid API requests.

Return records that were created after this date. If `created_to` is not specified, only records within 7 days of this timestamp are returned. To retrieve data beyond that window, set `created_to` explicitly. Note that `updated_since` and `created_since` are mutually exclusive, so you must only use one in a request. Must be an ISO 8601 UTC timestamp ending with 'Z' (e.g., `2024-07-01T00:00:00Z`); required for valid API requests.

updated_sincestringOptionalformat: "date-time"

Return records that were updated after this date. Note that updated_since and created_since are mutually exclusive, so you must only use one in a request. Must be an ISO 8601 UTC timestamp ending with ‘Z’ (e.g., 2024-07-01T00:00:00Z); required for valid API requests.

page_sizeintegerOptional100-10000Defaults to 10000

Number of records to return in response. The maximum and default is 10000, the minimum is 100.

created_tostring or nullOptionalformat: "date-time"

Return records that were created earlier than this date. If created_since is used and this parameter is not specified, this value defaults to 7 days after created_since. Must be an ISO 8601 UTC timestamp ending with ‘Z’ (e.g., 2024-07-01T00:00:00Z); required for valid API requests.

updated_tostring or nullOptionalformat: "date-time"

Return records that were updated earlier than this date. If updated_since is used and this parameter is not specified, this value defaults to 7 days after updated_since. Must be an ISO 8601 UTC timestamp ending with ‘Z’ (e.g., 2024-07-01T00:00:00Z); required for valid API requests.

Response

Ada successfully processed the request

itemslist of objects

Records returned from the query

metaobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error