Validation criteria reference

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 search) listed in this article are action types. For more information, see Action types reference.

client_id

Event types Cause Solution Impact

Search

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

detail

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

click

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

addToCart

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

removeFromCart

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

purchase

Missing either the cid (Collect events), or the clientId (UA events).

Ensure that the event passes the cid value or the clientId value.

May break the attribution and consequently the dashboard.

attribution_failed

Event types Cause Solution Impact

Search

At least one search event isn’t properly classified as a search, recommendation, or product listing. This classification is done using the field originlLevel1.

Ensure that the event contains one of the following:

  • an originLevel1 containing either "SEARCH", "LISTING" or "RECS" (all should be uppercase) anywhere in the string.

  • a recommendationInterfaceLoad or recommendationOpen actionCause.

  • a customData object with a recommendation attribute.

May break the attribution and consequently the dashboard.

product_id

Event types Cause Solution Impact

click

At least one click event is missing the prNid parameter (Collect events) or "customData":"contentIDvalue" (UA events).

Ensure that the event is passing the prNid:"value" (Collect events), or that the "customData":"contentIDvalue":"value" is used.

May break the attribution, and consequently the dashboard as well if the severity level is at 1.

detail

At least one detail event is missing the prNid parameter (Collect events) or "customData":"contentIDvalue" (UA events).

Ensure that the event is passing prNid:"value" (Collect events), or the "customData":"contentIDvalue":"value" is used.

May break the attribution, and consequently the dashboard as well if the severity level is at 1.

addToCart

At least one cart event is missing the prNid parameter (Collect events) or "customData":"contentIDvalue" (UA events).

Ensure that the event is passing prNid:"value" (Collect events), or the "customData":"contentIDvalue":"value" is used.

N/A

removeFromCart

At least one cart event is missing the prNid parameter (Collect events) or "customData":"contentIDvalue" (UA events).

Ensure that the event is passing prNid:"value" (Collect events), or the "customData":"contentIDvalue":"value" is used.

N/A

purchase

At least one purchase event is missing the prNid parameter (Collect events) or "customData":"contentIDvalue" (UA events).

Ensure that the event is passing prNid:"value" (Collect events), or the "customData":"contentIDvalue":"value" is used.

N/A

click_missing_searchid

Event types Cause Solution Impact

click

At least one click event is missing the "searchUid" value, regardless of whether Collect events or UA events are used.

Ensure that click events are passing the "searchUid" parameter.

May break the attribution and consequently the dashboard.

addcart_purchase

Event types Cause Solution Impact

purchase

At least one purchase event isn’t associated with any add_to_cart events (using Client ID as the link).

Ensure that you aren’t losing add_to_cart events and that they’re sent properly. Another possibility could be that your client_id isn’t stored properly and it’s reset for each request.

Inaccurate CR and Revenue numbers will appear.

search_id

Event types Cause Solution Impact

search

At least one search event is missing a "searchUid" value.

Ensure that all search events contain the "searchUid" parameter.

May break the attribution and consequently the dashboard.

product_action

Event types Cause Solution Impact

search

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

N/A

click

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

May break the attribution and consequently the dashboard.

detail

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

May break the attribution and consequently the dashboard.

addToCart

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

May break the attribution and consequently the dashboard.

removeFromCart

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

N/A

purchase

Product action "pa = value" must be one of the following : add, remove, detail, click, or purchase impression. Only applicable for Collect events.

Ensure that product actions (pa in Collect events) is either add, remove, detail, click, or purchase.

Revenue might show 0$ if missing for all events, or show inaccurate metrics.

click_missing_clickrank

Event types Cause Solution Impact

click

At least one click event is missing a "prNps" (Collect events) or "documentPosition" (UA events).

Ensure that click events are passing the position property; "prNps" (Collect events) or "documentPosition" (UA events).

Click rank metric in the dashboard will show inaccurate data.

transaction_revenue

Event types Cause Solution Impact

purchase

At least one purchase event (pa = 'purchase') is missing total revenue "tr":value. Only applicable for Collect events.

Ensure that the purchase event is sending the total revenue "tr":value.

Revenue might show`0$` if missing for all events, or show inaccurate metrics.

query_expression

Event types Cause Solution Impact

search

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

detail

