Email Integration Parameters

Details

The tables below detail the various parameter names, descriptions and whether or not the parameter is required in the email's HTML when implementing Recommend + Email.

Note: For more information about the implementation, refer to Email Setup.

Parameters

Both calls to the Algonomy server use these parameters:

Parameter Name	Quick Info	Description	Examples	Required
apiKey or a	API Key	The API key assigned to your web site by Algonomy. Each Algonomy partner has a unique API key that separates that partners data and traffic from other partners.	&a=[API_KEY]	Yes
userId or u	User ID	The unique User ID value that matches the site User ID.	&userId=12345	Yes
campaign or campaignId or cpi	Campaign ID	The unique name for the campaign that the merchant is setting up. This can be whatever the client wants, however, it must be unique.	&campaignId= order_confirmation or campaignId= Electronics PromoJuly2011	Yes
date	YYYY-MM-DD	Date the campaign is sent. Note: If sending multiple e-mails with the same userId parameter, you might see the same product recommendations even if the seed product ("productId") parameter is different. To avoid this, a format including the timestamp is recommended: date=2016-04-28-HHmmssmil (hour, minute, second, milisecond values too) By using this format, the date parameter will for all intents and purposes be unique each time an e-mail is sent, which will ensure that there will be no caching.	&date=2009-12-02	Yes
placement or pt	Placement	The name of the placement set up for this email. You can have multiple placements for different emails (for example, abandon-content). Note that the placement name does not have the page type.	&placement=responsive_rr	Yes
layout or ln or l	Layout name	The name of the layout set up for this email.	&layout=HTML-Email-Responsive	Yes
zoneName or pa	Look & Feel for ImageMaP	This is the name of the layout received from Algonomy	&zoneName=Vertical_3	Yes, but only for ImageMap
slot	Product position for Responsive	Indicates the position of the product in the set of recommendations returned. Will be used for redirection to correct product page. It is only used on click links and the Strategy title has the value 0 (zero).	&slot=2	Yes
lid or rrIndex	Product position for ImageMap	Indicates the position of the product in the set of recs returned. Will be used for redirection to correct product page. Only used on click links.	&lid=2	Yes
version or rmv	Version (default=1)	Note that all the brand/category/strategy filter attributes defined below only work with Version 2	&version=2	No
region	Region	If your site uses regions, set this parameter to the name of the customer's region.	&region=pt-BR	No
bi	Block item ID	This option will force Recommend to NOT recommend specified products.	&bi=123\|234\|567	No
orderId or o	Order ID	The ID of an order if the email is related to an order.	&o=48958387	No
brandId or seedBrands or fpb	Brand ID	If the email refers to a specific brand, send the Brand ID. One or more brand IDs separated by a pipe	&seedBrand=65432\|98765	No
categoryId or seedCategoryIds or cis	Category ID	If the email refers to a specific category, send the category ID. One or more Category IDs separated by a pipe	&categoryId= 12345 or &seedCategory Ids=12345\|2345 \|67890	No
productId or seedProductIds or p	Product ID	If the email refers to a specific product, send the product ID. One or more Product IDs separated by a pipe. Note: The system de-duplicates between items identified as a seedProductIds.	&productId=123	No
st	Search Term	Specifies a search term that can be used by the SearchBought strategy family. Needs to be URL encoded.	&st=Harry%20Potter	No
strategySet	Filter Strategies	A prioritized list of strategy sets that you would want to be returned based on the campaign use case. Refer to additional details under Strategy Families listing below. If this is not provided, our recommendation engine will run King of the Hill (KOTH) to provide best recommendations given the information provided. See list of available strategies below.	&strategySet=SiteWideBestSellers or &strategySet=ProductBoughtBought\| ProductViewedViewed	No
filbr	List of Brands	Lists of brands you want to act on. This parameter works in conjunction with filbrinc. Both must be setup correctly to get desired results.	&filbr=SONY\|Samsung	No
filbrinc	Include True/False	This flag allows you to show or remove the brands you provided under filbr. The default value is false, which would remove the specified brands.	&filbrinc=true	No
filcat	List of Categories	Lists of categories you want to act on. This parameter works in conjunction with filcatinc. Both must be set up correctly to get desired results. The category external ID (not category name) must be specified.	&filcat=TVS\| DVDS	No
filcatinc	Include True/False	This flag allows you to show or remove the categories you provided under filcat. The default value is false, which would remove the specified categories.	&flicatinc=true	No
filprmin	Price Min	This flag allows you to pass in a minimum price threshold. Note that this needs to be in cents.	&filprmin=2500	No
filprmax	Price Max	This flag allows you to pass in a maximum price threshold. Note that this needs to be in cents.	&filprmax=10000	No
filprinc	Include True/False	This flag allows you to include or remove products matching the minimum and maximum prices set using filprmin and filprmax. The default value is false.	&filprinc=true	No
ct	Click to, for ImageMap	Click URL to the product page. Needs to be URL encoded.	&ct=https%3A%2F%2Fwww.williams-sonoma.com%2Fproducts%2Fgreen-glass-shells%2F%3Frm%3Dt%26vg%3Dad8cc61d-9506-40cb-02d1-3058cb2da005	No
vg	View GUID	View GUID param	&vg=ad8cc61d-9506-40cb-02d1-3058cb2da005	No
additionalClickURLData	Additional Click URL Data	Additional parameters added by the merchant. Needs to be URL encoded.	&season=spring%20summer	No
engageSegmentId	Engage Segment	Engage segment ID. Numeric.	&engageSegmentId=1	No
emailRunId	Email Run Id	Email run ID.	&emailRunId=run1234	No
testMode or direct	Test mode	true/false	&testMode=true	No
devMode	Dev Mode	True/false. If "devMode=true" the caching mechanism will be bypassed	&devMode=true	No
lang	Language	Identify the language requested using the language code	&lang=sv-SE	No
sgs	Segment ID	Identify segments to be leveraged in an email	&sgs=3067	No
omitBackground	Include True	If you prefer to display images and text on a transparent background, meaning the background you define in the email template of your Email Service Provider (ESP), you can specify omitBackground as True. Note: In the email layout, you will need to configure 'background-color: transparent' or avoid setting the 'background-color' parameter.	&omitBackground=True	No
dedupWith	Specify the placements & layout names	This parameter allows you to specify which placement names and layout names should be included in the request when deduplicating the generated recommendations. For more details, refer to Deduplication of Email Recommendations.	&dedupWith=P1:L1\|P2:L2	No

Strategy Families for strategySet parameter

Strategy Families / Filter Strategies/ Variable ‘fs’	Description	Additional Required Parameters	Suggested Parameters
SiteWideBestSellers	Sitewide strategies such as top sellers, popular products etc.	None
RatingsReviews	Ratings & reviews-based strategies	None
CategoryBestSellers	Category-based strategies – Category top sellers etc.	Category ID	Brand (for BrandTopSellers)
NewArrivals	Strategies that recommend new arrivals (given the data is provided in the feed)	Category ID
MoversAndShakers	Strategies that recommend the products that were in demand in the recent past (1 wk, 2wks, 3 wks)	None
ProductViewedViewed	Recommendations on other products viewed when people Viewed ProductX	Product ID
ProductBoughtBought	Recommendations on other products purchased when people purchased ProductX	Product ID
SearchBought	Strategies that return products based on search term passed. Ex: “What did people buy when searching for ‘XYZ’?”	Search term
CategoryBoughtBought	“People who bought items in CategoryX also bought items in the following Categories: Y, Z, A.”	Category ID
Personalized	Personalized strategies for the customer – these may include recently Viewed items and recommendations based on recent view history, or recommendations based on recent purchase history, etc. Personalized strategies look at your browser cookies to determine the seed.	User ID