Home > widget-integration > FilterAPI > addCustomParams

FilterAPI.addCustomParams() method

Adds custom parameters from global configuration.

This method reads custom parameters from window.boostSdCustomParams or window.boostWidgetIntegration.config.customization.filter.customizedAPIParams and adds them to the API request. Override this method to add shop-specific custom parameters or modify parameter handling logic.

Signature:

protected addCustomParams(queryParams: URLSearchParams): void;

Parameters

Returns:

void

Example

Extend to add shop-specific tracking parameters:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class CustomFilterAPI extends FilterAPI {
    protected addCustomParams(queryParams) {
      super.addCustomParams(queryParams);
      // Add shop-specific tracking for analytics
      queryParams.set('shop_id', this.getShopId());
      queryParams.set('utm_source', 'boost_filter');
    }
  };
});