Home > widget-integration > RecommendationAnalytic

RecommendationAnalytic class

Service for handling recommendation widget analytics and tracking data storage.

This service manages the persistence of recommendation widget tracking data to localStorage, enabling analytics and tracking of user interactions with recommendation widgets. It provides customizable storage key generation and error handling that can be extended by Technical Support teams for shop-specific requirements.

Signature:

export declare class RecommendationAnalytic 

Remarks

The service uses localStorage for persistence, which has browser-specific limitations: - Storage quota varies by browser (typically 5-10MB) - May be unavailable in private browsing mode - Can be cleared by users at any time

Technical Support teams can extend this service to: - Customize storage key prefixes for multi-widget scenarios - Implement alternative storage mechanisms (sessionStorage, IndexedDB) - Add shop-specific error handling and fallback strategies - Integrate with custom analytics platforms

Example 1

Basic usage in widget code:

const analytic = new RecommendationAnalytic();
analytic.storeRecommendationWidgetTrackingData({
  wid: 'homepage-recs',
  rid: 'rec-12345',
  rt: 'similar-products'
});

Example 2

Extend to use custom storage prefix for multi-shop setup:

window.boostWidgetIntegration.extend('RecommendationAnalytic', (RecommendationAnalytic) => {
  return class CustomRecommendationAnalytic extends RecommendationAnalytic {
    protected getStorageKeyPrefix() {
      // Use shop domain in prefix to avoid conflicts
      return `${window.Shopify.shop}-boostSdRecommend`;
    }
  };
});

Example 3

Extend to implement fallback storage strategy:

window.boostWidgetIntegration.extend('RecommendationAnalytic', (RecommendationAnalytic) => {
  return class CustomRecommendationAnalytic extends RecommendationAnalytic {
    protected handleStorageError(error, data) {
      // Try sessionStorage as fallback
      try {
        const key = this.generateStorageKey(data.wid);
        sessionStorage.setItem(key, JSON.stringify(data));
      } catch (fallbackError) {
        // Send to custom analytics endpoint as last resort
        this.sendToAnalyticsAPI(data);
      }
    }
  };
});

Methods