Conversational Bot
Track Conversational Bot engagement and effectiveness.
Overview
GET https://{{account_id}}.acquire.io/api/v1/analytics/bot/conversational-bot-overview
View how many contacts and conversations your Conversational Bot handles.
Query Parameters
start_date
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
string
json or csv
Headers
Authorization
string
Bearer ***YOUR_API_KEY***
{
"data": {
"conversationalBotOverview": {
"data": {
"graphRow": {
"labels": [
"16 Mar 2020",
"16 Apr 2020",
"16 May 2020",
"16 Jun 2020",
"16 Jul 2020",
"16 Aug 2020",
"16 Sep 2020",
"16 Oct 2020",
"16 Nov 2020",
"16 Dec 2020",
"16 Jan 2021",
"16 Feb 2021",
"16 Mar 2021"
],
"customersEngaged": [
0,
0,
0,
0,
0,
0,
0,
1,
0,
1,
0,
0,
0
],
"interactionsWithBot": [
0,
0,
0,
0,
0,
0,
0,
1,
0,
1,
0,
0,
0
],
"resolvedIssues": [
0,
0,
0,
0,
0,
0,
0,
2,
0,
2,
0,
0,
0
],
"unansweredQuestions": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
1,
0,
0,
0
]
},
"summary": {
"customersEngaged": {
"current": 2,
"previous": 0
},
"interactionsWithBot": {
"current": 2,
"previous": 0
},
"resolvedIssues": {
"current": 4,
"previous": 0
},
"unansweredQuestions": {
"current": 1,
"previous": 0
}
}
},
"success": true,
"output": "json"
}
}
}Questions Report
GET https://{{account_id}}.acquire.io/api/v1/analytics/bot/questions-report
View how many questions were added, used, and suggested to the Conversational Bot.
Query Parameters
start_date
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
string
json or csv
Headers
Authorization
string
Bearer ***YOUR_API_KEY***
{
"data": {
"questionsReport": {
"data": {
"graphRow": {
"labels": [
"16 Mar 2020",
"16 Apr 2020",
"16 May 2020",
"16 Jun 2020",
"16 Jul 2020",
"16 Aug 2020",
"16 Sep 2020",
"16 Oct 2020",
"16 Nov 2020",
"16 Dec 2020",
"16 Jan 2021",
"16 Feb 2021",
"16 Mar 2021"
],
"totalQuestionsAdded": [
0,
0,
0,
0,
0,
0,
3,
0,
0,
3,
0,
0,
0
],
"totalQuestionsInUse": [
0,
0,
0,
0,
0,
0,
3,
0,
0,
2,
0,
0,
0
],
"totalSuggestedQuestions": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
1,
0,
0,
0
],
"totalQuestionGroups": [
0,
0,
0,
0,
0,
0,
1,
0,
0,
1,
0,
0,
0
]
},
"summary": {
"totalQuestionsAdded": {
"current": 6,
"previous": 0
},
"totalQuestionsInUse": {
"current": 5,
"previous": 0
},
"totalSuggestedQuestions": {
"current": 1,
"previous": 0
},
"totalQuestionGroups": {
"current": 2,
"previous": 0
}
}
},
"success": true,
"output": "json"
}
}
}All Question Groups
GET https://{{account_id}}.acquire.io/api/v1/analytics/bot/questions-report
See which question groups are most active.
Query Parameters
start_date
string
Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date
string
Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset
string
This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output
string
json or csv
Headers
Authorization
string
Bearer ***YOUR_API_KEY***
{
"data": {
"questionsReport": {
"data": {
"graphRow": {
"labels": [
"12 PM",
"01 PM",
"02 PM",
"03 PM",
"04 PM",
"05 PM",
"06 PM",
"07 PM",
"08 PM",
"09 PM",
"10 PM",
"11 PM",
"12 AM",
"01 AM",
"02 AM",
"03 AM",
"04 AM",
"05 AM",
"06 AM",
"07 AM",
"08 AM",
"09 AM",
"10 AM",
"11 AM"
],
"totalQuestionsAdded": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"totalQuestionsInUse": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"totalSuggestedQuestions": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"totalQuestionGroups": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
"summary": {
"totalQuestionsAdded": {
"current": 0,
"previous": 0
},
"totalQuestionsInUse": {
"current": 0,
"previous": 0
},
"totalSuggestedQuestions": {
"current": 0,
"previous": 0
},
"totalQuestionGroups": {
"current": 0,
"previous": 0
}
}
},
"success": true,
"output": "json"
}
}
}Last updated