Available events and required parameters
Event code template
<script>
wph('track', 'event_name', {
content_name: 'content_name', other_parameters });
</script>
Values of event_name, content_name, and other_parameters are detailed in the tables below.
Online shop
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
AddToCart |
None | currency,contents: [{id, name, category, price, quantity}] | Adding a product to the cart |
Purchase |
None | transaction_id, value, value_gross, shipping_cost, currency,contents: [{id, name, category, price, quantity, weight},...,{id, name, category, price, quantity, weight}] | Order confirmation page (post-transaction) |
ViewContent |
ProductList |
currency,contents: [{id, name, category, price},...,{id, name, category, price}] | Product listing page |
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{id, name, category, price}] | Product page |
ViewContent |
AddToWishList |
currency,contents: [{id, name, category, price}] | Adding a product to the wishlist |
ViewContent |
RemoveFromWishList |
currency,contents: [{id, name, category, price}] | Removing a product from the wishlist |
Conversion |
WishList |
currency,contents: [{id, name, category, price}] | Adding the wishlisted product to the cart |
Other events
Helper events - ViewContent
The purpose of helper events is to gather statistics at the initial stage of the conversion path. It is recommended that the script be executed at the first step of the given path.
ViewContent
is the event_name.
Each helper event is mapped to a corresponding conversion event that should be triggered upon completing the path.
Code/industry | content_name | other_parameters | Location/rule | Corresponding conversion |
---|---|---|---|---|
general | Game |
None | None | Game page |
general | InputForm |
None | Lead |
Interaction with a form |
general | LandingPage |
None | None | Landing page for a user acquired through advertising campaign |
general | Login |
None | LoginEnd |
User login form page |
general | Newsletter |
None | NewsletterTYP |
Interaction with a newsletter |
general | Register |
None | RegisterEnd |
User registration form page |
general | View |
None | None | All pages |
automotive | Configurator |
currency,contents: [{id, name, category, price}] | ConfiguratorTYP |
Page with a vehicle configurator |
automotive | PriceList |
currency,contents: [{id, name, category, price}] | PriceListEnd |
Page with a downloadable price list |
automotive | TestDrive |
currency,contents: [{id, name, category, price}] | TestDriveEnd |
Page with a test drive booking form |
financial | InsuranceQuote |
currency,contents: [{id, name, category, price}] | InsuranceQuoteTYP |
Starting the insurance form |
financial | Verification |
currency,contents: [{id, name, category, price}] | PositiveVerification or NegativeVerification |
Starting the offer form |
Conversion events ‑ Conversion
The purpose of conversion events is to collect statistics for completed conversion paths. The script should be executed on a confirmation/thank-you page for the given action.
Conversion
is the event_name.
A conversion event should be preceded by a helper event that triggers at the first stage of the path.
Code/industry | content_name | other_parameters | Location/rule |
---|---|---|---|
general | AppDownload |
None | Mobile app download |
general | Download |
None | Downloading an attachment from the page |
general | Lead |
None | Form submission confirmation page |
general | LoginEnd |
None | Page after user logs in |
general | NewsletterTYP |
None | Newsletter subscription confirmation page |
general | RegisterEnd |
None | Page after user registers |
automotive | ConfiguratorTYP |
currency,contents: [{id, name, category, price}] | Vehicle configurator completion summary page |
automotive | PriceListEnd |
currency,contents: [{id, name, category, price}] | Downloading the price list |
automotive | TestDriveEnd |
currency,contents: [{id, name, category, price}] | Test drive booking confirmation page |
financial | InsuranceQuoteTYP |
currency,contents: [{id, name, category, price}] | Insurance quote summary page |
financial | NegativeVerification |
currency,contents: [{id, name, category, price}] | Negative verification summary page |
financial | PositiveVerification |
currency,contents: [{id, name, category, price}] | Positive verification summary page |
Parameters list
The parameters provide additional information about a user's activity on the website.
The table includes all currently processed parameters.
Parameter name | Data type | Description |
---|---|---|
category | string |
Category name, e.g.'Women's shoes' |
contents | object[] |
Array of objects with parameters (List of available contents parameters) |
content_name | string |
Page name, e.g. 'ProductList' |
content_type | string |
Page type, e.g. 'Site' |
currency | string |
Currency, e.g. 'EUR' |
discount_code | string |
Discount code, e.g. 'DIS-123' |
mvalue | number |
Margin for a given click (net amount), e.g. 0.55 |
name | string |
Additional page name or variant |
product_type | string |
Product/offer variant |
search_string | string |
Search query, e.g. 'Men's shoes 42' |
shipping_cost | number |
Shipping cost, e.g. 12.50 |
src | string |
Traffic source 'WP' |
transaction_id | string |
Unique transaction identifier, e.g. 'AB-1234' |
value | number |
Order value (net amount, excluding tax and shipping costs), e.g. 100.00 |
value_gross | number |
Order value (gross amount, excluding shipping costs), e.g. 123.00 |
List of available contents parameters
contents
is an array of objects that contain the selected parameters from the table below:
Parameter name | Data type | Description |
---|---|---|
adult | number |
Number of adults in the reservation, e.g. 2 |
arrival_city | string |
Arrival city e.g. 'Warsaw' |
arrival_date | string |
Arrival date, e.g. '2025-10-24' |
brand | string |
Product brand, e.g. 'BMW' |
category | string |
Product category, e.g. 'Sandals' |
category_id | string |
Unique category identifier |
child | number |
Number of children in the reservation, e.g. 1 |
colours | string[] |
Array of product colors, e.g.['blue', 'green'] or e.g. ['onecolour'] . |
condition | string |
Car condition, e.g. 'New' , 'Demo' , 'Used' |
departure_city | string |
Departure city, e.g. 'Warsaw' |
hotel_star | number |
Hotel star rating, e.g. 3 |
departure_date | string |
Departure date, e.g. '2025-10-17' |
destination_city | string |
Destination: city, e.g. 'Antalya' |
destination_country | string |
Destination: country, e.g. 'Turkey' |
destination_region | string |
Destination: region, e.g. 'Turkish Riviera' |
fuel_type | string |
Fuel type, e.g. 'Diesel' , 'Gasoline + Gas' , 'Hybrid' , 'Electric' |
gearbox | string |
Gearbox type, e.g. 'Automatic' , 'Manual' , 'Semi-Automatic' |
horsepower | number |
Engine power in horsepower |
id | string |
Product identifier, e.g. 'AB-123' |
loan_installment | number |
Loan installment amount |
loan_period | number |
Loan period in months, e.g. 24 |
mileage | number |
Car mileage |
model | string |
Car model, e.g. 'Z4' |
name | string |
Product name, e.g. 'Men's Sandals ABC' |
offer_rating | number |
Offer rating, e.g. 8.6 |
price | number |
Product price, e.g. 99.99 |
quantity | number |
Product quantity, e.g. 5 |
room_price | number |
Room price, e.g. 3889.00 |
rrso | number |
Annual Percentage Rate (APR) in percentage, e.g. 7.44 |
sizes | string[] |
Array of product sizes, e.g. ['L', 'XL'] or e.g. ['onesize'] . |
standard_meals | string |
Meal plan, e.g. 'All Inclusive' |
tour_operator | string |
Tour operator, e.g. 'Itaka' |
trip_duration | number |
Trip duration in days, e.g. 7 |
trunk_capacity | number |
Trunk capacity in liters, e.g. 550 |
type | string |
Car type, e.g. 'Convertible' |
weight | number |
Product weight for items sold by weight (in kilograms), e.g. 0.60 |
year_of_manufacture | string |
Year of manufacture, e.g. '2020' |
Telecommunications industry
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
AddToCart |
None | currency,contents: [{id, name, category, price, quantity}] | Adding a product or offer to the cart |
Purchase |
None | transaction_id, value, value_gross, shipping_cost, currency,contents: [{id, name, category, price, quantity},...,{id, name, category, price, quantity}] | Order confirmation page (post-transaction) |
ViewContent |
ProductList |
currency,contents: [{id, name, category, price},...,{id, name, category, price}] | Product and offer listings |
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{id, name, category, price}] | Product and offer pages |
ViewContent |
InputForm |
None | Interaction with a form |
Conversion |
Lead |
None | Form submission confirmation page |
Additionally, it is recommended to implement selected other events that are marked as general.
Automotive industry
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
ViewContent |
Configurator |
currency,contents: [{id, name, category, price}] | Page with a vehicle configurator |
Conversion |
ConfiguratorTYP |
currency,contents: [{id, name, category, price}] | Vehicle configurator completion summary page |
ViewContent |
InputForm |
None | Interaction with a form |
Conversion |
Lead |
None | Form submission confirmation page |
ViewContent |
PriceList |
currency,contents: [{id, name, category, price}] | Page with a downloadable price list |
Conversion |
PriceListEnd |
currency,contents: [{id, name, category, price}] | Downloading the price list |
ViewContent |
TestDrive |
currency,contents: [{id, name, category, price}] | Page with a test drive booking form |
Conversion |
TestDriveEnd |
currency,contents: [{id, name, category, price}] | Test drive booking confirmation page |
ViewContent |
ProductList |
currency,contents: [{id, name, category, price},...,{id, name, category, price}] | Product and offer listings |
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{id, name, category, price}] | Product and offer pages |
Additionally, it is recommended to implement selected other events that are marked as general.
Financial industry
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{id, name, category, price}] | Product and offer pages |
ViewContent |
InputForm |
None | Interaction with a form |
Conversion |
Lead |
None | Form submission confirmation page |
ViewContent |
InsuranceQuote |
currency,contents: [{id, name, category, price}] | Starting the insurance form |
Conversion |
InsuranceQuoteTYP |
currency,contents: [{id, name, category, price}] | Insurance quote summary page |
ViewContent |
Verification |
currency,contents: [{id, name, category, price}] | Starting the offer form |
Conversion |
NegativeVerification |
currency,contents: [{id, name, category, price}] | Negative verification summary page |
Conversion |
PositiveVerification |
currency,contents: [{id, name, category, price}] | Positive verification summary page |
Additionally, it is recommended to implement selected other events that are marked as general.
Tourism industry
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
AddToCart |
None | currency,contents: [{name, id, category, price, destination_country, destination_region, destination_city, adult, child, departure_city, arrival_city, offer_rating, tour_operator, standard_meals, room_price, departure_date, arrival_date, trip_duration, hotel_star}] | Adding a product or offer to the cart |
Purchase |
None | transaction_id, value, value_gross, shipping_cost, mvalue, currency,contents: [{name, product_id, category, price, destination_country, destination_region, destination_city, adult, child, departure_city, arrival_city, offer_rating, tour_operator, standard_meals, room_price, departure_date, arrival_date, trip_duration, hotel_star}] | Order confirmation page (post‑transaction) |
ViewContent |
ProductList |
contents: [{name, id, category, price, destination_country, destination_region, destination_city, adult, child, departure_city, arrival_city, offer_rating, tour_operator, standard_meals, room_price, departure_date, arrival_date, trip_duration, hotel_star}] | Product and offer listings |
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{name, id, category, price, destination_country, destination_region, destination_city, adult, child, departure_city, arrival_city, offer_rating, tour_operator, standard_meals, room_price, departure_date, arrival_date, trip_duration, hotel_star}] | Product and offer pages |
Additionally, it is recommended to implement selected other events that are marked as general.
Real Estate industry
event_name | content_name | other_parameters | Location/rule |
---|---|---|---|
ViewContent |
AddToWishList |
currency,contents: [{id, name, category, price}] | Adding a product/offer to the wishlist |
ViewContent |
RemoveFromWishList |
currency,contents: [{id, name, category, price}] | Removing a product/offer to the wishlist |
Conversion |
WishList |
currency,contents: [{id, name, category, price}] | Adding to basket or sending request to wishlist's product/offer |
ViewContent |
InputForm |
currency,contents: [{id: 'offer_ID', name: 'offer_name', selected_city: 'city', category: 'category', market_type: 'market_type', developer: 'corp_name', area: 'flat_area', number_of_rooms: rooms_nmbr, balcony: 'balcony_size', floor: 'floor_nmbr', price: price}] | Form page or interaction with a form (prefer) |
Conversion |
Lead |
currency,contents: [{id: 'offer_ID', name: 'offer_name', selected_city: 'city', category: 'category', market_type: 'market_type', developer: 'corp_name', area: 'flat_area', number_of_rooms: rooms_nmbr, balcony: 'balcony_size', floor: 'floor_nmbr', price: price}] | Confirmation page or modal form submission confirmation |
ViewContent |
Login |
None | Log in page |
Conversion |
LoginEnd |
None | Log in confirmation page or modal log in confitmation |
ViewContent |
Newsletter |
None | Newsletter or other marketing form page/interaction with form |
Conversion |
NewsletterTYP |
None | Confirmation page or modal form submission confirmation |
ViewContent |
ProductList |
currency,contents: [{id, name, category, price}] | Offers listings |
ViewContent |
View |
None | All pages |
ViewContent |
ViewProduct |
currency,contents: [{id, name, category, price}] | Offer pages |
Additionally, it is recommended to implement selected other events that are marked as general.