Available events and required parameters

Online shop

Events and required parameters for the online store

Event name	Description	Required parameters
ViewContent (content_name: View)	All pages.	-
ViewContent (content_name: ProductList)	Product listing pages (category and/or search view).	contents (id, name, category, price, weight (products sold by weight), sizes, colours) (for each product on product list)
ViewContent (content_name: ViewProduct)	Pages with specific products (product cards).	contents (id, name, category, price, weight (products sold by weight), sizes, colours)
AddToCart	On the page-event of adding products to the cart (e.g. clicking, displaying landing page after clicking “Add to cart” button).	contents (id, name, category, price, quantity, weight (products sold by weight), sizes, colours)
Purchase	Generated on the purchase confirmation page (last step on a purchase path). The code can be embedded after the payment is completed, on a Thank You Page immediately after returning from the payment provider or on the order confirmation page.	value, value_gross, transaction_id, shipping_cost, contents (id, name, category, price, quantity, weight (products sold by weight), sizes, colours), mvalue (only required for marketplace)

Financial industry

Events and required parameters for the financial industry

Event name	Description	Required parameters
ViewContent (content_name: View)	All pages.	-
ViewContent (content_name: ProductList)	Product listing pages (category and/or search view).	contents (id, name, category, price, loan_period, loan_installment, rrso) (for each product on the product list)
ViewContent (content_name: ViewProduct)	Pages with specific products (product cards).	contents (id, name, category, price, loan_period, loan_installment, rrso)
AddToCart	On the page-event of adding products to the cart (e.g. clicking, displaying landing page after clicking “Add to cart” button).	contents (id, name, category, price, loan_period, loan_installment, rrso)
Purchase	Generated on the purchase confirmation page (last step on a purchase path). The code can be embedded after the payment is completed, on a Thank You Page immediately after returning from the payment provider or on the order confirmation page.	value, value_gross, transaction_id, contents (id, name, category, price, loan_period, loan_installment, rrso)

Automotive industry

Events and required parameters for the automotive industry

Event name	Description	Required parameters
ViewContent (content_name: View)	All pages.	-
ViewContent (content_name: ProductList)	Product listing pages (category and/or search view).	contents (id, name, category, price, brand, condition, fuel_type, gearbox, horsepower, mileage, model, trunk_capacity, type, year_of_manufacture)) (for each product on the product list)
ViewContent (content_name: ViewProduct)	Pages with specific products (product cards).	contents (id, name, category, price, brand, condition, fuel_type, gearbox, horsepower, mileage, model, trunk_capacity, type, year_of_manufacture)
Conversion (content_name: PriceList)	Downloading the price list of a given vehicle.	contents (id, model)
Conversion (content_name: TestDriveTYP)	Registration for a test drive.	contents (id, model, price, brand, type, fuel_type, gearbox, horsepower, year_of_manufacture)
Conversion (content_name: ConfiguratorTYP)	Completion of the vehicle configurator.	contents (id, model, price, brand, type, fuel_type, gearbox, horsepower, year_of_manufacture)

Telecommunications industry

Events and required parameters for the telecommunications industry

Event name	Description	Required parameters
ViewContent (content_name: View)	All pages.	-
ViewContent (content_name: ProductList)	Product listing pages (category and/or search view).	contents (id, name, category, price, brand, product_type) (for each product on the product list)
ViewContent (content_name: ViewProduct)	Pages with specific products (product cards).	contents (id, name, category, price, brand, product_type)
AddToCart	On the page-event of adding products to the cart (e.g. clicking, displaying landing page after clicking “Add to cart” button).	contents (id, name, category, price, brand, product_type, quantity)
Purchase	Generated on the purchase confirmation page (last step on a purchase path). The code can be embedded after the payment is completed, on a Thank You Page immediately after returning from the payment provider or on the order confirmation page.	value, value_gross, transaction_id, contents (id, name, category, price, brand, product_type, quantity)

Available parameters

Parameters are objects passed in JSON format. They provide additional information about the activities of users visiting the site. Parameters should contain those values that match the dictionary.

Parameter name	Data type	Description
content_name	string	Page name, e.g. 'ProductList'
content_type	string	Page type, e.g. 'Site'
transaction_id	string	Unique identifier for the transaction, e.g. 'AB-1234'
value	float	Order value (net amount, tax excluded and delivery costs excluded), e.g. 99.95
value_gross	float	Gross order value (delivery costs excluded), e.g. 118.99
shipping_cost	float	Shipping cost, e.g. 12.50
mvalue	float	Margin on a click (net amount), e.g. 0.55
contents	[]dict	Product dictionary table (List of available contents parameters)
category	string	Name of category, e.g. 'Women's shoes'
discount_code	string	Discount code name or id, e.g. 'DIS-123'
search_string	string	Search phrase, e.g. 'Men's 42 shoes'
name	string	Additional page name or variant
product_type	string	Product/offer variant
src	string	Traffic source 'WP'

Available contents parameters

The items of the contents array are dictionaries with the following parameters::

Nazwa parametru	Typ danych	Opis
id	string	Product ID, e.g. 'AB-123'
category	string	Product category, e.g. 'Sandals'
category_id	string	Unique category ID
colours	[]string	Colours array, e.g, ['blue', 'green']. Used only in fashion. When there's no information about colour this parameter may be omitted or be set to ['onecolour'].
name	string	Product name, e.g. 'Men's sandals ABC'
price	string	Product price, e.g. 99.99
currency	string	Currency, e.g. 'PLN'
quantity	integer	Amount of product, e.g. 5
weight	float	Product weight for products sold by weight, e.g. 0.60
sizes	[]string	Sizes array, e.g. ['L', 'XL']. Used only in fashion. When there's no information about size this parameter may be omitted or be set to ['onesize'].
loan_period	float	Loan period expressed in months, e.g. 24
loan_installment	float	Loan instalment amount
rrso	float	Effective Annual Interest Rate expressed as a percentage, e.g. 7.44
brand	string	Product brand, e.g. 'BMW'
condition	string	Car condition, e.g. 'Nowy', 'Demo', 'Used'
fuel_type	string	Type of fuel, e.g. 'Diesel', 'Petrol + Gas', 'Hybrid', 'Electric'
gearbox	string	Gearbox, e.g. 'Automatic', 'Manual', 'Semiautomatic'
horsepower	integer	Engine power in hp
mileage	integer	Mileage of car
model	string	Model of car, e.g. 'Z4'
trunk_capacity	integer	Luggage compartment volume expressed in liters, e.g. 550
type	string	Type of car, e.g. 'Cabriolet'
year_of_manufacture	string	Year of production, e.g. 2020