The release of Logs API will enable users to get event level data out of the platform in raw form in near real time.
With Logs API, customers will be able to fetch, filter, and sort a log of the events conducted on their Yext experience(s) which can be used to extract data from Yext for offline analysis or to embed analytics in the places you need them most.
For example, if a user were to begin their journey on a Yext experience and ultimately creates a support ticket, you can embed that user’s activity (Searches, Clicks and Viewed Content) into your ticketing platform to better understand the actions that led up to a customer submitting a ticket.
This release includes only the analyticsEvents table with the following Analytics event logs:
- Answers Searches
- Answers Clicks (of any type)
- Page Events
Logs API currently returns Analytics events for Answers and Pages, but will expand to support other Analytics events and other sources of log data in the future.
To enable access to the Logs API, create a new app in the Developer Console with the endpoint Knowledge API > Logs and Read-Only permission.
Once access is enabled, users can make the following requests with the Logs API:
- GET All Tables endpoint: See what tables are available in the Logs API
- GET Table endpoint: See what fields are available for a specific table
- POST endpoint: Pull logs from a specific table with specified fields, pageSize, sorting, and filtering
To learn more about how to use the Logs API endpoints, check out the Logs API documentation.