Skip to main content
Version: Next

AnalyticsProvider

AnalyticsProvider​

commandkitanalytics-provider.ts

AnalyticsProvider interface defines the contract for analytics providers.

Signature
interface AnalyticsProvider {
    readonly name: string;
    track(engine: AnalyticsEngine, event: AnalyticsEvent): Promise<void>;
    identify?(engine: AnalyticsEngine, event: IdentifyEvent): Promise<void>;
}

name​

property
string

The name of the analytics provider. This is used for logging and identification purposes.

track​

method
(engine: AnalyticsEngine, event: AnalyticsEvent) => Promise<void>

Initializes the analytics provider. This method is called when the provider is registered.

identify​

method
(engine: AnalyticsEngine, event: IdentifyEvent) => Promise<void>

Identifies a user or entity with the analytics provider. This method is called to associate user data with events.