The hint report in OpenSearch tracks how users interact with search hints (autocomplete suggestions) and whether those hints lead to successful searches. Use this report to identify throttling issues, measure click engagement, and assess whether hints drive conversions.
The report displays metrics for the previous day by default. After you upload behavioral data, the report based on that data is available the next day.
View the hint report
In the left-side navigation pane, choose Report Statistics > Hint Report. Select an application from the Application Name drop-down list and a model from the Model Name drop-down list. Click a metric category tab, then set the date picker to the time period you want.
The report provides line charts showing metric trends for the last seven days. To view the line chart for a specific metric, click the corresponding metric icon.
Core metrics
Core metrics give you a high-level snapshot of hint health: how much hint traffic you're getting, how often users click hints, and whether hints are driving actual searches. Use these to get an at-a-glance view before diving into specific categories.
| Metric | Definition | Calculation | Dependencies |
|---|---|---|---|
| Shading PV | Number of successful hint requests. Requests that fail due to throttling are excluded. | Count of hint requests that receive a success response | None |
| Shading UV | Number of unique users who received hint results. Requests that fail due to throttling are excluded. | Each user counted once, regardless of request count | user_id field in hint requests |
| Shading request error times | Number of hint requests that return an error (for example, due to throttling). A high error count indicates you may need to add more hints to the existing ones. | Count of failed hint requests | None |
| Shading PV-CTR | Click-through rate (CTR) of hints. | Shading IPV / Shading PV | raw_query and from_request_id fields in search requests |
| Shading UV-CTR | CTR among unique users who received hint results. | Shading IPV_UV / Shading UV | raw_query and from_request_id in search requests; user_id in hint requests |
| Guided search PV ratio | Share of all searches that were triggered by a hint click. | Guided search PV / Search PV | from_request_id field in search requests |
| Guided search PV-CTR | CTR of searches triggered by hint clicks. Use this to assess retrieval and sorting quality for hint-guided searches. | IPV of hint-guided searches / Guided search PV | raw_query and from_request_id in search requests; data collection feature; behavioral data (user clicks) |
Traffic metrics
Traffic metrics focus on request volume and error rates. Use these to detect throttling issues and confirm that your hint service is handling load correctly. If the error rate is rising, consider adding more hints to the existing ones.
| Metric | Definition | Calculation | Dependencies |
|---|---|---|---|
| Shading PV | Number of successful hint requests. Requests that fail due to throttling are excluded. | Count of hint requests that receive a success response | None |
| Shading UV | Number of unique users who received hint results. Requests that fail due to throttling are excluded. | Each user counted once, regardless of request count | user_id field in hint requests |
| Shading request error times | Number of hint requests that return an error (for example, due to throttling). | Count of failed hint requests | None |
| Shading request error rate | Ratio of failed hint requests to all hint requests. A rising error rate indicates you may need to add more hints to the existing ones. | Shading request error times / (Shading PV + Shading request error times) | None |
Click metrics
Click metrics measure how often users engage with hint results. Use these to evaluate whether your hints are relevant and compelling enough to click. A low CTR may indicate that your hint suggestions do not match what users are looking for—consider reviewing your hint configuration or data quality.
Click metrics that track unique users require the user_id field in hint requests. Metrics without this dependency are available without additional configuration.| Metric | Definition | Calculation | Dependencies |
|---|---|---|---|
| Shading IPV | Number of clicks on hints. | Count of hint clicks | from_request_id field in search requests |
| Shading IPV_UV | Number of unique users who clicked hints. | Each user counted once, regardless of click count | raw_query and from_request_id in search requests; user_id in hint requests |
| Shading PV-CTR | CTR of hints. | Shading IPV / Shading PV | raw_query and from_request_id in search requests |
| Shading UV-CTR | CTR among unique users who received hint results. | Shading IPV_UV / Shading UV | raw_query and from_request_id in search requests; user_id in hint requests |
| Shading has a click on the percentage of PV | Ratio of hint requests whose results were clicked to all hint requests. | Clicked hint requests / Shading PV | from_request_id field in search requests |
Guided search metrics
Guided search metrics measure what happens after users click a hint and land on a search results page. Use these to evaluate whether hint-guided searches lead to conversions—purchases, favorites, cart additions, and other engagement actions. A high no-result rate may indicate gaps in your index; consider adding synonyms or expanding your data.
Conversion metrics (GMV, favorites, shopping cart, likes, comments) require the data collection feature to be enabled and behavioral data to be uploaded with the correct bhv_type value.Availability by configuration requirement
| Configuration required | Metrics |
|---|---|
from_request_id in search requests only | Guided search PV, Guided search PV ratio, Guided search no result rate |
user_id and from_request_id in search requests | Guided search UV, Guided search UV ratio |
raw_query and from_request_id in search requests; data collection feature + behavioral data | Guided search PV-CTR |
from_request_id in search requests; data collection feature + behavioral data | Guided search has clicks on the percentage of PV |
| Data collection feature + behavioral data | Guided search for GMV, Guided search favorite conversion rate, Guided search to the shopping cart conversion rate, Guided search like conversion rate, Guided search review conversion rate |
Guided search metric definitions
| Metric | Definition | Calculation | Dependencies |
|---|---|---|---|
| Guided search PV | Number of hint-guided searches, including paging requests. | Count of each hint click that triggers a search | from_request_id field in search requests |
| Guided search UV | Number of unique users who clicked hints. | Each user counted once | user_id and from_request_id in search requests |
| Guided search PV ratio | Share of all searches that were triggered by a hint click. | Guided search PV / Search PV | from_request_id field in search requests |
| Guided search UV ratio | Share of hint request users who clicked a hint. | Guided search UV / Search UV | user_id and from_request_id in search requests |
| Guided search no result rate | Ratio of hint-guided searches that returned no results. A high rate may indicate gaps in your index—consider adding synonyms or expanding your data. | Empty-result guided searches / Guided search PV | from_request_id field in search requests |
| Guided search PV-CTR | CTR of hint-guided searches. Use this to assess retrieval and sorting quality. | IPV of hint-guided searches / Guided search PV | raw_query and from_request_id in search requests; data collection feature; behavioral data (user clicks) |
| Guided search has clicks on the percentage of PV | Ratio of hint-guided searches whose results were clicked to all hint-guided searches. | Clicked guided searches / Guided search PV | from_request_id in search requests; data collection feature; behavioral data (user click events) |
| Guided search for GMV | Gross merchandise volume (GMV) of purchases made after a hint-guided search. | Sum of transaction amounts from hint-guided searches | Data collection feature; behavioral data with bhv_type = buy |
| Guided search favorite conversion rate | Ratio of hint-guided searches that resulted in a user adding an item to favorites. | Add-to-favorites count / Guided search PV | Data collection feature; behavioral data with bhv_type = collect |
| Guided search to the shopping cart conversion rate | Ratio of hint-guided searches that resulted in a user adding an item to the shopping cart, bookshelf, or playlist. | Add-to-cart count / Guided search PV | Data collection feature; behavioral data with bhv_type = cart |
| Guided search like conversion rate | Ratio of hint-guided searches that resulted in a user liking an item. | Like count / Guided search PV | Data collection feature; behavioral data with bhv_type = like |
| Guided search review conversion rate | Ratio of hint-guided searches that resulted in a user posting a comment. | Comment count / Guided search PV | Data collection feature; behavioral data with bhv_type = comment |