Fredhopper (FHR)

This page covers what you need to have available on the front end for your tracker from the FHR query response, and which events to track. This is specific for an FHR integration.
Prerequisites
In order to be able to send events through the tracker for your FHR integration you need to have the following information ready from server side in your front-end application.
responseId - the response id of the FHR query, to be used as a sourceId.
searchTerms - the search terms used in the performed query if it'a search result.
facetIds and facetValues - the ids and values of any facets on the page.
campaignIds - the ids of any campaigns on the page.
secondIds - the second ids of all the products, necessary for making actions related to the product.
prices - the prices of the products.
currency - the currency the products are sold in.
locale - the locale selected by the user.
View events
Depending on your use case you need the following data for every event of view type:
When your user lands on a page through navigation page:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
pathToPage - the path to the page in your webshop. Corresponds to target.pathToPage in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user lands on a search results page:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
pathToPage - the path to the page in your webshop. Corresponds to target.pathToPage in the activity object.
searchterms - the search terms used in the query. Corresponds to metadata.search-terms in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user lands on a product detail page - when powered by FHR:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
secondId - the second id of the product. Corresponds to target.product in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user lands on a product detail page - when not powered by FHR:
secondId - the second id of the product. Corresponds to target.product in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
Check the details around sending the events below:
View
Click events
Depending on your use case you need the following data for every event of click type:
When your user clicks on product:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
secondId - the second id of the product. Corresponds to target.product in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user clicks on a product from a campaign:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
secondId - the second id of the product. Corresponds to target.product in the activity object.
campaignId - the id of the campaign clicked. Corresponds to target.campaign in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user clicks on a facet:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
facetId - the id of the facet. Corresponds to target.facet in the activity object.
facetValue - the value of the facet. Corresponds to target.[facetId] in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
Check the details around sending the events below:
Click
Add to cart events
Depending on your use case you need the following data for every event of add-to-cart type:
When your user adds an item to to cart from lister(navigation or search results page) page:
responseId - the FHR query response id. Corresponds to sourceId in the activity object.
secondId - the second id of the product. Corresponds to target.product in the activity object.
quantity - the quantity of the product added. Corresponds to metadata.quantity in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
When your user adds an item to cart from product detail page:
secondId - the second id of the product. Corresponds to target.product in the activity object.
quantity - the quantity of the product added. Corresponds to metadata.quantity in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
Check the details around sending the events below:
Add to Cart
Remove from cart events
You need the following data for every event of remove-from-cart type:
When your user removes an item from cart completely(not lowering quantity):
secondId - the second id of the product. Corresponds to target.product in the activity object.
Check the details around sending the events below:
Remove from Cart
Purchase events
You need the following data for every event of purchase type:
When your user purchases an item:
secondId - the second id of the product. Corresponds to target.product in the activity object.
quantity - the quantity of the product added. Corresponds to metadata.quantity in the activity object.
price - the price of the product added in cents(no decimals). Corresponds to metadata.price in the activity object.
currency - the currency of the price. Corresponds to metadata.currency in the activity object.
locale - the locale selected by the user on your webshop. Corresponds to metadata.locale in the activity object.
Check the details around sending the events below:
Purchase

Next - Items API

What is the Items API?

Last modified 4mo ago

Copy link

Contents

Remove from cart events

Purchase events