Comment on page
Interaction API
The Interaction API makes it possible to retrieve information about interactions between the user and OpenDialog scenarios. The data is requested for over a time period (
from , to) and is split by user_id. Example structure can be seen below. 1
{
2
"data": [
3
{
4
"<user_id>": {
5
"chatbot_user_data": {
6
"first_name": "",
7
"last_name": "",
8
"custom": {
9
"selected_scenario": "<scenario_id>"
10
}
11
},
12
"from": "2022-09-21T00:00:00.000000Z",
13
"to": "2022-09-22T23:59:59.000000Z",
14
"interactions": [
15
{
16
"type": "<>",
17
"date": "2022-09-21T08:19:33.000000Z",
18
"text": "",
19
"data": {
20
"value": "<>",
21
"callback_id": "<>"
22
}
23
},
24
{
25
"type": "<>",
26
"date": "2022-09-21T08:19:33.000000Z",
27
"text": "",
28
"data": {
29
"value": "<>",
30
"callback_id": "<>"
31
}
32
}
33
]
34
}
35
}
36
]
37
}
A Postman description of the API is available here https://documenter.getpostman.com/view/18689765/UyxhmSVW#d11214de-8749-48af-9521-172591cf54b3
To access the API you will need a bearer token associated with a user account in the OpenDialog Tenant you want to extract data from.
To access your bearer token visit the Identity & Security page - accessible by clicking on your username in the bottom left-hand corner.
API Bearer Token Access
Last modified 7mo ago