To get information about every conversation served by AgentAssist.
| Method |
GET |
| Endpoint |
https://{{host}}/v1/public/{{streamId}}/v1/agentassistinteractions?from=YYYY-MM-DD&to=YYYY-MM-DD
|
| Content-Type |
application/json |
| Authorization |
auth: {{JWT}}
See How to generate the JWT Token. |
| API Scope |
AgentAssist Analytics |
Path Parameters
| PARAMETER |
REQUIRED/OPTIONAL |
DESCRIPTION |
| host |
Required |
Environment URL |
| botId |
Required |
Current bot |
Query Parameters
| PARAMETER |
REQUIRED/OPTIONAL |
DESCRIPTION |
| from |
Required |
Specifies the start date for the time range of agent assist interactions. |
| to |
Required |
Specifies the end date for the time range of agent assist interactions. |
| offset |
Optional |
number of segments to skip |
| limit |
Optional |
number of segments in a single response not more than 100 |
Sample Request
curl --location 'https://{{host}}/agentassist/api/v1/public/st-33fd64f0-5eca-58fd-97b1-96f9038f4bfa/v1/agentassistinteractions?from=2024-03-23&to=2024-03-24' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiYXBwSWQiOiJjcy1hOTIxM2RlZi1lZmNlLTU2ODUtYjI4MC0xYzVhZjE5NTdlZDcifQ.8BgpjTL-_FfsIQJ1KBDlDa9bpidgCoaVGc-_jEMxxxx' \
--header 'accountId: 65e95794340dc3c10ae7xxxx'
Sample Response
{
"conversationId": "c-8d8b78d-38de-4b90-b6b3-b2d58e64a467",
"botSessionId": "65d757a103f856130dc56f7d",
"channel": "CHAT",
"segmentId": "ac-c1ce030-e932-4cc7-aa00-2c4a792d8b6e",
"segmentStartTime": "2024-02-22T14:18:26.883Z",
"segmentEndTime": "2024-02-22T14:20:09.679Z",
"agent": {
"agentName": "HuddlSA",
"agentId": "u-b748ca6d-d329-5131-bd63-2fdcb2e5bd60"
},
"agentActions": [
{
"actionType": "SearchBarEntry",
"action": {
"searchPhrase": " Is there any cost associated with these new features?",
"displayTime": "2024-02-22T14:19:01.309Z",
"countDisplayedAnswers": {
"countDialogTasks": 0,
"countFaqs": 4,
"countWebPages": 5,
"countFiles": 0,
"countAnswers": 1,
"countFromNonNativeDataSource": 0
}
},
"used": [
{
"targetType": "FAQ",
"target": {
"title": "Is there any cost associated with these new features?",
"status": "send"
}
},
{
"targetType": "Article",
"target": {
"title": "Our children will be traveling with us – do they stay for free?",
"status": "send"
}
}
]
}
],
"proActiveSuggestions": [
{
"actionType": "LibrarySelection",
"action": {
"countDisplayedAnswers": {
"countDialogTasks": 1,
"countFaqs": 0,
"countWebPages": 0,
"countFiles": 0,
"countAnswers": 1,
"countFromNonNativeDataSource": 0
}
},
"used": [
{
"targetType": "DialogTask",
"target": {
"name": "mock api",
"runType": "RunAssist",
"status": "Completed",
"suggestionsCount": {
"tellCustomer": 0,
"askCustomer": 1,
"tellUsed": 1,
"askUsed": 1
}
}
},
{
"targetType": "Article",
"target": {
"title": "What if I’m going to arrive early?",
"status": "send"
}
},
{
"targetType": "Article",
"target": {
"title": "Cloud Security Controls for Asset Managers",
"status": "send"
}
}
]
},
{
"actionType": "LibrarySelection",
"action": {
"countDisplayedAnswers": {
"countDialogTasks": 0,
"countFaqs": 4,
"countWebPages": 5,
"countFiles": 0,
"countAnswers": 1,
"countFromNonNativeDataSource": 0
}
},
"used": []
}
]
}
],
"hasMore": false
}
