Event

Record the event. In OMNICOMMERCE's Performance menu, you can analyze the information based on the tracked data and view the results.

OpmIO.event(eventName, eventOption);

Parameter	Type	Description
eventName	string	Name of the event
eventOption	object or string[]	Allows you to provide additional information about the event. (See: [EventOption])

💡 example

Please refer to the details below for specific options.

// object
OpmIO.event('eventName', { 
  workspaceId: 'your_workspace_id', 
  solutionId: 'your_solution_id',
  productPrice: 10000 
});
// array
OpmIO.event('eventName', 
  [{ 
    workspaceId: 'your_workspace_id', 
    solutionId: 'your_solution_id',
    productId: 'a',
    productPrice: 10000 
  },
  { 
    workspaceId: 'your_workspace_id', 
    productId:'b'
  }]
);

---

EventName

Event	Description
add_to_wishlist	Event-triggered when a product is added to a wishlist (favorites) or similar
add_to_cart	Event-triggered when a product is added to the shopping cart
purchase_click	Event-triggered when the purchase button is clicked on the page
transaction	Event-triggered when a final purchase is made
result_load	Event triggered when a product recommendation is requested and received in the recommendation section of the page
recommend_click	Event-triggered when a recommended product is clicked in the recommendation area on the page.
recommend_view	Event-triggered when the recommendation area is initially displayed on the page (applies when the recommendation area is first displayed upon scrolling)
detail_page_view	Event triggered when a user visit a detail page of a product
home_page_view	Event triggered when a user visit a home page of an e-commerce
cart_page_view	Event triggered when a user visit a cart page
category_page_view	Event triggered when a user visit a category page
search_result_page_view	Event triggered when a user search a specific keyword and visit a search result page

EventOption

You can provide additional information required for event analysis as optional options.

Parameter	Type	Description
userId	string	Actual customer id (e.g., example@company.com)
userAge	string	User's Age
userGender	string	User's Gender
workspaceId	string	Used workspace id
solutionId	string	OMNICOMMERCE solution id (See: solutionid)
productId	string	Product id
productName	string	Product name
productPrice	number	Product price
productGender	string	Product gender
brandName	string	Brand name
suggestQueryId	string	OMNICOMMERCE recommended query id
suggestProductIds	string[]	List of OMNICOMMERCE recommended product ids
placement	string	The page where the event occurred (main page, product detail page, product listing page, etc.)
label	string	Keywords for event tracking or analysis
productLikeCount	number	Like count of product
productReviewCount	number	Review count of product
productReviewScore	number	Review score of product
strategy	string	recommendation strategy
extra	object	A key-value formatted object for adding any additional data you want to include

Solution ID

Currently, the following Solution IDs are supported.

Name	Description
CSRCH	Camera Search
VRCMD	Visual Recommendations
SRCMD	Styling Recommendation
TAGG	Automated Product Tagging
IMMOD	Image Moderation