Home > widget-integration > RecommendationWidgetTrackingData

RecommendationWidgetTrackingData type

Tracking data structure for recommendation widgets.

Defines the shape of data stored for recommendation widget analytics and tracking. This data is persisted to localStorage to track user interactions with recommendation widgets and enable analytics reporting.

Signature:

export type RecommendationWidgetTrackingData = {
	wid: string;
	rid?: string;
	rt?: string;
};

Remarks

The structure is kept minimal for performance and storage efficiency. Only the widget ID is required; recommendation ID and type are optional to support different tracking scenarios without unnecessary data overhead.

Technical Support teams can extend this type for shop-specific tracking needs, though be mindful of localStorage size limitations when adding additional fields.

Example 1

Basic tracking data with all fields:

const trackingData: RecommendationWidgetTrackingData = {
  wid: 'product-page-similar',
  rid: 'rec-xyz789',
  rt: 'similar-products'
};

Example 2

Minimal tracking data (widget ID only):

const trackingData: RecommendationWidgetTrackingData = {
  wid: 'homepage-bestsellers'
};