AnalyticsApi

Home > @backstage/core-plugin-api > AnalyticsApi

The Analytics API is used to track user behavior in a Backstage instance.

Signature:

export type AnalyticsApi = {
    captureEvent(event: AnalyticsEvent): void;
};

References: AnalyticsEvent

Remarks

To instrument your App or Plugin, retrieve an analytics tracker using the useAnalytics() hook. This will return a pre-configured AnalyticsTracker with relevant methods for instrumentation.