Skip to main content

Enable performance measurement for Aqurate Personalize

Learn what needs to be done in order to accurately measure the performance of the product recommendations on your website.

⏳ Duration: 30 minutes
👩🏻‍💻Complexity: high

📌 Prerequisites: Connect the Aqurate Pixel

🤖 How it works

To correctly "tag" the widgets containing recommendations, you must either:

  • ⚓ Anchors option - add specific data attributes to the HTML elements within which the product recommendation widgets are rendered

  • 🔗 UTM option - add specific UTMs on all links pointing towards recommended products

Once the widget is tagged correctly, the Aqurate Pixel will track all interactions with the widget, including clicks and purchases. This will provide you with granular insights into the performance of your Aqurate Personalize recommendations.

✉️ Please let our team know if you are choosing the ⚓ Anchors option or the 🔗 UTM option by emailing at [email protected].

⚓ Anchors option

Naming convention

The widgets containing Aqurate recommendations need to have HTML anchor classes (the <a> elements) added as per the naming convention below.

The format is: .aqurate-personalize

👆 Please make sure the all <a> elements (anchors) in the widget have the correct anchor classes. This includes pictures, product display names, buttons, etc.

Detailed measurement

In order to get a detailed view of which widgets have the most impact on your visitors journey, you can add the following classes to the anchors in the widgets:

Widget location

The format is: .aqurate-location-[location]

Valid entries for locations

Website location

Value for the location parameter

Product detail page

pdp

Home page

homepage

Category page

category

Checkout page

checkout

Cart page

cart

Cart pop-up

cart-popup

Other pop-up

pop

Other page

other

Valid examples:

.aqurate-location-pdp
.aqurate-location-cart-popup

Widget content

The format is .aqurate-endpoint-[endpoint]

The endpoint maps to the endpoint name in our API docs, while the "/" is converted to a "-".

Valid examples:

.aqurate-endpoint-recs-item-substitutes
.aqurate-endpoint-recs-item-cross-sell
.aqurate-endpoint-recs-user

Widget actions

These should be added to any action elements inside the widget (buttons, anchors, etc.).

This is the format: .aqurate-action-[action]

Valid entries for actions

Action

Value for the action parameter

Add to cart

add-to-cart

Add bundle to cart

bundle-add-to-cart

Add to wishlist

add-to-wishlist

Valid examples:

.aqurate-action-add-to-cart
.aqurate-action-bundle-add-to-cart
.aqurate-action-add-to-wishlist

Wrapping it all up

If you have set everything up correctly, each anchor element of the widget should look something like this:

.aqurate-personalize
.aqurate-location-pdp
.aqurate-endpoint-recs-user

Where applicable, each element that has an action should look something like this:

.aqurate-personalize
.aqurate-location-pdp
.aqurate-endpoint-recs-user
.aqurate-action-add-to-cart

🔗 UTM option

Naming convention

The widgets containing Aqurate recommendations need to have all links pointing towards product recommendations contain UTMs as per the naming convention below.

The format is:

https://www.yourstore.com/product?aqurate_personalize=true

👆 Please make sure the all links in the widget have the correct UTMs. This includes pictures, product display names, buttons, etc.

Detailed measurement

In order to get a detailed view of which widgets have the most impact on your visitors journey, you can add the UTMs on all links pointing from the recommendations widget:

Widget location

The format is:

https://www.yourstore.com/product?aqurate_location=[location]

Valid entries for location

Website location

Value for the location parameter

Product detail page

pdp

Home page

homepage

Category page

category

Checkout page

checkout

Cart page

cart

Cart pop-up

cart-popup

Other pop-up

pop

Other page

other

Valid examples:

https://www.yourstore.com/product?aqurate_location=pdp
https://www.yourstore.com/product?aqurate_location=homepage

Widget content

This is the format:

https://www.yourstore.com/product?aqurate_endpoint=[endpoint]

The endpoint maps to the endpoint name in our API docs, while the "/" is converted to a "-".

Valid examples:

https://www.yourstore.com/product?aqurate_endpoint=recs-item-substitutes
https://www.yourstore.com/product?aqurate_endpoint=recs-item-cross-sell
https://www.yourstore.com/product?aqurate_endpoint=recs-user

Widget actions

The format is:

https://www.yourstore.com/product?aqurate_action=[action]

Valid entries for actions

Action

Value for the action parameter

Add to cart

add-to-cart

Add bundle to cart

bundle-add-to-cart

Add to wishlist

add-to-wishlist

Valid examples:

https://www.yourstore.com/product?aqurate_action=add-to-cart
https://www.yourstore.com/product?aqurate_action=bundle-add-to-cart
https://www.yourstore.com/product?aqurate_action=add-to-wishlist

Wrapping it all up

If you have set everything up correctly, each link on the widget should look something like this:

https://www.yourstore.com/product?aqurate_personalize=true&aqurate_location=pdp&aqurate_endpoint=recs-item-substitutes

Where applicable, each link that has an action should look something like this:

https://www.yourstore.com/product?aqurate_personalize=true&aqurate_location=pdp&aqurate_endpoint=recs-item-substitutes&aqurate_action=add-to-cart

🧪 Testing the results

After you finished configuring your website for measurement, data will start getting populated in Aqurate. Please allow for up to 24 hours for the measurements to shop up.

Did this answer your question?