View analytics

This page describes how to view analytics for your apps and data stores.

Analytics give you insight into the usage trends, search quality, and end-user engagement of your app. The console provides an interactive dashboard experience powered by Looker.

You can see per-search metrics and per-search-session metrics based on search logs and user events. You can filter metrics by date range, query, and device type.

Metrics are refreshed about every 6 hours, so it can take several hours before you can use the Analytics page after you create your app.

Data sources for analytics

This section describes the data sources for analytics depending on app type.

You must complete user events integration to be able to see user event analytics.

Which user events you upload affect which analytics are generated.

Apps require the following user events to view some metrics:

Search events. Required for click-through-rate.
View-item events. Required for click-through-rate.

The following information is also used for some analytics:

Impressions. You can provide impressions (item views or clicks) that are attributable to Google by including the associated item in UserEvent.Documents when ingesting user events. This information is needed for attribution and to compute per-search metrics.
Attribution tokens. Attribution tokens are unique IDs generated by Google 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 the API. Only user events with a Google-generated attribution token are used to compute metrics.
User agent. Include UserInfo.userAgent with user events so that you can filter on user event metrics by device type.

Search logs

Search apps use search logs as data sources for some metrics.

Search logs are based on search requests. To allow Google to identify user sessions so that it can deliver per-session analytics and higher quality search results, Google strongly recommends that you set the optional field SearchRequest.UserPseudoId.

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

View search analytics

You can view search analytics for your app or for your data store:

App analytics: Displays metrics about all search calls made to your app. If your app is connected to multiple data stores, then making search calls to the app by specifying the engine resource is recommended so that you can get results from across all its connected data stores.
Data store analytics: Displays metrics about search calls made to a specific data store.

App analytics

Use the following instructions to view analytics about your app.

In the Google Cloud console, go to the Agentspace page.
Click the name of the app that you want to view analytics for.
Click Analytics.
Click a tab to view that metric group:
- Per Search. Metrics are grouped by searches.
- Per Session. Metrics are grouped by search sessions.
- Compare. Baseline metrics are shown alongside metrics from a comparison period. Select date ranges for the baseline metrics (an earlier time range) and comparison metrics (a later time range). These time ranges cannot overlap.
To filter your metrics, specify any of the following filters and then click the Refresh button to apply them:
- Date range. Select a preset date range or, if available, enter a custom date range.
- Search query. Select a condition and search query value. You can add multiple search query filters. Available for Per Search and Compare metrics.
- Data store ID. If no data store is selected, analytics are shown for all queries sent to the app. Select a data store to filter for metrics about a specific data store that's connected to the app.
- Device type. Select a device type that queries occurred on.

Data store analytics

Use the following instructions to view analytics about your data store.

In the Google Cloud console, go to the Agentspace page.
In the navigation menu, click Data Stores.
Click the name of the data store that you want to view analytics for.
Click Analytics.
Click a tab to view that metric group:
- Per Search. Metrics are grouped by searches.
- Per Session. Metrics are grouped by search sessions.
- Compare. Baseline metrics are shown alongside metrics from a comparison period. Select date ranges for the baseline metrics (an earlier time range) and comparison metrics (a later time range). These time ranges cannot overlap.
To filter your metrics, specify any of the following filters and then click the Refresh button to apply them:
- Date range. Select a preset date range or, if available, enter a custom date range.
- Search query. Select a condition and search query value. You can add multiple search query filters. Available for Per Search and Compare metrics.
- Device type. Select a device type that queries occurred on.

Metrics definitions

The following table describes how metrics are defined.

Metric name	Metrics Definition	Notes
Search count	Count of search events	Based on search logs
No result rate	Count of search events without results / Search count	Based on search logs
Click-through rate (CTR) per search	Count of search clicks / Search count	Search clicks are view-item events that can be attributed to a previous search event. Based on user events
Daily active search visitors	Number of users that have performed a search query	Based on users who use the web app.
Search session count	Count of search sessions	A search session is a user session containing at least one search event. A user session, also called a visit, is a continuous set of user events. When there are 30 minutes of inactivity, the session ends. Based on search logs
Page view per search visit	Count of view-item events in search sessions / Search session count	This metric includes all page views in search visits regardless of whether they can be attributed to Google. Based on user events
Bounce rate	Count of bounces in search sessions / Search session count	A search session bounce is defined as a session with a single search, where the user left after only making one search. Based on user events

Turn off analytics

You can't turn off analytics for an existing app, but when you create an app you can choose to create it with analytics turned off.

To create a search app that won't collect analytics data:

Follow the REST instructions in Create an app, adding the following to the curl command:

   "disableAnalytics": true

Example command

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: my-project-123" \
"https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines?engineId=my-app" \
-d '{
  "displayName": "App without analytics",
  "dataStoreIds": ["my-data-store"],
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
     "searchTier": "SEARCH_TIER_ENTERPRISE",
     "searchAddOns": ["SEARCH_ADD_ON_LLM"]
   },
  "disableAnalytics": true
}'

This command creates an app that won't collect search analytics data.