Events (analytics)

klevu collects and processes user interaction data through machine learning to drive search, category, and recommendation results there are 4 types of events available in the frontend sdk result object events event handler functions returned by search requests made through klevufetch search modifier events events that are submitted when searches are being made within klevufetch dom events events that are fired by the frontend sdk to trigger your event handler code custom events low level interface to send your events to klevu in typical application you should use result object events to pass data to klevu, search modifier events to send information about user views and listen dom events for changes made by sdk lastly if you are not using shopify, magento or bigcommerce connectors you need to pass checkout event to klevu result object events view the result object docid 3gzh10biavwzokq3 g11j page to learn more about result object click events it is the easiest way to implement data passing to klevu search modifier events result object has events for sending click information to klevu on top of this information klevu requires view events these events should be sent when user views search result, merchendising page or recommendation banner typically requests should be implemented to all klevufetch calls only exception is that when implementing "quicksearch" bar (a search bar on top of page that shows results right away) it should not send these events it should be sent only when user clicks into search results page and this is done by the getsearchclicksendevent() helper in result object sendsearchevent() modifier that should be used on klevufetch on search result page sendmerchendisingviewevent() modifier that should be sent when merchendising page is displayed sendrecommendationviewevent() modifer that should be sent with recommendation request like "kmcrecommendation" or "similarproducts" dom events sdk core sends a dom events that any browser library could listen and act on the events all events are attached to document klevudomevents enumeration is exposed from the library and it's quite simple to listen for example import { klevudomevents } from "@klevu/core" // function to run when filter selection is updated const handlefilterupdate = () => { console log("filter updated") } // attach event listener document addeventlistener( klevudomevents filterselectionupdate, handlefilterupdate ) // don't forget remove event listener in your component destructor document removeeventlistener(handlefilterupdate) global custom document events that @klevu/core sends event type description lastsearchupdate when list of last searched terms update filterselectionupdate when filter manager selection has changed clickeventsent when any click event has been fired on the page custom events klevuevents class is low level solution to pass events to klevu backend custom events in the klevu headless sdk represent events that are not tied to the result object returned by a call to klevufetch or dispatched via dom events these events include search done search product click merchendising view merchendising product click recommendation view recommendation product click buy/purchase