Tracking Events for Recommendations, E-mail Triggers & Site Search

Visit

Every time a product detail page (PDP) is viewed, a visit event should be fired. This helps you track the number of users showing interest in each product.

Parameter	Name	Type	Example	Description
P1	EventType	String	visit	Hardcoded `visit`.
P2	ProductId	String	m57500_Red	The unique ID is used in your web store to identify the product. A good rule of thumb is to consider an item unique if it has a unique URL in your online store. The ProductId typically includes the MasterId along with variants such as color or type. For fashion items, this could be rendered as: ProductId = Master ID + color. Read about how Raptor manage ProductIds here.
P3	ProductName	String	Asics 4 running jacket	The product name.
P4	CategoryPath	String	400#running;402#running-clothes;422#running-jackets	The list of category paths to which the given item belongs. A category path describes the location of each product in the category hierarchy. It is a`;`separated list of subcategories that starts with the top-level category. The data format should be: "CategoryId1#CategoryName1;CategoryId2#CategoryName2 If the CategoryName is missing, then simply repeat the CategoryId (i.e. “25#25;11#11;10#10”). The same applies if only the CategoryName is available. The category name or category Id path must not contain `,` or `;`.
P7	UserId (Website Id)	String	32142312	The UserId is a unique ID for users who are logged into your site. In other words, it's an ID that resides in your database. The ID can take various forms, such as an e-mail, a GUID or string etc. Read about how User tracking here.
P8	BrandId	String	Asics	The Brand ID or Brand Name.
P12	ItemPrice	decimal	100.00	The actual price of the product. (Sales-price if the item is on sale - otherwise same as the OriginalPrice.) Only used for price drop triggers.
P15	StockStatus	String	true	`true` if the product is "in stock" `false` false if the product is "out of stock".
P18	MasterId	Sting	m57500	The MasterId represents the product identifier without considering sizes, colors, or other variants. - Multiple products of the same type may have different ProductIds, but they share the same MasterId. Read about how Raptor manage ProductIds here.
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	Ruid (Raptor E-mail Marketing ID)	String	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id)	String	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Basket

Every time a user adds, removes or clear out the basket, a basketevent should be fired. This event is mainly used for the abandoned basket trigger, but also for feeding the recommendation engine with information about what the users add to their basket, used for personal recommendation.

Parameter	Name	Type	Example	Description
P1	Eventype	String	basket	Hardcoded `basket`
P2	ProductId	String	m57500_Red	Send the `productId` of the product that the user adds to the basket. The type of ID send in ProductId and BasketContent must be the same. Read about how to handle product data here.
P7	UserId (Website Id)	String	32142312	The UserId is a unique ID for users who are logged into your site. In other words, it's an ID that resides in your database. The ID can take various forms, such as an e-mail, a GUID or string etc. Read about how User tracking here.
P10	BasketContent	String	m57500_Red,b562505_blue,a452354_black	The content of the entire basket must be sent as a comma-separated list whenever a user adds, removes, or clears out the basket. If the user empties the basket, the basket event should be sent with no data in `p10` (BasketContent).
P11	BasketId	String	4ads6a6fa532	The unique ID of a basket. (The parameter is only used for the Abandoned Basket Trigger to restore the basket link).
P12	Itemprice	decimal	100.00	The actual price of the product. (Sales-price if the item is on sale - otherwise same as the OriginalPrice.) Only used for price drop triggers.
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	Ruid (Raptor E-mail Marketing ID)	String	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id	String	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Favorite
Every time a user adds, removes or clear out the favorites list, a favorite event should be fired. This event is used for the for feeding the recommendation engine with information about what the users add to their favorites list, but also to Behavioral triggers such as Abandoned Favorites, Price Drop Favorites, Back On Stock Favorites and Campaign Favorites.

Some sites refer to this favorites list as a "wish list". In the Raptor Control Panel we use the favorites list as a term for wish list.

Parameter	Name	Type	Example	Description
P1	Eventype	String	favorite	Hardcoded `favorite`
P2	ProductId	String	m57500_Red	Send the`productId` of the product that the user adds to their favorites list. The type of ID send in ProductId and FavoriteslistContent must be the same. Read about how to handle product data here.
P7	UserId (Website Id)	String	32142312	The UserId is a unique ID for users who are logged into your site. In other words, it's an ID that resides in your database. The ID can take various forms, such as an e-mail, a GUID or string etc. Read about how User tracking here.
P12	Itemprice	String	100.00	The actual price of the product. (Sales-price if the item is on sale - otherwise same as the OriginalPrice.) Only used for price drop triggers.
P14	FavoriteListContent	String	m57500_Red,b562505_blue	The content of the entire favorites list must be sent as a comma-separated list whenever a user adds, removes, or clears out the favorites list. If the user empties the favorites list, the basket event should be sent with no data in `p14` (favoritelistcontent).
P23	FavoriteListId	String	4ads6a6fa532	The unique ID of a favorites list. (The parameter is only used for the Abandoned favorites Trigger to restore the link to the favorites list).
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	Ruid (Raptor E-mail Marketing ID)	String	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id	String	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Buy

