API’s 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.
How to access this report?
- Click on Analytics > Bot Analytics > System Performance Report from curated reports
- Choose the required filters and get the data.
Some of the filters with which you can analyze the API calls are :
Attribute Name | Available as | Definition |
Conversations | Metric | Count of bot conversations |
Conversation ID | Filter, Group by, Underlying data | Unique ID corresponding to each bot conversation |
| Created date | Filter, Group by, Underlying data | Timestamp at which the bot conversation was initiated |
| Status | Filter, Group by, Underlying data | Current status of a bot conversation: New, Open, Closed |
| Bot | Filter, Group by, Underlying data | Name of the bot on which a conversation was initiated |
| Bot version | Filter, Group by, Underlying data | Version number of the bot on which a conversation was initiated |
| Flow | Filter, Group by, Underlying data | Name of the flow on which the last user interaction was done |
| Customer | Filter, Group by, Underlying data | A unique identifier for the user that interacts with the bot |
| Landing URL | Filter, Group by, Underlying data | The URL on which the bot conversation was initiated |
You can also create your own API's Overview & Performance report by applying widgets, filters, visualization, and much more. Learn how to build your own report →