> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Beacon configuration interface
export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
const [isLoaded, setIsLoaded] = useState(false);
useEffect(() => {
const timer = setTimeout(() => {
setIsLoaded(true);
}, 500);
return () => clearTimeout(timer);
}, []);
return
{isLoaded && `
}} />}
Powered by Lucidworks Agent Studio
;
};
[localhost link]: http://localhost:3000/docs/lw-platform/lw-analytics/signals/beacon-configuration-interface
[mintlify link]: https://doc.lucidworks.com/docs/lw-platform/lw-analytics/signals/beacon-configuration-interface
[old doc.lw link]: https://doc.lucidworks.com/lw-platform/analytics/k6vyeq
This topic details the `BeaconConfig` interface, including related interfaces, types, and default values.
For more information about the script to paste into the `` tag of your website’s HTML file and the JSON configuration, see [Signals Beacon](/docs/lw-platform/lw-analytics/signals/signals-beacon).
## BeaconConfig
This object details the primary configuration interface for the signals beacon.
The beacon supports both Retail signals and legacy site search signals.
This attribute specifies a global configuration that will be inherited by each explicit action configuration for the beacon signals.
Configuration for query signals.
Configuration for click signals.
Configuration for add-to-cart signals.
Configuration for purchase complete signals.
The main section for extracting product field values from your site.
This specifies how beacon signals should be handled when the main product page is searched.
The configuration for beacon signals sent when a product is clicked.
The configuration for beacon signals sent when a product is added to the shopping cart or bag.
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 a `BeaconFieldRichConfig` object.
## BeaconFieldRichConfig
This object details the interface to fine tune field details.
This is the field value path.
This string is excluded from the raw value.
This property provides additional typing information that allows for proper transformation of the value.
## BeaconAttributes
This object details the interface for the global configuration inherited by each action configuration.
The URL query parameter used to get the product ID from the product page.
The local storage key for the consumer page storing the cart UUID.
The CSS selector for targeting product elements. This is the global path inherited by each signal action.
Optional inactivity threshold in milliseconds that ends a session and starts a new one. The default is 2400000 ms (40 minutes).
This specifies the fields that are treated as number type fields.
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.
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
The main section for extracting product field values from your site.
## BeaconQueryProps
This object details the interface for configuring beacon signals sent during a product search.
The URL query parameter the beacon uses to monitor query updates.
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:
```"query": { theme={"dark"}
"queryParam": "q",
"trigger": ".search-box input, .search-box .btn"
}
```
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.
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
The main section for extracting product field values from your site.
## BeaconCartAddProps
This object details the interface for configuring beacon signals sent when a product is added to the shopping cart or bag.
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
The main section for extracting product field values from your site.
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.
The custom selector to target product elements specific to particular retail actions. The action values are query, click, cartAdd, and purchase.
The main section for extracting product field values from your site.
The CSS selector for targeting multiple page elements related to trigger purchase or checkout actions.
The path to the element that displays the total sum of the items in the cart.