The Analytics API allows you to access and collect data from the Bold360 ai Analytics Section.
How do I use the Analytics API?
To use the Analytics API, you must first create an API key in your Bold360 ai account. For information on how to create a new API key, click here.
To retrieve analytics data with the API, use the get method:
- For a JSONP response, use:
- To retrieve a CSV file, use:
provide the JSONP callback method
An API key with analytics read privileges for the required knowledge-bases
One or more knowledge-base names to obtain data for (comma separated)
Value analysis type, values are:
hourly, daily, weekly, monthly
Date range in days to obtain data for
Date range in months to obtain data for
Timezone in hours to obtain correct for when analyzing and outputting dates
list of values to include in output (comma separated)
List of possible values is provided below
|labelid (Optional)||Use in cases to get data on specific label.||labelId=1CE001C|
* You must provide either a day or month value when selecting a date range.
Values to retrieve
You can retrieve the following information defined in the values parameter:
Total answers provided, including self-service, rechanneling, and tickets.
Total interactions via Bold360 ai interfaces (widgets, Support Center, API, and so on).
Interactions where search has returned an answer.
Interactions where search did not return an answer.
Engagements resolved by Bold360 ai (visitor received an answer, and did not escalate or provide negative feedback).
Engagements not resolved by Bold360 ai (either no search result has been found or the visitor's question was escalated to an agent or provided the visitor negative feedback).
Engagements resolved using the Search interface.
Engagements resolved using the Search interface by selecting an auto-completion suggestion (subset of 'resolvedBySearch').
Engagements resolved using an FAQ interface (in Dynamic FAQ widget, or FAQs in embedded or floating widgets).
Engagements resolved using a Support Center article.
Number of positive feedback from all touchpoints.