Setup guide (deprecated on 7th March 2014)Follow

This guide is now deprecated as of 7th March 2014, please see the new guide here:

 

https://whyanalytics.zendesk.com/hc/en-us/articles/201777077

 

 

-------------------------------------------------------------------------------------------------------------

 

 

1. Necessary details before commencing integration

  • Contact your account manager at VisualDNA to get hold of your unique API Key
  • Please note the tag management solution you are using and see the relevant section of our documentation
  • Determine how you may dynamically inject values for the following transactional parameters into VisualDNA pixels. The more parameters you populate the greater the insight you will get.
    • PRODUCT_CATEGORY
    • PRODUCT_NAME
    • PRODUCT_ID
    • PRODUCT_QUANTITY
    • PRODUCT_PRICE - (in GBP, no spaces, no commas separating thousands, just a single decimal point)
    • TOTAL_TRANSACTION_VALUE - (in GBP, no spaces, no commas separating thousands, just a single decimal point)
    • PAYMENT_TYPE - (e.g. "VisaDebit","MasterCardCredit","cash")

 

 

2. Deploy VisualDNA Audience Analytics Tag (AAT) across your site

 

Please see this article on how to complete this first step: 

 

https://whysupport.visualdna.com/hc/en-us/articles/201217013

 

 

3. Product - 'Add to Shopping Basket' pixels

 

Whenever a user inserts a product into his/her basket, the following pixel should be injected into the page:

  • Replace {VISUALDNA_API_KEY} with your API KEY
  • Replace {PRODUCT_ID} with the ID of the product, 
  • Replace {PRODUCT_NAME} with the name of the product,
  • Replace {PRODUCT_CATEGORY} with the category of the product 
  • Replace {PRODUCT_PRICE} in GBP, no spaces, no commas separating thousands, just a single decimal point

 

<img src="//e.visualdna.com/conversion?api_key={VISUALDNA_API_KEY}&id=added_to_basket&product_id={PRODUCT_ID}&product_name={PRODUCT_NAME}&product_category={PRODUCT_CATEGORY}&value={PRODUCT_PRICE}&currency=GBP" width="1" height="1" alt="" />

 

 

4. Product 'Purchased' pixels

 

Whenever a user confirms the purchase of a product, fire the following pixel.

 

If the user has purchased multiple products,  fire an individual pixel for each separate product.

  • Replace {VISUALDNA_API_KEY} with your API KEY
  • Replace {PRODUCT_ID} with the ID of the product, 
  • Replace {PRODUCT_NAME} with the name of the product,
  • Replace {PRODUCT_CATEGORY} with the category of the product 
  • Replace {PRODUCT_QUANTITY} with the quantity of the item purchased
  • Replace {PRODUCT_PRICE} in GBP, no spaces, no commas separating thousands, just a single decimal point

 

<img src="//e.visualdna.com/conversion?api_key={VISUALDNA_API_KEY}&id=purchased&product_id={PRODUCT_ID}&product_name={PRODUCT_NAME}&product_quantity={PRODUCT_QUANTITY}&product_category={PRODUCT_CATEGORY}&value={PRODUCT_PRICE}&currency=GBP" width="1" height="1" alt="" />

 

 

5. Total Transaction Summary Pixel

 

Whenever a user confirms a purchase, fire the following pixel which summarises the whole transaction.

  • Replace {TOTAL_TRANSACTION_VALUE} with the total price paid (including postage and extras) in GBP, no spaces, no decimal points; 
  • {PAYMENT_TYPE} with the type of payment method (e.g. "VisaDebit", "VisaCredit", "MasterCardCredit", "consumerCredit", "cash"...)

 

<img src="//e.visualdna.com/conversion?api_key={VISUALDNA_API_KEY}&id=transaction&value={TOTAL_TRANSACTION_VALUE}&currency=GBP&payment_type={PAYMENT_TYPE}" width="1" height="1" alt="" />

 

 

6. Worked Example

 

Let's say we have a site selling mens clothing with VisualDNA API key of "mensclothes1234".

 

A customer called John browses 10 products, adds 3 products to his basket and purchases 2 of the products with a debit card.

 

The 3 products added to John's basket are:

  • Clavin Klein T-shirt, £36 [product_id = 12345, product_category = "t-shirts"]
  • Armani Jeans, £70 [product_id = 456, product_category = "jeans"]
  • Ralph Lauren Belt, £100 [product_id = 987, product_category = "belts"]

 

The 2 products purchased are:

  • Armani Jeans, £70 [product_id = 456, product_category = "jeans", quantity=1]
  • Ralph Lauren Belt, £100 [product_id = 987, product_category = "belts", quantity=1]

 

Pixels VisualDNA expects to be fired:

 

1/ The AAT should fire on every page John visits

 

2/ The add_to_basket pixel should fire 3 times:  

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id=added_to_basket&product_id=12345&product_name=Clavin%20Klein%20T-shirt&product_category=t-shirts&value=36.00&currency=GBP" width="1" height="1" alt="" />

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id=added_to_basket&product_id=456&product_name=Armani%20Jeans&product_category=jeans&value=70.00&currency=GBP" width="1" height="1" alt="" />

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id=added_to_basket&product_id=987&product_name=Ralph%20Lauren%20Belt&product_category=belts&value=100.00&currency=GBP" width="1" height="1" alt="" />

 

 

3/ The purchase pixel should fire 2 times:

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id= purchased&product_id=456&product_name=Armani%20Jeans&product_category=jeans&product_quantity=1&value=70.00&currency=GBP" width="1" height="1" alt="" />

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id= purchased&product_id=987&product_name=Ralph%20Lauren%20Belt&product_category=belts&product_quantity=1&value=100.00&currency=GBP" width="1" height="1" alt="" />

 

 

4/ The transaction pixel should fire only 1 time:

 

<img src="//e.visualdna.com/conversion?api_key=mensclothes1234&id=transaction&value=170&currency=GBP&payment_type=debit-card" width="1" height="1" alt="" />

 

 

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk