Overview - Policies and Conventions
Overview
The Events API is used for sending user events from your Yext digital experiences to Yext Analytics in near real-time.
Specifically, you can track standard actions such as:
- CTA Clicks
- Page Views
- Chat Impressions
- Thumbs Up
You can also track custom actions by appending a ‘C_’ to the beginning of the action name.
For more information on how to configure analytics events in the @yext/analytics SDK, including defining standard and custom actions, custom tags and properties, and more, view our SDK documentation here.
Note: As of the Summer ‘23 Release, the Events endpoint only supports analytics tied to a Chat experience. An account must have a Chat subscription in order to gain access to the Events API. Support for Pages and Search will be added to Events in the near future.
Domains
Server for US production environment:
Server for US production environment with AWS as cloud provider:
Server for EU production environment:
Server for EU production environment with GCP as cloud provider:
Authentication
All requests must be authenticated using one of the following three methods:
- API Key
- Secure Access Token (JWT)
- OAuth
OAuth and API key can be used to authenticate requests via the Authorization header.
“Authorization: KEY <apiKey/oauth>"A secure access token (JWT) can also be used to authenticate requests using Bearer schema.
“Bearer <bearerToken>”Unauthorized or improperly authenticated requests will fail, the event will be invalid and not recorded in Yext Analytics.
Serialization
The Events API only accepts data in JSON format.
Content-Type Headers
For all requests that include a request body, the Content-Type header must be included and set to application/json.
Rate Limits
Apps may be rate-limited if they are sending too many events in a short period of time. If you are currently over your limit, our API will return a 429 error, and the response object returned by our API will be empty.
Account ID
The me macro refers to the account that owns the API key sent with the request. The Events API infers the Yext account ID belonging to the request based on the API key.
The Events API does not support explicit definition of the account ID in the URL, nor does it support the all macro.
Response Format
id- The UUID for the event.
- The UUID for the event.
Example:
{"id":"01H7XCRWVJ486BA9PZVHV44J5C"}