Skip to main content
POST
Track brand locator widget events

Body

application/json

Fire-and-forget analytics event from the brand locator widget.

event
string
required

Funnel stage of the widget interaction. Accepted values: widget_load, location_search, product_filter_change, store_click, get_directions_click.

Pattern: ^[^\x00]{0,}$
brand_id
string
default:""

Brand short id the widget is rendering. Empty when unknown (e.g. widget script load before init).

Pattern: ^[^\x00]{0,}$
referrer
string
default:""

Page where the widget was embedded, taken from document.referrer. Truncated to 512 characters.

Pattern: ^[^\x00]{0,}$
product_id
string
default:""

Brand catalog product short id, set on product_filter_change events. Empty otherwise. Truncated to 128 characters.

Pattern: ^[^\x00]{0,}$
store_id
string
default:""

Physical store short id, set on store_click and get_directions_click events. Empty otherwise. Truncated to 128 characters.

Pattern: ^[^\x00]{0,}$
query
string
default:""

Free-text search query the user typed. Set on location_search events only. Truncated to 256 characters.

Pattern: ^[^\x00]{0,}$

Response

No Content