If you need to consume our analysis API from the AgentBot and Help platform, you should pay attention to the following points:
1. Consult the API's documentation through the Postman tool:
- Consult the AgentBot API here.
- Consult the Help API here.
2. Request the token from your CSM (Customer Success Manager) or Aivo representative.
3. You have an AgentBot user with permissions to access the Analytics section. In addition, the following items should be noted:
- Authentication Token: This token is active for 10 hours. When possible, you should include a rule in your services for automatic renewal.
- Filtering times: Extract data in a range of 7 days to perform the analysis.
- API Analytics documentation: it is possible to filter by language type or by disposition.
- Recommendation: Use a corporate email for credentials, e.g. nome@aivo.co.
- XToken: You must use the xtoken of the active bot (all channels have the same XToken and can be used to consume the bot APIs).
- Threads: Our APIs support a maximum of 1 Thread.
- Availability: Information is not available in real time.
This API is recommended for queries and report generation.