Return conversations matching the parameters — Ada

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

Query parameters

created_sincedatetimeOptional

Return records that were created after this date. Note that updated_since and created_since are mutually exclusive, so you must only use one in a request.

updated_sincedatetimeOptional

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.

page_sizeintegerOptional>=100<=10000Defaults to 10000

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

created_todatetimeOptional

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.

updated_todatetimeOptional

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.

Response

Ada successfully processed the request

itemslist of objectsOptional

Records returned from the query

metaobjectOptional

1 import requests 2 3 url = "https://{bot-name}.ada.support/api/v2/export/conversations" 4 5 querystring = {"created_since":"2024-01-15T09:30:00Z","updated_since":"2024-01-15T09:30:00Z","page_size":"10000","created_to":"2024-01-15T09:30:00Z","updated_to":"2024-01-15T09:30:00Z"} 6 7 headers = {"Authorization": "Bearer <apiKey>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "items": [ 3 { 4 "_id": "5d8a7d080afd19b55945c8ab", 5 "agent_id": [ 6 "619d95c0c063a5bf2b1efb7c" 7 ], 8 "agent_handle_time": 4, 9 "agent_name": [ 10 "Ada Lovelace" 11 ], 12 "automated_resolution_classification": "Resolved", 13 "automated_resolution_classification_reason": "The bot provided a detailed step-by-step guide on how to disable auto deposits, both on the mobile app and the web version.", 14 "bot_handle_time": 4, 15 "browser": "chrome", 16 "browser_version": "95.0.4638.69", 17 "chatter_id": "5dbaef7283d791f585563d84", 18 "csat": { 19 "key": "value" 20 }, 21 "date_created": "2019-10-31T14:28:02Z", 22 "date_updated": "2019-10-31T14:28:02Z", 23 "device": "macos", 24 "end_user_id": "619d95c0c063a5bf2b1efb64e", 25 "generated_topic_id": "654952d3e90767ff49713fbf", 26 "generated_topic_label": "Billing Inquiries", 27 "generated_topic_v2_id": "654952d3e90767ff49713fb1", 28 "generated_topic_v2_title": "Password Reset Inquiries", 29 "generated_topic_v2_desc": "All conversations regarding resetting passwords", 30 "generated_topic_v2_parent_id": "654952d3e90767ff49713fb2", 31 "inquiry_summary": "The customer wanted to know how to temporarily disable auto deposits.", 32 "is_engaged": true, 33 "is_escalated": false, 34 "is_test_user": false, 35 "language": "en", 36 "metavariables": { 37 "key": "value" 38 }, 39 "oauth_channel": "sms", 40 "platform": "chat", 41 "record_last_updated": "2019-10-31T14:28:02Z", 42 "variables": { 43 "key": "value" 44 } 45 } 46 ], 47 "meta": { 48 "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" 49 } 50 }

1	import requests
2
3	url = "https://{bot-name}.ada.support/api/v2/export/conversations"
4
5	querystring = {"created_since":"2024-01-15T09:30:00Z","updated_since":"2024-01-15T09:30:00Z","page_size":"10000","created_to":"2024-01-15T09:30:00Z","updated_to":"2024-01-15T09:30:00Z"}
6
7	headers = {"Authorization": "Bearer <apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"items": [
3	{
4	"_id": "5d8a7d080afd19b55945c8ab",
5	"agent_id": [
6	"619d95c0c063a5bf2b1efb7c"
7	],
8	"agent_handle_time": 4,
9	"agent_name": [
10	"Ada Lovelace"
11	],
12	"automated_resolution_classification": "Resolved",
13	"automated_resolution_classification_reason": "The bot provided a detailed step-by-step guide on how to disable auto deposits, both on the mobile app and the web version.",
14	"bot_handle_time": 4,
15	"browser": "chrome",
16	"browser_version": "95.0.4638.69",
17	"chatter_id": "5dbaef7283d791f585563d84",
18	"csat": {
19	"key": "value"
20	},
21	"date_created": "2019-10-31T14:28:02Z",
22	"date_updated": "2019-10-31T14:28:02Z",
23	"device": "macos",
24	"end_user_id": "619d95c0c063a5bf2b1efb64e",
25	"generated_topic_id": "654952d3e90767ff49713fbf",
26	"generated_topic_label": "Billing Inquiries",
27	"generated_topic_v2_id": "654952d3e90767ff49713fb1",
28	"generated_topic_v2_title": "Password Reset Inquiries",
29	"generated_topic_v2_desc": "All conversations regarding resetting passwords",
30	"generated_topic_v2_parent_id": "654952d3e90767ff49713fb2",
31	"inquiry_summary": "The customer wanted to know how to temporarily disable auto deposits.",
32	"is_engaged": true,
33	"is_escalated": false,
34	"is_test_user": false,
35	"language": "en",
36	"metavariables": {
37	"key": "value"
38	},
39	"oauth_channel": "sms",
40	"platform": "chat",
41	"record_last_updated": "2019-10-31T14:28:02Z",
42	"variables": {
43	"key": "value"
44	}
45	}
46	],
47	"meta": {
48	"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"
49	}
50	}