# Pixel event description
# 1. PageView(Required)
Page browsing events, each page needs to be added
<script>
mkq('track', 'PageView', {
title: "Stylish Eyeglasses Prescription Glasses Online"
});
</script>
# 2. ViewCategory(Required)
When a person view product category page e.g. landing on a category page
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
content_category | Category of the product | snippets | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
<script>
mkq('track', 'ViewCategory', {
content_category: 'snippets',
content_ids: ['goods-id']
});
</script>
# 3. ViewContent(Required)
When a key page is viewed such as a product page, e.g. landing on a product detail page
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | Yes |
contents | A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) associated with the event as well as quantities and prices of the products. id,title,image_link,link,price_amount,sale_price_amount,product_type,google_product_category,quantity are the required fields. | [{'id':'P001','title':'title1','image_link':'https://xx/1.jpg','link':'https://xx/goods1.html','price_amount':16.35,'sale_price_amount':11.25,'product_type':'Electronics>Accessories>Other','google_product_category':'Food & Tobacco>Tobacco> Vaporizers','quantity':3},{'id':'P001','title':'title2','image_link':'https://xx/2.jpg','link':'https://xx/goods2.html','price_amount':6.99,'sale_price_amount':6.00,'product_type':'Cigarettes>E-cigarette>Coils','google_product_category':'Hardware > Coils','quantity':8}] | [object] | Yes |
<script>
mkq('track', 'ViewContent', {
value: 0.10,
currency: 'USD',
content_name: 'Content Name',
content_type: 'product',
content_ids: ['goods-id'],
contents: [
{
'id':'P001',
'title':'title1',
'image_link':'https://xx/1.jpg',
'link':'https://xx/goods1.html',
'price_amount':16.35,
'sale_price_amount':11.25,
'product_type':'Electronics>Accessories>Other',
'google_product_category':'Food & Tobacco>Tobacco> Vaporizers',
'quantity':3
},
{
'id':'P001',
'title':'title2',
'image_link':'https://xx/2.jpg',
'link':'https://xx/goods2.html',
'price_amount':6.99,
'sale_price_amount':6.00,
'product_type':'Cigarettes>E-cigarette>Coils',
'google_product_category':'Hardware > Coils',
'quantity':8
}
]
});
</script>
# 4. Search(Recommended)
When a search is made, e.g. when a product search query is made
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_category | Category of the product | snippets | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
search_string | The string entered by the user for the search | searchString | string | No |
<script>
var searchString = document.getElementsByClassName('search-key')[0].value;
mkq('track', 'Search', {
value: 0.10,
currency: 'USD',
content_category: 'snippets',
content_ids: ['goods-id'],
search_string: searchString
});
</script>
# 5. AddToCart(Required)
When a product is added to the shopping cart, e.g. click on add to cart button
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_type | Either 'product' or 'product_group' based on the content_ids or contents being passed. If the ids being passed in content_ids or contents parameter are ids of products then the value should be 'product'. If product group ids are being passed, then the value should be 'product_group'. | product | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | Yes |
contents | A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) associated with the event as well as quantities and prices of the products. id,title,image_link,link,price_amount,sale_price_amount,product_type,google_product_category,quantity are the required fields. | [{'id':'P001','title':'title1','image_link':'https://xx/1.jpg','link':'https://xx/goods1.html','price_amount':16.35,'sale_price_amount':11.25,'product_type':'Electronics>Accessories>Other','google_product_category':'Food & Tobacco>Tobacco> Vaporizers','quantity':3},{'id':'P001','title':'title2','image_link':'https://xx/2.jpg','link':'https://xx/goods2.html','price_amount':6.99,'sale_price_amount':6.00,'product_type':'Cigarettes>E-cigarette>Coils','google_product_category':'Hardware > Coils','quantity':8}] | [object] | Yes |
<script>
mkq('track', 'AddToCart', {
value: 10.00,
currency: 'USD',
content_name: 'Product Name',
content_type: 'product',
content_ids: ['goods-id'],
contents: [
{
'id':'P001',
'title':'title1',
'image_link':'https://xx/1.jpg',
'link':'https://xx/goods1.html',
'price_amount':16.35,
'sale_price_amount':11.25,
'product_type':'Electronics>Accessories>Other',
'google_product_category':'Food & Tobacco>Tobacco> Vaporizers',
'quantity':3
},
{
'id':'P001',
'title':'title2',
'image_link':'https://xx/2.jpg',
'link':'https://xx/goods2.html',
'price_amount':6.99,
'sale_price_amount':6.00,
'product_type':'Cigarettes>E-cigarette>Coils',
'google_product_category':'Hardware > Coils',
'quantity':8
}
]
});
</script>
# 6. ViewCart(Required)
When a person go to add to cart page e.g. landing on a add to cart page
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_type | Either 'product' or 'product_group' based on the content_ids or contents being passed. If the ids being passed in content_ids or contents parameter are ids of products then the value should be 'product'. If product group ids are being passed, then the value should be 'product_group'.。 | product | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
contents | A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) associated with the event as well as quantities and prices of the products. id,title,image_link,link,price_amount,sale_price_amount,product_type,google_product_category,quantity are the required fields. | [{'id':'P001','title':'title1','image_link':'https://xx/1.jpg','link':'https://xx/goods1.html','price_amount':16.35,'sale_price_amount':11.25,'product_type':'Electronics>Accessories>Other','google_product_category':'Food & Tobacco>Tobacco> Vaporizers','quantity':3},{'id':'P001','title':'title2','image_link':'https://xx/2.jpg','link':'https://xx/goods2.html','price_amount':6.99,'sale_price_amount':6.00,'product_type':'Cigarettes>E-cigarette>Coils','google_product_category':'Hardware > Coils','quantity':8}] | [object] | No |
<script>
mkq('track', 'ViewCart', {
value: 10.00,
currency: 'USD',
content_name: 'Product Name',
content_type: 'product',
content_ids: ['goods-id'],
contents: [
{
'id':'P001',
'title':'title1',
'image_link':'https://xx/1.jpg',
'link':'https://xx/goods1.html',
'price_amount':16.35,
'sale_price_amount':11.25,
'product_type':'Electronics>Accessories>Other',
'google_product_category':'Food & Tobacco>Tobacco> Vaporizers',
'quantity':3
},
{
'id':'P001',
'title':'title2',
'image_link':'https://xx/2.jpg',
'link':'https://xx/goods2.html',
'price_amount':6.99,
'sale_price_amount':6.00,
'product_type':'Cigarettes>E-cigarette>Coils',
'google_product_category':'Hardware > Coils',
'quantity':8
}
]
});
</script>
# 7. AddToWishlist(Recommended)
When a product is added to a wishlist, e.g. click on add to wishlist button
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_category | Category of the product | snippets | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
<script>
mkq('track', 'AddToWishlist', {
value: 0.10,
currency: 'USD',
content_name: 'Product Name',
content_category: 'snippets',
content_ids: ['goods-id'],
});
</script>
# 8. InitiateCheckout(Recommended)
When a person enters the checkout flow prior to completing the checkout flow, e.g. click on checkout button
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_category | Category of the product | snippets | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
num_items | Used with InitiateCheckout event | 1 | int | No |
<script>
mkq('track', 'InitiateCheckout', {
value: 0.10,
currency: 'USD',
content_name: 'Checkout',
content_category: 'snippets',
content_ids: ['goods-id'],
num_ids: 1
});
</script>
# 9. AddPaymentInfo(Recommended)
When a payment information is added in the checkout flow, e.g. click / LP on save billing info button
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_category | Category of the product | snippets | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | No |
<script>
mkq('track', 'AddPaymentInfo', {
value: 0.10,
currency: 'USD',
content_category: 'snippets',
content_ids: ['goods-id']
});
</script>
# 10. Purchase(Required)
When a purchase is made or checkout flow is completed, e.g. landing on thank you/confirmation page
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | Yes |
currency | currency for the value | USD | string | Yes |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_type | Either 'product' or 'product_group' based on the content_ids or contents being passed. If the ids being passed in content_ids or contents parameter are ids of products then the value should be 'product'. If product group ids are being passed, then the value should be 'product_group'.。 | product | string | No |
content_ids | Product ids associated with the event. | ['goods-id'] | [string] | Yes |
contents | A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) associated with the event as well as quantities and prices of the products. id,title,price_amount,sale_price_amount,quantity are the required fields. | [{'id':'P001','title':'title1','price_amount':16.35,'sale_price_amount':11.25,'quantity':3},{'id':'P001','title':'title2','price_amount':6.99,'sale_price_amount':6.00,'quantity':8}] | [object] | Yes |
num_items | Used with InitiateCheckout event | 1 | int | No |
order_id | order id | '1' | string | Yes |
<script>
mkq('track', 'Purchase', {
order_id:'1',
value: 10.00,
currency: 'USD',
content_name: 'Product Name',
content_type: 'product',
content_ids: ['goods-id'],
num_items: 1,
contents: [
{
'id':'P001',
'title':'title1',
'price_amount':16.35,
'sale_price_amount':11.25,
'quantity':3
},
{
'id':'P001',
'title':'title2',
'price_amount':6.99,
'sale_price_amount':6.00,
'quantity':8
}
]
});
</script>
# 11. Lead(Recommended)
When a sign up is completed, e.g. click on pricing, signup for trial
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
content_category | Category of the product | snippets | string | No |
<script>
mkq('track', 'Lead', {
value: 0.10,
currency: 'USD',
content_name: 'Report',
content_category: 'B2B'
});
</script>
# 12. CompleteRegistration(Recommended)
When a registration form is completed, e.g. complete subscription/signup for a service
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | value of a user performing this event to the business | 0.10 | Double | No |
currency | currency for the value | USD | string | No |
content_name | Name of the page/product | Abagail High Neck Cut-out Bodysuit | string | No |
status | status of the registration | 'complete' | string | No |
<script>
mkq('track', 'CompleteRegistration', {
value: 0.10,
currency: 'USD',
content_name: 'Signup',
status: 'complete'
});
</script>
# 13. ReviewProduct(Recommended)
Evaluate the product, and the customer reviews the product after purchase
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | Evaluation instructions | good | string | No |
content_ids | product ID | [goods-id] | [string] | Yes |
<script>
mkq('track', 'ReviewProduct', {
content_ids: ['goods-id'],
value: 'good'
});
</script>
# 14. CancelOrder(Recommended)
Refund, after purchasing the product, the customer chooses to refund due to the quality and size of the product
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | Reason for refund | reason | string | No |
content_ids | product ID | [goods-id] | [string] | Yes |
order_id | order ID | '1' | string | Yes |
<script>
mkq('track', 'CancelOrder', {
order_id: '1',
content_ids: ['goods-id'],
value: 'reason'
});
</script>
# 15. JoinActivity(Recommended)
Participation in promotional activities, customers participate in promotional activities on e-commerce platforms, such as discounts, full discounts, etc
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | The name of the activity | 'name' | string | Yes |
<script>
mkq('track', 'JoinActivity', {
value : 'name',
});
</script>
# 16. CustomerSupport(Recommended)
After-sales service, contact customer service
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | The reason for contacting the customer | 'reason' | string | Yes |
<script>
mkq('track', 'CustomerSupport', {
value : 'reason',
});
</script>
# 17. RemoveCart(Recommended)
Move out of the shopping cart, for items you don't like, you can move out of the shopping cart
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | The amount of the item removed | 10.00 | number | Yes |
currency | The currency unit removed from the commodity | 'USD' | string | Yes |
content_ids | product Id | ['goods-id'] | [string] | Yes |
<script>
mkq('track', 'RemoveCart', {
value: 10.00,
currency: 'USD',
content_ids: ['goods-id'],
});
</script>
# 18. RateProduct(Recommended)
Product rating
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | The score of the item | 10 | number | Yes |
content_ids | product Id | 'goods-id' | string | Yes |
<script>
mkq('track', 'RateProduct', {
value: 10,
content_ids: 'goods-id',
});
</script>
# 19. ShareProduct(Recommended)
Share behavior, click on the page to share, share to other platforms
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | A platform for sharing | 'Facebook' | string | Yes |
content_ids | product Id | 'goods-id' | string | Yes |
<script>
mkq('track', 'ShareProduct', {
value: 'Facebook',
content_ids: 'goods-id',
});
</script>
# 20. ObtainingCoupons(Recommended)
Get a coupon
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | Coupon code | '123code' | string | Yes |
<script>
mkq('track', 'ObtainingCoupons', {
value: '123code'
});
</script>
# 21. RedeemingCoupons(Recommended)
Consumption coupons
Event name | Event description | Example | Data type | Required |
---|---|---|---|---|
value | Coupon code | '123code' | string | Yes |
<script>
mkq('track', 'RedeemingCoupons', {
value: '123code'
});
</script>