OCL 2.0 Locator Events Overview

OCL 2.0 Locators use an EVENT_NAME column to track specific analytic points throughout our different templates. This page shows which templates each event can be triggered from, for details regarding how each event is triggered and what data these events track see the individual event pages.

Event Name Type Multi Brand Product First Results First Widget
LOCATOR_BUTTON_CLICK CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_BUTTON_LOAD LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_BUTTON_VIEW VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_FIND_PRODUCTS_CLICK CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_PAGE_LOAD LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_CHECKOUT_CLICK CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_FOUND_IN_STORE RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_FOUND_IN_STORE_BY_RETAILER RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_FOUND_ONLINE RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_FOUND_ONLINE_BY_RETAILER RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_GROUP_VIEW VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_GROUP_SEARCHED SEARCH (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_NOT_FOUND_IN_STORE RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_NOT_FOUND_ONLINE RESULT (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_VIEW VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_VIEW_IN_STORE VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_PRODUCT_VIEW_ONLINE VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_RETAILER_CLICK CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_RETAILER_VIEW VIEW (blue star) (blue star) (blue star) (blue star)
LOCATOR_SEARCH_TEXT_INPUT SEARCH (blue star) (blue star) (blue star) (blue star)
LOCATOR_SEARCH_INSTORE_SUCCESS LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_SEARCH_INSTORE_UNSUCCESSFUL LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_SEARCH_ONLINE_SUCCESS LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_SEARCH_ONLINE_UNSUCCESSFUL LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_STORE_CLICK CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_STORE_CLICK_CALL_STORE CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_STORE_CLICK_GET_DIRECTIONS CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_STORE_CLICK_PRODUCT CLICK (blue star) (blue star) (blue star) (blue star)
LOCATOR_USER_LOCATION_SUCCESS LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_USER_LOCATION_UNSUCCESS LOAD (blue star) (blue star) (blue star) (blue star)
LOCATOR_LABEL_CLICK CLICK (blue star) (blue star) (blue star) (blue star)

Default Data Points

Unless otherwise specified all events will have the below fields included:

client The clients' id value. Typically the client_db value from the Destini Database
locator

A pipe | delimited value containing the follow values (in order):

  • Locator’s id value
  • Locator’s name value
country

The Country the locator is currently searching for. This value is determined by:

  1. The Country the user was geolocated to (if Location Detection is not disabled)
  2. The Country the searched area was geolocated to

If the locator was unable to geolocate a country this value will be UNKNOWN

region

The Region, also known as state, the locator is currently searching for. This value is determined by:

  1. The Region the user was geolocated to (if Location Detection is not disabled)
  2. The Region the searched area was geolocated to

If the locator was unable to geolocate a region this value will be UNKNOWN

city

The City the locator is currently searching for. This value is determined by:

  1. The City the user was geolocated to (if Location Detection is not disabled)
  2. The City the searched area was geolocated to

If the locator was unable to geolocate a city this value will be UNKNOWN

zipcode

The Zipcode, also known as postal code, that the locator is currently searching for. This value is determined by:

  1. The Zipcode the user was geolocated to (if Location Detection is not disabled)
  2. The Zipcode the searched area was geolocated to
  3. The Zipcode entered via the ZIP URL parameter

If the locator was unable to find a Zipcode via the above methods this value will be UNKNOWN

sessionId

The visitors “unique” session ID value, used to identify different visitors to the locator.

This value is created by MD5 hashing the visitors IP Address, User Agent, and the YYYY-MM-DD H timestamp of their visit. This means the same person will get a different sessionId every hour and that people visiting on the same version of a browser from the same IP address will get the same hash (for example from a Library). 
 
If an event was sent before the visitors sessionId value was received then this value will be UNKNOWN

Misc Notes

Ingestion is triggered every 15 minutes and processes data from GTM that is a day behind. Since this process is from a day ago and we don’t send any product/label/category associations we must grab that at the time ingestion. This means that if the client makes any changes it can affect ingested data for up to 24 hours.

Useful Definitions

Locator session

A locator session starts as soon as the locator loads and ends as soon as the client navigates away from the locator. This includes refreshing the page, which will end their previous session and start a new session.

Search session

A search session starts as soon as a search is initiated. A search is automatically triggered if DTR=1 is specified on the locator URL or if the Locator Template is Results First. A search session is based off the locator’s selected country & language as well as what products were selected and what location is being searched.

A new search session is created when:

  • The selected country changes
  • The selected language changes
  • The searched location changes
  • The selection of products has changed
    • This means if you go back to the product selection screen but do not make any changes and then click the Find Products button a new session is not created.
Was this article helpful?
0 out of 0 found this helpful