The end-point is used for reporting banner product views.

Reporting Recommendation Impressions

event

event_apikey	

The unique identifier for your KMC Recommendations Banner, eg. 12345-abcde. This is available in the banner configuration metadata as recsKey. If you are not using banners configured within the KMC, please specify a unique identifier for the banner which will be used to distinguish one banner from another.

event_list_id

The name of the banner, eg. New Arrivals. This is available in the banner configuration metadata as title

event_list_name

The logic type of the banner, eg. NEWEST_ARRIVALS. This is available in the banner configuration metadata as logic.

event_list_logic

This can be used to specify additional information about the event, which will eventually be made available within the KMC. We recommend you specify the type of page, eg. HOME. This is available in the banner configuration metadata as pageType.

event_tags

The json object that holds the user related information such as ip_address. 

user_profile

Iterate all of the products in the banner and populate the item data for each.

items

The full ID of the product. eg. 12345-54321. This will match the unique value used in your data sync process with Klevu. For compound products consisting of a child/variant and a parent, this is usually parentId-childId.

item_id

The Parent ID of the product. eg. 12345. For compound products consisting of a child/variant and a parent, please specify the ID of the parent. For simple products, please re-use the same value as item_id

item_group_id

The Child ID of the product.eg. 54321. Please specify the ID of the child/variant product. For simple products, please re-use the same value as item_id.

item_variant_id

item_name

The final selling price of the product, for example 123.45

price

The currency of the above price, eg. USD.

currency

The brand of the product, for example "Nike" or "Acme".

item_brand

The category the item belongs to. For nested categories, use the ; character to separate the hierarchy, and for multiple categories use a double ;;. For example, for 'Mens > Shoes > Trainers' and 'Sale' you would specify: Mens;Shoes;Trainers;;Sale.

item_category

The order of the product in the listing, starting from 1

index

The end-point is used for reporting banner product clicks.

Reporting Banner Product Clicks

Provide specific information about the one product which was clicked within your banner.

Category Events

Recommendations Events

Purchase Data