Skip to Content
Reference<TelemetryDeckAnalytics>

<TelemetryDeckAnalytics> initializes TelemetryDeck and automatically tracks page views on route changes.

Use it in your root layout to enable analytics site-wide.

<TelemetryDeckAnalytics appID="your-telemetrydeck-app-id" clientUser="anonymous" />

This component sends pageView with { path } each time pathname changes.

Properties

All properties are passed through to TelemetryDeck SDK options.

PropertyValueDescription
appIDstring

Your TelemetryDeck App ID. Required.

clientUserstring

Stable user identifier. Use anonymous if you don’t want to identify individual users.

targetstring

Optional custom backend endpoint.

sessionIDstring

Optional session identifier.

saltstring

Optional salt used for hashing user identifiers.

testModeboolean

Enables test mode for local verification.

storeStorageLike

Optional custom storage implementation.

subtleCryptoSubtleCrypto

Optional custom crypto implementation.

For custom events, use the useTelemetryDeck() hook.