At least one detail event is missing the price parameter, "prNpr" (Collect events), or "customData":"price": "value" (UA events).

Ensure that the event is sending the product price: "prNpr" (Collect events) or "customData":"price": "value" (UA events).

The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show 0$.

addToCart

At least one cart event is missing the price parameter, "prNpr" (Collect events), or "customData":"price": "value" (UA events).

Ensure that the event is sending the product price: "prNpr" (Collect events) or "customData":"price": "value" (UA events).

The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show 0$.

removeFromCart

At least one cart event is missing the price parameter, "prNpr" (Collect events), or "customData":"price": "value" (UA events).

Ensure that the dr property is set properly.

N/A

purchase

At least one purchase event is missing the price parameter, "prNpr" (Collect events), or "customData":"price": "value" (UA events).

Ensure that the event is sending the product price: "prNpr" (Collect events) or "customData":"price": "value" (UA events).

The revenue numbers might have inaccurate data. If all events are missing prices, the total revenue will show 0$.

click

At least one purchase event is missing the price parameter, "prNpr" (Collect events), or "customData":"price": "value" (UA events).

Ensure that the event is sending the product price: "prNpr" (Collect events) or "customData":"price": "value" (UA events).

N/A

transaction_id

Event types Cause Solution Impact

purchase

At least one purchase event (pa = purchase) is missing the transaction_id, "ti":"value" (Collect events) or "customData":"transactionid":"value".

Ensure that the purchase event is passing the "ti" parameter (Collect events) or "customData":"transactionid" parameter (UA events).

Impacts the total revenue and CR.

product_name

Event types Cause Solution Impact

Click

At least one click event is missing the product name, "prNnm" (Collect events) or "customData":"name" (UA events).

Ensure that the detail, click, cart, and purchase events are passing the product name: "prNnm" (Collect events) or "customData":"name" (UA events).

The name of the product (SKU) will be missing in some of the top 10 product vizzes.

detail

At least one click event is missing the product name, "prNnm" (Collect events) or "customData":"name" (UA events).

Ensure that the detail, click, cart, and purchase events are passing the product name: "prNnm" (Collect events) or "customData":"name" (UA events).

N/A

addToCart

At least one cart is missing the product name, "prNnm" (Collect events) or "customData":"name" (UA events).

Ensure that the detail, click, cart, and purchase events are passing the product name: "prNnm" (Collect events) or "customData":"name" (UA events).

The name of the product (SKU) will be missing in some of the top 10 product vizzes.

removeFromCart

At least one cart event is missing the product name, "prNnm" (Collect events) or "customData":"name" (UA events).

Ensure that the detail, click, cart, and purchase events are passing the product name: "prNnm" (Collect events) or "customData":"name" (UA events).

N/A

purchase

At least one purchase event is missing the product name, "prNnm" (Collect events) or "customData":"name" (UA events).

Ensure that the detail, click, cart, and purchase events are passing the product name: "prNnm" (Collect events) or "customData":"name" (UA events).

The name of the product (SKU) will be missing in some of the top 10 product vizzes.

product_quantity

Event types Cause Solution Impact

addToCart

At least one addtoCart (pa = add) event is missing a quantity, "pr1qt" ID (Collect events), or "customData":"quantity" (UA events).

Ensure that the cart or purchase events are passing the product quantity: "prNqt" (Collect events) or "customData":"quantity" (UA events).

The revenue amounts might show inaccurate data. If all events are missing quantities, the total revenue will show 0$.

removeFromCart

At least one removeFromCart (pa = remove) event is missing a quantity, "pr1qt" (Collect events) or "customData":"quantity" (UA events).

Ensure that the cart or purchase events are passing the product quantity: "prNqt" (Collect events) or "customData":"quantity" (UA events).

N/A

purchase

At least one purchase (pa = purchase) event is missing a quantity, "pr1qt" (Collect events) or "customData":"quantity" (UA events).

Ensure that the cart or purchase events are passing the product quantity: "prNqt" (Collect events) or "customData":"quantity" (UA events).

The revenue numbers might have inaccurate data. If all events are missing quantities, the total revenue will show 0$.

transaction_tax

Event types Cause Solution Impact

purchase

At least one purchase event is missing the tax value "tt". Only applicable for Collect events.

Ensure that the purchase event is sending the tax value "tt".

Inaccurate or a 0$ value of tax will appear.

transaction_shipping

Event types Cause Solution Impact

purchase

At least one purchase event is missing the shipping value "ts". Only applicable for Collect events.

Ensure that the purchase event is sending the shipping value "ts".

Inaccurate or a 0$ value of shipping costs will appear.

multiple_user_id

Event types Cause Solution Impact

search

At least one session (visit_id) has more than one distinct user_id.

Ensure the user_id is consistent across a session.

N/A

click

At least one session (visit_id) has more than one distinct user_id.

Ensure that user_id is consistent across a session.

N/A

detail

At least one session (visit_id) has more than one distinct user_id.

Ensure that user_id is consistent across a session.

N/A

addToCart

At least one session (visit_id) has more than one distinct user_id.

Ensure that user_id is consistent across a session.

N/A

removeFromCart

At least one session (visit_id) has more than one distinct user_id.

Ensure that user_id is consistent across a session.

N/A

purchase

At least one session (visit_id) has more than one distinct user_id.

Ensure that user_id is consistent across a session.

N/A

website

Event types Cause Solution Impact

search

At least one event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the event is passing "context_website" (Collect events), or "customData":"context_website":"value" (UA events).

Will break attribution

click

At least one click event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the cart event is passing "context_website" (Collect events), or "customData":"siteName":"context_website" (UA events).

Will break attribution

detail

At least one detail event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the detail event is passing "context_website" (Collect events), or "customData":"context_website":"value" (UA events).

Will break attribution

addToCart

At least one cart event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the cart event is passing "context_website" (Collect events), or "customData":"context_website":"value" (UA events).

Will break attribution

removeFromCart

At least one cart event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the cart event is passing "context_website" (Collect events), or "customData":"context_website":"value" (UA events).

Will break attribution

purchase

At least one purchase event is missing the parameter "context_website" (Collect events), or "customData":"context_website":"value" (UA events)

Ensure that the purchase event is passing "context_website" (Collect events), or "customData":"context_website":"value" (UA events).

Will break attribution

product_variant

Event types Cause Solution Impact

click

At least one click event is missing the product variant, "prNva" (Collect events), or "customData":"variant" (UA events).

Ensure that the "Click" event is passing the product variant: "prNva" (Collect events), or "customData":"variant" (UA events).

N/A

detail

At least one detail event is missing the product variant, "prNva" (Collect events), or "customData":"variant" (UA events).

Ensure that the "detail" event is passing the product variant: "prNva" (Collect events), or "customData":"variant" (UA events).

N/A

addToCart

At least one cart event is missing the product variant, "prNva" (Collect events), or "customData":"variant" (UA events).

Ensure that the cart event is passing the product variant: "prNva" (Collect events), or "customData":"variant" (UA events).

N/A

removeFromCart

At least one cart event is missing the product variant, "prNva" (Collect events), or "customData":"variant" (UA events).

Ensure that the cart event is passing the product variant: "prNva" (Collect events), or "customData":"variant" (UA events).

N/A

purchase

At least one purchase event is missing the product variant, "prNva" (Collect events), or "customData":"variant" (UA events).

Ensure that the purchase event is passing the product variant: "prNva" (Collect events), or "customData":"variant" (UA events).

N/A

transaction_currency

Event types Cause Solution Impact

purchase

At least one purchase event is missing a currency value ("cu"). Only applicable for Collect events. In this case, a 1:1 exchange rate will be performed.

Ensure that the purchase event is passing the currency value "cu".

Inaccurate revenue numbers will appear, with a 1:1 exchange rate.

product_group

Event types Cause Solution Impact

click

At least one click event is missing the "prNgroup" (Collect events) or the "customData":"group" (UA events).

Ensure that the event is sending the product group: "prNgroup" (Collect events) or "customData":"group" (UA events).

This will break the attribution between the add to cart and the click event.

detail

At least one detail event is missing the "prNgroup" (Collect events) or the "customData":"group" (UA events).

Ensure that the event is sending the product group: "prNgroup" (Collect events) or "customData":"group" (UA events).

N/A

addToCart

At least one cart event is missing the "prNgroup" (Collect events) or the "customData":"group" (UA events).

Ensure that the event is sending the product group: "prNgroup" (Collect events) or "customData":"group" (UA events).

May break the attribution and consequently the dashboard.

removeFromCart

At least one cart event is missing the "prNgroup" (Collect events) or the "customData":"group" (UA events).

Ensure that the event is sending the product group: "prNgroup" (Collect events) or "customData":"group" (UA events).

N/A

purchase

At least one purchase event is missing the "prNgroup" (Collect events) or the "customData":"group" (UA events).

Ensure that the event is sending the product group: "prNgroup" (Collect events) or "customData":"group" (UA events).

N/A

user_id

Event types Cause Solution Impact

search

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events).

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

Not much impact since it isn’t currently used for attribution.

click

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events).

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

N/A

detail

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events).

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

N/A

addToCart

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events).

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

N/A

removeFromCart

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events).

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

N/A

purchase

At least one event is missing the user info (anonymous or with a name): "uid" (Collect events), or "userDisplayName" (UA events)

Ensure that events pass the user_id value. Consult with a developer to validate why the search hub doesn’t pass the user_id value.

N/A

product_category

Event types Cause Solution Impact

click

At least one event is missing a product category, "prNca" (Collect events), or "customData":"category" (UA events).

Ensure the click event is passing the product category: "prNca" (Collect events) or "customData":"category" (UA events).

N/A

No impact at the moment.

detail

At least one event is missing a product category, "prNca" (Collect events), or "customData":"category" (UA events).

Ensure that detail event is passing the product category: "prNca" (Collect events) or "customData":"category" (UA events).

N/A

addToCart

At least one event is missing a product category, "prNca" (Collect events), or "customData":"category" (UA events).

Ensure that cart event is passing the product category: "prNca" (Collect events) or "customData":"category" (UA events).

N/A

removeFromCart

At least one event is missing a product category, "prNca" (Collect events), or "customData":"category" (UA events).

Ensure that cart event is passing the product category: "prNca" (Collect events) or "customData":"category" (UA events).

N/A

purchase

At least one event is missing a product category, "prNca" (Collect events), or "customData":"category" (UA events).

Ensure that purchase event is passing the product category: "prNca" (Collect events) or "customData":"category" (UA events).

N/A

product_brand

Event types Cause Solution Impact

click

At least one event is missing the product brand: "prNbr" (Collect events), or "customData":"brand" (UA events).

Ensure that the event is sending the product brand: "prNbr" (Collect events) or "customData":brand" (UA events).

N/A

detail

At least one event is missing the product brand: "prNbr" (Collect events), or "customData":"brand" (UA events).

Ensure that the event is sending the product brand: "prNbr" (Collect events) or "customData":brand" (UA events).

N/A

addToCart

At least one event is missing the product brand: "prNbr" (Collect events), or "customData":"brand" (UA events).

Ensure that the event is sending the product brand: "prNbr" (Collect events) or "customData":brand" (UA events).

N/A

removeFromCart

At least one event is missing the product brand: "prNbr" (Collect events), or "customData":"brand" (UA events).

Ensure that the event is sending the product brand: "prNbr" (Collect events) or "customData":brand" (UA events).

N/A

purchase

At least one event is missing the product brand: "prNbr" (Collect events), or "customData":"brand" (UA events).

Ensure that the event is sending the product brand: "prNbr" (Collect events) or "customData":brand" (UA events).

N/A

transaction_affiliation

Event types Cause Solution Impact

purchase

At least one purchase event is missing an affiliation ("custom_datas":"c_original_event_data":"ta").

Ensure that the event is sending the affiliate ID ta.

N/A

transaction_coupon

Event types Cause Solution Impact

purchase

At least one purchase event is missing a coupon value ("custom_datas":"c_original_event_data":"tc").

Ensure that the event is sending the coupon value tc.

N/A

PAL_search_id

Event types Cause Solution Impact

addToCart

At least one add to cart event from search, recommendations, and CL powered by Coveo is missing a CoveoSearchUID in the pal (Product Action List) section.

Ensure that events from a search result list (or search API call) sends the searchUid as part of the pal parameter of Collect events. The format should be the following: "coveo:search:SEARCH_UID".

May break the attribution and consequently the dashboard (in case it’s possible to add a product to the cart and bypass the click).