Return messages matching the parameters

GET

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

Query parameters

created_sincedatetimeRequired

Return records that were created after this date

conversation_idstringOptional

Return records with a conversation_id that matches this id

page_sizeintegerOptional>=100<=10000

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

created_todatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Return records that were created earlier than this date. If not specified, this value defaults to 7 days after created_since.

Response

Ada successfully processed the request

itemslist of objectsOptional

Records returned from the query

metaobjectOptional

GET

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

200Retrieved

1 {
2   "items": [
3     {
4       "_id": "5d8a7d080afd19b55945c8ab",
5       "answer_id": "6392e0f865ba38041ddd5966",
6       "answer_title": "Greeting",
7       "chatter_id": "6009dd3c81dfae3a4e990acb",
8       "conversation_id": "5dba43ebedb828146bc871b6",
9       "date_created": "2019-10-31T14:28:02Z",
10       "link_was_clicked": false,
11       "message_data": {
12         "key": "value"
13       },
14       "recipient": "ada",
15       "record_last_updated": "2019-10-31T14:28:02Z",
16       "review": 0,
17       "sender": "b9e51eae-5449-4a46-b6ce-aef2dcb4e067",
18       "in_response_to": "6392e0f865ba38041ddd5966"
19     }
20   ],
21   "meta": {
22     "next_page_uri": "https://example.ada.support/api/v2/export/messages?created_since=2023-07-01T14%3A01%3A16.257000%2B00%3A00&created_to=2023-07-22T00%3A00%3A00%2B00%3A00"
23   }
24 }

Overview

Up Next

Built with

1	import requests
2
3	url = "https://{bot-name}.ada.support/api/v2/export/messages"
4
5	querystring = {"created_since":"2024-01-15T09:30:00Z","page_size":"10000"}
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	"answer_id": "6392e0f865ba38041ddd5966",
6	"answer_title": "Greeting",
7	"chatter_id": "6009dd3c81dfae3a4e990acb",
8	"conversation_id": "5dba43ebedb828146bc871b6",
9	"date_created": "2019-10-31T14:28:02Z",
10	"link_was_clicked": false,
11	"message_data": {
12	"key": "value"
13	},
14	"recipient": "ada",
15	"record_last_updated": "2019-10-31T14:28:02Z",
16	"review": 0,
17	"sender": "b9e51eae-5449-4a46-b6ce-aef2dcb4e067",
18	"in_response_to": "6392e0f865ba38041ddd5966"
19	}
20	],
21	"meta": {
22	"next_page_uri": "https://example.ada.support/api/v2/export/messages?created_since=2023-07-01T14%3A01%3A16.257000%2B00%3A00&created_to=2023-07-22T00%3A00%3A00%2B00%3A00"
23	}
24	}