Validation criteria reference
Validation criteria reference
client_id
attribution_failed
product_id
click_missing_searchid
addcart_purchase
search_id
product_action
click_missing_clickrank
transaction_revenue
query_expression
product_price
transaction_id
product_name
product_quantity
transaction_tax
transaction_shipping
multiple_user_id
website
product_variant
transaction_currency
product_group
user_id
product_category
product_brand
transaction_affiliation
transaction_coupon
PAL_search_id
This article provides a reference of the validation criteria that the Overview dashboard of the Data Health (platform-ca | platform-eu | platform-au) may display.
|
All events types (except for |
client_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
|
Missing either the |
Ensure that the event passes the |
May break the attribution and consequently the dashboard. |
attribution_failed
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one search event isn’t properly classified as a search, recommendation, or product listing. This classification is done using the field |
Ensure that the event contains one of the following:
|
May break the attribution and consequently the dashboard. |
product_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that the event is passing the |
May break the attribution, and consequently the dashboard as well if the severity level is at 1. |
|
At least one detail event is missing the |
Ensure that the event is passing |
May break the attribution, and consequently the dashboard as well if the severity level is at 1. |
|
At least one cart event is missing the |
Ensure that the event is passing |
N/A |
|
At least one cart event is missing the |
Ensure that the event is passing |
N/A |
|
At least one purchase event is missing the |
Ensure that the event is passing |
N/A |
click_missing_searchid
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that click events are passing the |
May break the attribution and consequently the dashboard. |
addcart_purchase
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event isn’t associated with any |
Ensure that you aren’t losing |
Inaccurate CR and Revenue numbers will appear. |
search_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one search event is missing a |
Ensure that all search events contain the |
May break the attribution and consequently the dashboard. |
product_action
Event types | Cause | Solution | Impact |
---|---|---|---|
|
Product action |
Ensure that product actions ( |
N/A |
|
Product action |
Ensure that product actions ( |
May break the attribution and consequently the dashboard. |
|
Product action |
Ensure that product actions ( |
May break the attribution and consequently the dashboard. |
|
Product action |
Ensure that product actions ( |
May break the attribution and consequently the dashboard. |
|
Product action |
Ensure that product actions ( |
N/A |
|
Product action |
Ensure that product actions ( |
Revenue might show |
click_missing_clickrank
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that click events are passing the position property; |
Click rank metric in the dashboard will show inaccurate data. |
transaction_revenue
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event ( |
Ensure that the purchase event is sending the total revenue |
Revenue might show`0$` if missing for all events, or show inaccurate metrics. |
query_expression
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one search event (search_type = 'Search') is missing a query value (must be a valid string). |
Ensure that the query expression field is a valid string. |
The search dashboard will display blank query expression vizualizations. |
product_price
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one detail event is missing the price parameter, |
Ensure that the event is sending the product price: |
The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show |
|
At least one cart event is missing the price parameter, |
Ensure that the event is sending the product price: |
The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show |
|
At least one cart event is missing the price parameter, |
Ensure that the |
N/A |
|
At least one purchase event is missing the price parameter, |
Ensure that the event is sending the product price: |
The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show |
|
At least one purchase event is missing the price parameter, |
Ensure that the event is sending the product price: |
N/A |
transaction_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that the purchase event is passing the |
Impacts the total revenue and CR. |
product_name
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that the detail, click, cart, and purchase events are passing the product name: |
The name of the product (SKU) will be missing in some of the top 10 product vizzes. |
|
At least one |
Ensure that the detail, click, cart, and purchase events are passing the product name: |
N/A |
|
At least one cart is missing the product name, |
Ensure that the detail, click, cart, and purchase events are passing the product name: |
The name of the product (SKU) will be missing in some of the top 10 product vizzes. |
|
At least one cart event is missing the product name, |
Ensure that the detail, click, cart, and purchase events are passing the product name: |
N/A |
|
At least one purchase event is missing the product name, |
Ensure that the detail, click, cart, and purchase events are passing the product name: |
The name of the product (SKU) will be missing in some of the top 10 product vizzes. |
product_quantity
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one addtoCart ( |
Ensure that the cart or purchase events are passing the product quantity: |
The revenue amounts might show inaccurate data. If all events are missing quantities, the total revenue will show |
|
At least one removeFromCart ( |
Ensure that the cart or purchase events are passing the product quantity: |
N/A |
|
At least one purchase ( |
Ensure that the cart or purchase events are passing the product quantity: |
The revenue numbers might have inaccurate data. If all events are missing quantities, the total revenue will show |
transaction_tax
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event is missing the tax value |
Ensure that the purchase event is sending the tax value |
Inaccurate or a |
transaction_shipping
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event is missing the shipping value |
Ensure that the purchase event is sending the shipping value |
Inaccurate or a |
multiple_user_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one session ( |
Ensure the |
N/A |
|
At least one session (visit_id) has more than one distinct |
Ensure that |
N/A |
|
At least one session (visit_id) has more than one distinct |
Ensure that |
N/A |
|
At least one session (visit_id) has more than one distinct |
Ensure that |
N/A |
|
At least one session (visit_id) has more than one distinct |
Ensure that |
N/A |
|
At least one session (visit_id) has more than one distinct |
Ensure that |
N/A |
website
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one event is missing the parameter |
Ensure that the event is passing |
Will break attribution |
|
At least one |
Ensure that the cart event is passing |
Will break attribution |
|
At least one detail event is missing the parameter |
Ensure that the detail event is passing |
Will break attribution |
|
At least one cart event is missing the parameter |
Ensure that the cart event is passing |
Will break attribution |
|
At least one cart event is missing the parameter |
Ensure that the cart event is passing |
Will break attribution |
|
At least one purchase event is missing the parameter |
Ensure that the purchase event is passing |
Will break attribution |
product_variant
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that the |
N/A |
|
At least one detail event is missing the product variant, |
Ensure that the |
N/A |
|
At least one cart event is missing the product variant, |
Ensure that the cart event is passing the product variant: |
N/A |
|
At least one cart event is missing the product variant, |
Ensure that the cart event is passing the product variant: |
N/A |
|
At least one purchase event is missing the product variant, |
Ensure that the purchase event is passing the product variant: |
N/A |
transaction_currency
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event is missing a currency value ( |
Ensure that the purchase event is passing the currency value |
Inaccurate revenue numbers will appear, with a 1:1 exchange rate. |
product_group
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one |
Ensure that the event is sending the product group: |
This will break the attribution between the add to cart and the |
|
At least one detail event is missing the |
Ensure that the event is sending the product group: |
N/A |
|
At least one cart event is missing the |
Ensure that the event is sending the product group: |
May break the attribution and consequently the dashboard. |
|
At least one cart event is missing the |
Ensure that the event is sending the product group: |
N/A |
|
At least one purchase event is missing the |
Ensure that the event is sending the product group: |
N/A |
user_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
Not much impact since it isn’t currently used for attribution. |
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
N/A |
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
N/A |
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
N/A |
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
N/A |
|
At least one event is missing the user info (anonymous or with a name): |
Ensure that events pass the |
N/A |
product_category
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one event is missing a product category, |
Ensure the |
N/A No impact at the moment. |
|
At least one event is missing a product category, |
Ensure that detail event is passing the product category: |
N/A |
|
At least one event is missing a product category, |
Ensure that cart event is passing the product category: |
N/A |
|
At least one event is missing a product category, |
Ensure that cart event is passing the product category: |
N/A |
|
At least one event is missing a product category, |
Ensure that purchase event is passing the product category: |
N/A |
product_brand
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one event is missing the product brand: |
Ensure that the event is sending the product brand: |
N/A |
|
At least one event is missing the product brand: |
Ensure that the event is sending the product brand: |
N/A |
|
At least one event is missing the product brand: |
Ensure that the event is sending the product brand: |
N/A |
|
At least one event is missing the product brand: |
Ensure that the event is sending the product brand: |
N/A |
|
At least one event is missing the product brand: |
Ensure that the event is sending the product brand: |
N/A |
transaction_affiliation
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event is missing an affiliation ( |
Ensure that the event is sending the affiliate ID |
N/A |
transaction_coupon
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one purchase event is missing a coupon value ( |
Ensure that the event is sending the coupon value |
N/A |
PAL_search_id
Event types | Cause | Solution | Impact |
---|---|---|---|
|
At least one add to cart event from search, recommendations, and CL powered by Coveo is missing a |
Ensure that events from a search result list (or search API call) sends the |
May break the attribution and consequently the dashboard (in case it’s possible to add a product to the cart and bypass the click). |