| Function | Description |
|---|---|
| analytics(config) | The Yext Analytics Events SDK. Returns an AnalyticsEventService given an AnalyticsConfig. |
| reportBrowserAnalytics() | An alternative entry point for the Yext Analytics Events SDK, currently used by Google Tag Manager. This method reads the config and payload from the variable analyticsEventPayload stored in the global window object. The config and payload are then passed to the report function to be sent to the Yext Analytics Events API. |
| Interface | Description |
|---|---|
| AnalyticsConfig | The main configuration options for Analytics Events. |
| AnalyticsEventService | A service for reporting Yext analytics events |
| EventPayload | The payload accepted by the Analytics Events API. |
| Type Alias | Description |
|---|---|
| Action | The action types accepted by the Analytics Events API. |
| Environment | The Yext Environments |
| Region | The physical region of the Yext account |
| VersionLabel | An enum for the Search Version Labels |