Skip to main content
POST
/
brands
/
api
/
v1
/
public
/
widget-events
Track brand locator widget events
curl --request POST \
  --url https://www.closient.com/brands/api/v1/public/widget-events \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "brand_id": "",
  "referrer": "",
  "product_id": "",
  "store_id": "",
  "query": ""
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
brand_id
string
default:""

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

​
referrer
string
default:""

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

​
product_id
string
default:""

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

​
store_id
string
default:""

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

​
query
string
default:""

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

Response

204

No Content