Recommendation Configuration
Overview
This article outlines the process for setting up and configuring HawkSearch recommendations. The Recommendation functionality enhances your platform by providing personalized product suggestions, potentially increasing conversion rates, average order value, and customer satisfaction. By leveraging user behavior data, it improves product discovery and offers valuable insights for inventory and marketing decisions.
Configuration Steps
The core of the recommendation system relies on the HawkSearch recommendation API. This process involves setting up the API connection in your Optimizely dashboard, ensuring correct event tracking, and configuring the recommendations in the HawkSearch workbench. The following steps will guide you through this integration process.
Optimizely Dashboard Configuration
- Log into your Optimizely dashboard
- Navigate to: Administration > System > Settings > Search > Xngage HawkSearch section
- Locate the Recommendation API URL field
- Add the appropriate URLs according to the environment. For more details regarding Recommendation API, please refer to this article
Environment | Recommendation API |
---|---|
Development | https://recs-dev.hawksearch.net/api/recommendation/v2/ |
Test | https://recs-test.hawksearch.net/api/recommendation/v2/ |
Production | https://recs-na.hawksearch.com/api/recommendation/v2/ |
- Confirm that your event tracking is set up correctly, please refer to this article for more details.
HawkSearch Workbench Configuration
- To configure your recommendation widgets, please navigate to the Recommendation administration in HawkSearch workbench
- For more details on configuring recommendation through HawkSearch workbench, please refer to this article.
Verifying Recommendation Configuration
After setting up your recommendations, it's important to verify that they are working correctly. For details about different recommendation strategies, please refer to this article.
Testing with Featured Item Strategy
Testing with the Featured Items strategy is the most basic way to verify if recommendations are working:
- Configure the Feature Items strategy:
- Log in to the HawkSearch workbench
- Set up a new recommendation widget using the Feature Items strategy
- Prepare the API request
- Use an API testing tool (e.g. Postman)
- Set up a POST request to the HawkSearch recommendation API endpoint to get the recommendation widget you set up
- Send the request to the API endpoint
- Examine the API response:
- Verify that the response status is 200
- Ensure the response contains a list of featured items from your index
- Verify that the returned items align with your widget configuration (e.g., match condition, proper sorting)
- Look for any error messages or unexpected data in the response
Testing with Recently Viewed Strategy
The Recently Viewed strategy relies on user behavior tracking and requires a sequence of events before testing the recommendations:
- Configure the Feature Items strategy:
- Log in to the HawkSearch workbench
- Set up a new recommendation widget using the Recently Viewedstrategy
- Simulate user interactions by sending tracking events
- Send a search event: make a POST request with search event type
- Send a click event:
- choose an item from the search results to be tested
- make a POST request with click event type
- Send a page load event: make a POST request with page load event type to simulate viewing the product
- Prepare the API request
- Use an API testing tool (e.g. Postman)
- Set up a POST request to the HawkSearch recommendation API endpoint to get the recommendation widget you set up
- Send the request to the API endpoint
- Examine the API response:
- Verify that the response status is 200
- Ensure the response contains the item(s) from your simulated user journey
- Verify that the returned items align with your widget configuration (e.g., match condition, proper sorting)
- Look for any error messages or unexpected data in the response
Updated 6 months ago