The buy event should be fired when someone views the final confirmation-page, or otherwise completes the ordering-process. Fire the buy event for every product within the order. For example, if a customer buys 1 unit of product A and 2 units of product B within one order, then two buy events should be sent.

The buy event is key for analyzing the overall performance of your business, combining products, and making personal recommendations.

Parameter	Name	Type	Example	Description
P1	EventType	String	buy	Hardcoded `buy`
P2	ProductId	String	m57500_Red	The unique ID is used in your web store to identify the product. A good rule of thumb is to consider an item unique if it has a unique URL in your online store. The ProductId typically includes the MasterId along with variants such as color or type. For fashion items, this could be rendered as: ProductId = Master ID + color. - Read about how Raptor manage ProductIds here.
P3	ProductName	String	Asics 4 running jacket	The product name.
P5	Subtotal	Decimal	100.00	Subtotal is defined as Number of Items Sold * Unit Price of the Item. The format should be ##.## (i.e. 19.50), without currency labels.
P6	Currency	String	EUR	Currency of the subtotal (e.g. DKK, EUR).
P12	ItemPrice	Decimal	100.00	The actual price of the product. (Sales-price if the item is on sale - otherwise same as the OriginalPrice.) Only used for price drop triggers.
p18	MasterId	String	m57500	The MasterId represents the product identifier without considering sizes, colors, or other variants. - Multiple products of the same type may have different ProductIds, but they share the same MasterId. Read about how Raptor manage ProductIds here.
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	RuId (Raptor E-mail Marketing ID)	String	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id)	String	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Search

Every time a user uses the search bar a searchevent should be fired. This helps the recommendation engine connecting search results with products and content and vice versa.

Parameter	Name	Type	Example	Description
P1	EventType	String	search	Hardcoded `search`
P17	SearchPhrase	String	Running Jacket	The specific phrase that the user has been searching for.
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	RuId (Raptor E-mail Marketing ID)	String	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id)	String	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Contentvisit

When a user visit a content page the contentvisit event should be fired. A Content Page is a type of page that features text, images, videos etc, but does not include products. Examples of content pages are blogs, cases, articles and similar types of content. This enables all recommendations based on content.

Parameter	Name	Type	Example	Description
P1	EventType	String	contentvisit	Hardcoded `contentvisit`
P9	ContentId	String	Blog_2312	The unique ID is used in your web store to identify the content. Read about how Raptor manage ContentIds here.
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).
RuId	RuId (Raptor E-mail Marketing ID)	string	deg@raptor.dk	RUID is a used for tracking and sending users to the e-mail marketing provider. Whether you want to track users using an e-mail or an External E-mail marketing ID that lives in your e-mail marketing provider, is up to you. The identifier must always be set as RUID in the Raptor tracking template, when it becomes available on the site. Read more about user tracking here.
ReaId	ReaId (Raptor Email Address Id)	string	byr6gegxoiku3iux5cnvn64cha	The REAID is an arbitrary ID created by Raptor’s server and represents the user’s email. When a user clicks on a newsletter, the REAID must be included in the URL sent, and subsequently, the same REAID should be set in the tracking for Raptor. The REAID should only be set if you utilize an Email as RUID.

Itemclick

(only required when implementing Website Recommendation)

The itemclick event should be fired every time a user clicks on a Raptor recommendation. If the end user can add products to the basket directly from the Raptor recommendation spot, the itemclick event should also be fired. The itemclick event is used for tracking the performance of the Website Recommendation Modules.

Parameter	Name	Type	Example	Description
P1	Itemclick	String	Itemclick	Hardcoded `itemclick`
P2	ProductId	String	m57500_Red	The unique ID is used in your web store to identify the product. A good rule of thumb is to consider an item unique if it has a unique URL in your online store. The ProductId typically includes the MasterId along with variants such as color or type. For fashion items, this could be rendered as: ProductId = Master ID + color. Read about how Raptor manage ProductIds here.
Module	Module	String	GetSimilarItems	Raptor module name - for example, "GetSelatedItems".
CookieId	CookieId	GUID	6B29FC40-CA47-1067-B31D-00DD010662DA	The CookieId is Used to save the Users tracking history and to personalize recommendations. The value is a Guid (uuid v4).