BeaconConfig interface, including related interfaces, types, and default values.
For more information about the script to paste into the <head> tag of your website’s HTML file and the JSON configuration, see Signals Beacon.
BeaconConfig
This object details the primary configuration interface for the signals beacon.object
SignalAppType
default:"Retail"
The beacon supports both Retail signals and legacy site search signals.
BeaconAttributes
This attribute specifies a global configuration that will be inherited by each explicit action configuration for the beacon signals.
{ [field: string]: BeaconFieldConfig }
default:":scope @id"
The main section for extracting product field values from your site.
BeaconQueryProps
This specifies how beacon signals should be handled when the main product page is searched.
BeaconClickProps
The configuration for beacon signals sent when a product is clicked.
BeaconCartAddProps
The configuration for beacon signals sent when a product is added to the shopping cart or bag.
BeaconPurchaseProps
The configuration for beacon signals sent when the user proceeds to the checkout phase on your site.
BeaconFieldConfig
This is a type alias for field configuration. The value can be a string, or aBeaconFieldRichConfig object.
BeaconFieldRichConfig
This object details the interface to fine tune field details.object
BeaconAttributes
This object details the interface for the global configuration inherited by each action configuration.object
string
default:"pid"
The URL query parameter used to get the product ID from the product page.
string
default:"lwRetailCartId"
The local storage key for the consumer page storing the cart UUID.
string
default:".lw-product-item"
The CSS selector for targeting product elements. This is the global path inherited by each signal action.
number
default:"2400000"
Optional inactivity threshold in milliseconds that ends a session and starts a new one. The default is 2400000 ms (40 minutes).
string[]
default:"[price, quantity, revenue]"
This specifies the fields that are treated as number type fields.
string
This provides a more advanced way to obtain product details using serialized JSON in an element attribute.
BeaconSignalProps
This object details the interface that provides common properties for beacon signals.object
BeaconQueryProps
This object details the interface for configuring beacon signals sent during a product search.object
string
default:"query"
The URL query parameter the beacon uses to monitor query updates.
string
The CSS selector for targeting multiple page elements related to product query activities. The beacon analyzes the comma-separated elements, monitors when the ‘Enter’ key is pressed on the input element as well as clicks on the remaining elements, then sends query signals accordingly.In addition, the beacon supports the ability to track the ‘Enter’ key along with clicks on the search button for scenarios where there is no query parameter if the
trigger property is used. For example, the main search flow could use the query parameter q while the search within the search uses the beacon properties to record both the input and the search button clicks. An example configuration is:number
default:"1000"
This specifies the delay, in milliseconds, for tracking element updates in the query.
BeaconClickProps
This object details the interface for configuring beacon signals when the user clicks a product.object
BeaconCartAddProps
This object details the interface for configuring beacon signals sent when a product is added to the shopping cart or bag.object
string
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
{ [field: string]: BeaconFieldRichConfig }
The main section for extracting product field values from your site.
string
The CSS selector for targeting multiple page elements related to trigger add-to-cart actions.
BeaconPurchaseProps
This object details the interface for configuring beacon signals sent when the user proceeds to the checkout phase of the transaction.object
string
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
{ [field: string]: BeaconFieldRichConfig }
The main section for extracting product field values from your site.
string
The CSS selector for targeting multiple page elements related to trigger purchase or checkout actions.
string
The path to the element that displays the total sum of the items in the cart.