Whilst customers or users interact with your conversational AI application, valuable data and insights are generated and stored.
These insights can be viewed in the Portal UI. You might need programmatic access to this data and this is where the Analytics API can help. Note that each customer will have their own API URL, so make sure you are in the right place. Your API URL will follow the format https://zammo-[your domain].azurewebsites.net/doc/api
At the time of writing, the following API endpoints are available:
You can browse detailed descriptions of each of the API endpoint definitions by clicking on the down arrow:
In this How To you'll learn how to access the Analytics API. You'll learn how to browse the API documentation and construct requests that can fetch your conversational AI data. We'll use the following API endpoint:
If you do not already have an API Key and App Id, or if you have lost your keys, you will need to create one. Follow the instructions in this article: Obtaining a Zammo Analytics API key
The Public API homepage is located in the Zammo portal. Note that each customer will have their own API URL, so make sure you are in the right place. Your API URL will follow the format https://zammo-[your domain].azurewebsites.net/doc/api The API homepage contains all existing API methods that are available: