Retail is being renamed to Vertex AI Search for retail. We are in the process of updating content to reflect the new branding.

View analytics

This page describes metrics that can help you determine how Vertex AI Search for retail is affecting your business.

Prerequisites

The analytics dashboards use ingested user events as data sources for metrics. You must complete user events integration to be able to see user event analytics. Metrics are refreshed about every six hours, so it can take hours after you create your app to see metrics on the Analytics pages.

User events

The following user events are required to view some metrics:

Search events. Required for any type of metrics.
Detail page view events. Required for page view metrics.
Add-to-cart events. Required for add-to-cart rate, conversion rate.
Purchase-complete events. Required for total revenue, recommender-engaged revenue, average order value, purchase rate, revenue rate, average unit value, purchase order rate, conversion rate.

The following information is also used for analytics:

Product details. To ensure accurate computation of search-related metrics, include UserInfo.productDetails within your user events. This information allows Vertex AI Search for retail to attribute searches with specific product interactions. If the UserInfo.ProductDetail.quantity field is omitted within user events, a default value of 1 will be assumed for calculations.
Revenue. The UserInfo.PurchaseTransaction.revenue field is crucial for generating accurate revenue metrics. Ensure this field is populated within your user events to enable meaningful revenue-related analysis.
Attribution tokens. Attribution tokens are unique IDs generated by Vertex AI Search for retail and returned with each search request. Make sure to include that attribution token as UserEvent.attributionToken with any user events resulting from a search. This is needed to identify if a search is served by Vertex AI Search for retail.
User agent. Include UserInfo.userAgent with user events resulting from a search so that you can filter on user event metrics by device type.

View recommendations analytics

To view recommendation analytics:

In the Google Cloud console, go to the Search for Retail page.

Go to the Search for Retail console
In the navigation menu, click Analytics.
Click the Recommendation tab.
Use filters to view your metrics:
- If available, enter a custom date range or select a preset range.
- You can select a device type on which the recommendation occurred.
- To show metrics for a recommendation setting, use all of the following filters. Set none to display aggregated metrics over all recommendation settings.
  - Serving config ID
  - Recommendation ID
  - Context event type with a displayed recommendation

View search analytics

If there are no user events, default values are shown for all metrics.

To view search analytics:

In the Google Cloud console, go to the Search for Retail page.

Go to the Search for Retail console
In the navigation menu, click Analytics.
Click the Search tab.
Click a tab to view that metric group:
- Per Search. Metrics are grouped by searches.
- Per Visit. Metrics are grouped by search visits.
To filter your metrics, use the following filters:
- Date range. Select a preset date range or, if available, enter a custom date range.
- Device type. Select a device type that queries occurred on.

View browse analytics

If there are not yet any user events, default values are shown for all metrics.

To view browse analytics:

In the Google Cloud console, go to the Search for Retail page.

Go to the Search for Retail console
In the navigation menu, click Analytics.
Click the Browse tab.
Click a tab to view that metric group:
- Per Browse. Metrics are grouped by browses.
- Per Visit. Metrics are grouped by browse visits.
To filter your metrics, use the following filters:
- Date range. Select a preset date range or, if available, enter a custom date range.
- Device type. Select a device type that browsing occurred on.

View serving config analytics

In the Google Cloud console, go to the Search for Retail page.

Go to the Search for Retail console
In the navigation menu, click Serving Configs.
Click the name of the serving config that you want to view analytics for.
Click the Analytics tab.
Select a metric type from the Metric drop-down list to see its graph for the last month.

Metrics definitions

Summary metrics

The sections below provide definitions of the site-wide metrics displayed on the Analytics page:

Recommendations summary metrics: Metrics representing user engagement with recommendation results.
search summary metrics:
- Text query search summary metrics: Metrics representing engagement with text-based query search results.
- Browse search summary metrics: Metrics representing engagement with category browse search results.

Recommendations summary metrics

The following metrics are displayed for recommendations on the Recommendations tab.

Metric	Description
Recommendation count	The total number of recommendations performed across the entire site.
Detail page-view count	The number of times a recommended product was clicked.
Add-to-cart count	The number of times a recommended product was added to a cart.
Purchase count	The number of purchase orders in which at least one product was recommended.
Purchase revenue	The revenue of purchase orders in which at least one product was recommended.
Click-through rate (CTR) per recommendation	The percentage of times a recommended product was clicked out of the total number of times it was recommended.
Add-to-cart rate per recommendation	The percentage of times a recommended product was added to a cart out of the total number of times it was recommended.
Purchase rate per recommendation	The percentage of times an order that included a recommended product was purchased out of the total number of times the product was recommended.
Average order value per recommendation	The revenue of an order that included the recommended product that was purchased out of the total number of times it was recommended.

Text search summary metrics

The following metrics for text searches are displayed on the Search tab.

Metric	Description
Search count	The total number of searches performed site-wide.
No results rate	The number of searches without results divided by the total number of searches.
Click-through rate (CTR) per search	The number of clicks from search results divided by the total number searches.
Add-to-cart (ATC) rate per search	The number of add-to-cart events occurring from search results divided by the total number of searches.
Purchase rate per search	The number of units in purchase-complete events occurring from search results divided by the total number of searches.
Revenue rate per search	The amount of revenue generated from purchase-complete events divided by the total number of searches.
Average unit value (AUV) per search	The amount of revenue generated from purchase-complete events divided by the total unit quantity generated by purchase-complete events. Calculated based solely on purchase-complete events attributed to searches.
Personalization rate	The number of personalized searches divided by the total number of searches.
Search visit count	The total number of search visits performed site-wide.
Page view per search visit	The total number of detail-page-view events occurring in the search visit divided by the total number of search visits.
Add-to-cart (ATC) rate per search visit	The number of add-to-cart events occurring in the search visit divided by the total number of search visits. Calculated by including all add-to-cart events, regardless of whether they can be directly attributed to the search.
Purchase order rate per search visit	The number of purchase-complete events occurring in the search visit divided by the total number of search visits. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the search.
Revenue rate per search visit	The amount of revenue generated from purchase-complete events in search visit divided by the total number of search visits. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the search.
Average order value (AOV) per search visit	The amount of revenue generated from purchase-complete events in the search visit divided by the number of purchase-complete events occurring in the search visit. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the search.

Browse search summary metrics

The following metrics for browse searches are displayed on the Browse tab.

Metric	Description
Browse count	The total number of browse searches performed site-wide.
No results rate	The number of browse searches without results divided by the total number of browse searches.
Click-through rate (CTR) per browse	The number of clicks from browse results divided by the total number of site-wide browse searches The total number of browse searches includes paginated queries.
Add to cart (ATC) rate per browse	The number of add-to-cart events occurring from browse results divided by the total number of browse searches.
Purchase rate per browse	The number of units in purchase-complete events occurring from browse results divided by the total number of browse searches. The total number of browse searches includes paginated queries.
Revenue rate per browse	The amount of revenue generated from purchase-complete events divided by the total number of browse searches.
Average unit value (AUV) per browse	The amount of revenue generated from purchase-complete events divided by the total unit quantity generated by purchase-complete events. Calculated based solely on purchase-complete events attributed to browse searches.
Personalization rate	The number of personalized browse searches divided by the total number of browse searches.
Browse visit count	The total number of browse search visits performed site-wide.
Page view per browse visit	The total number of detail-page-view events occurring in the browse search visit divided by the total number of browse search visits.
Add to cart (ATC) rate per browse visit	The number of add-to-cart events occurring in the browse search visit divided by the total number of browse search visits. Calculated by including all add-to-cart events, regardless of whether they can be directly attributed to the browse search.
Purchase order rate per browse visit	The number of purchase-complete events occurring in the browse search visit divided by the total number of browse search visits. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the browse search.
Revenue rate per browse visit	The amount of revenue generated from purchase-complete events in the browse search visit divided by the total number of browse search visits. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the browse search.
Average order value (AOV) per browse visit	The amount of revenue generated from purchase-complete events in the browse search visit divided by the number of purchase-complete events occurring in the browse search visit. Calculated by including all purchase-complete events, regardless of whether they can be directly attributed to the browse search.

Configuration-specific metrics

You can see metrics for a specific serving config on the Serving Configs page. For metric graphs, click a serving config name to go to its details page, then select the Analytics tab.

The table below provides definitions for configuration-specific metrics.

Metric	Description	Details
Click-through rate (CTR)	The number of product detail views from a serving config's recommendation panel, divided by the total number of `predict` queries for this serving config.	For example, if the serving config points to a Frequently Bought Together model, then the CTR would be the number of product detail pages viewed from the shopping cart recommendation panel divided by the number of predict queries on the shopping cart page.
Conversion rate (CVR)	The number of add-to-cart events from a serving config's recommendation panel divided by the total number of `predict` queries for this serving config.	Similar to CTR, except that instead of product detail views, conversion rate uses add-to-cart events.
Recommender-engaged revenue	The total revenue from the recommendations for this serving config.	Similar to recommender-engaged revenue for summary metrics, but for this serving config only.

To track clicks from a serving config, Vertex AI Search for retail aligns the results in predict and search responses with ingested user events. If a clicked item appears in the responses for the same visitor ID within a one hour time window, the click/purchase is treated as a result of the Vertex AI Search for retail.

This process is fully automatic; you do not need to set anything up. However, when you configure your prediction and search requests for the first time, you should confirm that:

Visitor IDs in the request are the same as the visitor IDs you used in event ingestions.
The timestamp in the response roughly match the timestamp for that event.

When metrics are compared to the ideal expected result, or ground truth, the values might be lower, but the trends align.

A more direct alternative to the method above is to use attribution tokens. This requires significant instrumentation and is only recommended as an advanced tracking use case.