Search Metrics | Yext Hitchhikers Platform
Searches Click Through Rate
Description: Percentage of Searches with a click, rounded to the 1’s place, e.g. 67.96% → 68%. CTR = Searches with Click / Searches.
Request ID & Response ID: ANSWERS_CLICK_THROUGH_RATE
Data Type: Float
Example Response Value: 0
Example Response:
{"day": "2019-06-25", "ANSWERS_CLICK_THROUGH_RATE": 0.0}
Searches Clicks
Description: The number of times content has been clicked.
Request ID & Response ID: ANSWERS_CLICKS
Data Type: Integer
Example Response Value: 1
Example Response: {"day": "2019-07-30", "ANSWERS_CLICKS": 1}
Clusters
Description: Distinct count of Clusters.
Request ID & Response ID: ANSWERS_CLUSTERS
Data Type: Integer
Example Response Value: 0
Example Response: {"ANSWERS_CLUSTERS": 0, "day": "2019-06-25"}
Searches
Description: The number of times a user ran a Search.
Request ID & Response ID: ANSWERS_SEARCHES
Data Type: Integer
Example Response Value: 19
Example Response: {"ANSWERS_SEARCHES": 19, "day": "2019-06-25"}
Searches with Clicks
Description: The number of times a user ran a Search and clicked a link.
Request ID & Response ID: ANSWERS_SEARCHES_WITH_CLICKS
Data Type: Integer
Example Response Value: 1
Example Response: {"ANSWERS_SEARCHES_WITH_CLICKS": 1, "day": "2019-06-25"}
Searches with Platform Results
Description: The number of times a user ran a Search that returned results.
Request ID & Response ID: SEARCHES_WITH_RESULTS
Data Type: Integer
Example Response Value: 0
Example Response: {"SEARCHES_WITH_RESULTS": 0, "day": "2019-06-25"}
Sessions
Description: The number of times a Session was started. A Session begins on user’s first search and ends when user closes the browser.
Request ID & Response ID: ANSWERS_SESSIONS
Data Type: Integer
Example Response Value: 1
Example Response: {"ANSWERS_SESSIONS": 1, "day": "2019-06-25"}
Voice Searches
Description: The number of searches made using voice search.
Request ID & Response ID: ANSWERS_VOICE_SEARCHES
Data Type: Integer
Example Response Value: 0
Example Response: {"day": "2019-06-25", "ANSWERS_VOICE_SEARCHES": 0}
Case Deflection Rate
Description: Percentage of cases that were deflected by Support Search.
Request ID & Response ID: ANSWERS_CASE_DEFLECTION_RATE
Data Type: Float
Example Response Value: 0.27
Example Response: {"ANSWERS_CASE_DEFLECTION_RATE": 0.27, "day": "2021-08-27"}
Case Deflections
Description: The number of times a user started their journey but did not create a case.
Request ID & Response ID: ANSWERS_CASE_DEFLECTIONS
Data Type: Integer
Example Response Value: 6
Example Response: {"day": "2021-08-27", "ANSWERS_CASE_DEFLECTIONS": 6}
Case Starts
Description: The number of times a user started their journey with search.
Request ID & Response ID: ANSWERS_CASE_STARTS
Data Type: Integer
Example Response Value: 22
Example Response: {"ANSWERS_CASE_STARTS": 22, "day": "2021-08-27"}
Case Submits
Description: The number of times a user started their journey with search and submitted a case.
Request ID & Response ID: ANSWERS_CASE_SUBMITS
Data Type: Integer
Example Response Value: 16
Example Response: {"ANSWERS_CASE_SUBMITS": 16, "day": "2021-08-27"}
Result Rate
Description: Percentage of Searches where a result was returned.
Request ID & Response ID: SEARCH_RESULT_RATE
Data Type: Float
Example Response Value: 0
Example Response: {"SEARCH_RESULT_RATE": 0.0, "day": "2019-06-25"}
Percentage of Total Searches
Description: Percentage of Searches a given dimension(s) represents based on the dimension(s) and filter(s) selected e.g. Percentage of Searches by Search Term where Version Label = PRODUCTION.
Request ID & Response ID: ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES
Data Type: Float
Example Response Value: 0
Example Response: {"day": "2019-06-25", "ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES": 0.0}
Search Terms
Description: Distinct count of Search Terms.
Request ID & Response ID: ANSWERS_SEARCH_TERMS
Data Type: Integer
Example Response Value: 2
Example Response: {"ANSWERS_SEARCH_TERMS": 2, "day": "2019-06-25"}
Thumbs Down Events
Description: The number of times Thumbs Down has been clicked.
Request ID & Response ID: ANSWERS_THUMBS_DOWN_EVENTS
Data Type: Integer
Example Response Value: 0
Example Response: {"ANSWERS_THUMBS_DOWN_EVENTS": 0, "day": "2019-07-30"}
Thumbs Up Events
Description: The number of times Thumbs Up has been clicked.
Request ID & Response ID: ANSWERS_THUMBS_UP_EVENTS
Data Type: Integer
Example Response Value: 0
Example Response: {"ANSWERS_THUMBS_UP_EVENTS": 0, "day": "2019-07-30"}