Type Alias: Analytics
Analytics =
object
Defined in: api/index.d.ts:58
API interface representing the analytics API methods and properties. Each method interacts with the internal analytics system to track user data, events, and activities.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
getUserId | () => Promise<string> | Retrieves the user ID. Example const userId = await exodus.analytics.getUserId() | api/index.d.ts:136 |
identify | () => Promise<void> | Identifies the user by their traits. Deprecated Example await exodus.analytics.trackInstall() | api/index.d.ts:93 |
requireDefaultEventProperties | (payload) => void | Requires that the provided properties are present in analytics events. Example exodus.analytics.requireDefaultEventProperties(['isAwesome', 'otherProperty']) | api/index.d.ts:126 |
setDefaultEventProperties | (payload) => void | Sets default properties for analytics events. Remarks This method allows setting properties that will be included with every tracked event. Example exodus.analytics.setDefaultEventProperties({ isAwesome: true }) | api/index.d.ts:116 |
setDefaultProperties | (payload) => void | Sets default properties for analytics events. Deprecated Use setDefaultEventProperties instead for setting event properties. Example exodus.analytics.setDefaultProperties({ isAwesome: true }) | api/index.d.ts:104 |
setTrackActivities | (track) => Promise<void> | Sets the tracking status for user activities. Example await exodus.analytics.setTrackActivities(true) | api/index.d.ts:146 |
track | (payload) => Promise<void> | Tracks a generic event or activity. Remarks This method allows the tracking of user interactions or system events. Example await exodus.analytics.track({ force: true, event: 'testEvent', properties: { test: true } }) | api/index.d.ts:70 |
trackInstall | () => Promise<void> | Tracks the installation of the application. Remarks This method should be used to track when the application is installed by the user. Example await exodus.analytics.trackInstall() | api/index.d.ts:82 |