APIs are used to communicate with various systems to pull information in & out of bots. This report gives you an overview of the API performance.
It helps you determine the number of API calls made by each flow, each conversation, and each bot. It gives you the list of API calls that succeeded and failed, with which you can moderate the API commands. It is also important to know the traffic flow of the API calls made in a certain period to streamline the bot flows.
A quick guide to accessing this report
- Click on Analytics > Bot Analytics > System Performance report
- Use the dropdown on the right top corner in the reports pane to switch to the Editing mode from Viewing mode.
- Choose the required filters and get the data.
Attribute Name | Attribute Type | Definition |
Status | Filter, Group by, Underlying data | Status code received on the response of the API call |
Conversation ID | Filter, Group by, Underlying data | Unique ID corresponding to each bot conversation |
Time taken | Metric, Filter, Group, Underlying data | Amount of time taken to get a response after an API call is made |
Response date | Filter, Group by, Underlying data | Timestamp at which the response of the API call was received |
Customer | Filter, Group by, Underlying data | A unique identifier for the user that interacts with the bot |
API Name | Filter, Group by, Underlying data | Name of the API configured in the API library section of the bot |
Flow | Filter, Group by, Underlying data | Name of the flow on which the API was triggered |
API response | Metric | Count of API calls made through bot conversations |
API triggered at | Filter, Group by, Underlying data | Timestamp at which the API call was made |
Bot | Filter, Group by, Underlying data | Name of the bot on which an API was initiated |
Bot version | Filter, Group by, Underlying data | Version number of the bot on which an API was initiated |
You can also create your own System Performance report by applying widgets, filters, visualization, and much more. Learn how to build your own report,