With Yext Analytics, you have the ability to create custom analytics reports with the metrics and dimensions that you’re most interested in. See below for a description of each dimension in Analytics. To see a list of Metrics, visit the Metrics in Analytics article.
To access the available dimension:
1. Click Analytics in the navigation bar and click Report Builder.
2. Click + Add Dimension under Dimensions in the right sidebar, and select the desired dimension.
Search
Display Name in Report Builder | Description | Request ID & Response ID | Data Type | Example Response | Compatible Metrics |
Search Experience | Name of Answers Experience. Can only be used with Answers metrics. | ANSWERS_EXPERIENCE | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_EXPERIENCE": "Conversion Tracking Test" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Experience Key | Key of Answers Experience. Can only be used with Answers metrics. | ANSWERS_EXPERIENCE_KEY | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_EXPERIENCE_KEY": "conversion_tracking_test" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Term Label | Label assigned to Search Term | ANSWERS_SEARCH_TERM_LABEL | String |
{ "ANSWERS_SEARCH_TERM_LABEL": "low_engagement", "ANSWERS_SEARCHES": 1857 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Backend | Backend(s) used to return results. Currently includes: Algolia, Bing CSE, Custom Covid Backend, Knowledge Manager, Google CSE, Zendesk. Can only be used with Answers metrics. | ANSWERS_BACKEND | String |
{ |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Blank Search Term | Indicates whether no Search Term was entered for Search. | ANSWERS_BLANK_SEARCH_TERM | String |
{ "ANSWERS_BLANK_SEARCH_TERM": "No", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Click Label | Label assigned to CTA_CLICK types. | ANSWERS_CLICK_LABEL | String |
{ "ANSWERS_SEARCHES": 392, "ANSWERS_CLICK_LABEL": "Analytics" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Click Type | Type of Click. Can only be used with Answers metrics. | ANSWERS_CLICK_TYPE | String |
{ "ANSWERS_CLICK_TYPE": "CTA_CLICK", "ANSWERS_SEARCHES": 823 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Click URL | URL user was sent to on click, e.g. Google Maps on Driving Directions click. | ANSWERS_CLICK_URL | String |
{ "ANSWERS_CLICK_URL": "http://hitchhikers.yext.com/", "ANSWERS_CLICKS": 4 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Configuration Version | Version Number of Configuration used to run the Search. Can only be used with Answers metrics. | ANSWERS_CONFIGURATION_VERSION | String |
{ "ANSWERS_CONFIGURATION_VERSION": "1", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Configuration Version Label | Version Label of Configuration used to run the Search. Can only be used with Answers metrics. | ANSWERS_CONFIGURATION_VERSION_LABEL | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_CONFIGURATION_VERSION_LABEL": "STAGING" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Configuration Version Label | The Configuration Version Label of the Answers clicks or conversions. | ANSWERS_VERSION_LABEL | String |
{ |
['CLICKS', 'CONVERSION_RATE', 'CONVERSION_SEARCHES', 'SESSIONS', 'CONVERSION_VALUE', 'CONVERSIONS', 'VALUE_PER_CONVERSION'] |
Direct Answer Click | Indicates whether a click was from Direct Answer. | ANSWERS_DIRECT_ANSWER_CLICK | String |
{ "ANSWERS_SEARCHES": 5749, "ANSWERS_DIRECT_ANSWER_CLICK": "No" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Direct Answer Field | Field returned in Direct Answer. | ANSWERS_DIRECT_ANSWER_FIELD | String |
{ "ANSWERS_DIRECT_ANSWER_FIELD": "Publisher Supported Country Code", "ANSWERS_SEARCHES": 2 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Direct Answer Field Type | Type of Field used for Direct Answer returned for a Search. | ANSWERS_DIRECT_ANSWER_FIELD_TYPE | String |
{ "ANSWERS_DIRECT_ANSWER_FIELD_TYPE": "MULTI_LINE_TEXT", "ANSWERS_SEARCHES": 228 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Direct Answer Field Value | Value returned in Direct Answer. | ANSWERS_DIRECT_ANSWER_FIELD_VALUE | String |
{ "ANSWERS_DIRECT_ANSWER_FIELD_VALUE": "1-2 weeks", "ANSWERS_SEARCHES": 4 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Direct Answer Type | Type of Direct Answers returned for a Search. | ANSWERS_DIRECT_ANSWER_TYPE | String |
{ "ANSWERS_DIRECT_ANSWER_TYPE": "FEATURED_SNIPPET", "ANSWERS_SEARCHES": 2391 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Filter Key | Searchable field used to filter a search. | ANSWERS_FILTER_KEY | String |
{ "ANSWERS_FILTER_KEY": "builtin.entityType", "ANSWERS_SEARCHES": 3536 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Filter Operator | Operator used for filter. | ANSWERS_FILTER_OPERATOR | String |
{ "ANSWERS_FILTER_OPERATOR": "Equals", "ANSWERS_SEARCHES": 5909 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Filter Source | Source of filter applied to Search. | ANSWERS_FILTER_SOURCE | String |
{ "ANSWERS_FILTER_SOURCE": "Algorithm", "ANSWERS_SEARCHES": 5909 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Filter Type | Type of filter applied. | ANSWERS_FILTER_TYPE | String |
{ "ANSWERS_SEARCHES": 610, "ANSWERS_FILTER_TYPE": "Facet" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Filter Value | Value used to filter Search. | ANSWERS_FILTER_VALUE | String |
{ "ANSWERS_SEARCHES": 55, "ANSWERS_FILTER_VALUE": "API" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Case Start | Indicates the first search in the case creation process. | ANSWERS_HAS_CASE_START | String |
{ "ANSWERS_SEARCHES": 57, "ANSWERS_HAS_CASE_START": "No" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Case Submit | Indicates the last search in the case creation process. | ANSWERS_HAS_CASE_SUBMIT | String |
{ "ANSWERS_SEARCHES": 6821, "ANSWERS_HAS_CASE_SUBMIT": "No" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Click | Indicates whether a search has a click | ANSWERS_HAS_CLICK | String |
{ "ANSWERS_SEARCHES": 5749, "ANSWERS_HAS_CLICK": "Yes" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Direct Answer | Indicates whether a Search returned a Direct Answer. | ANSWERS_HAS_DIRECT_ANSWER | String |
{ "ANSWERS_HAS_DIRECT_ANSWER": "No", "ANSWERS_SEARCHES": 19839 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Results | Searches that returned results. This does not include results from third-party verticals. | ANSWERS_HAS_KG_RESULTS | String |
{ "ANSWERS_HAS_KG_RESULTS": "No", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Search Term Cluster | Indicates whether a Search Term belongs to a Search Term Cluster. Search Terms may not belong to a cluster if they do not pertain to any other terms searched on your experience or if it is a new term that has been searched for the first time since clustering was last run. | ANSWERS_HAS_SEARCH_TERM_CLUSTER | String |
{ "ANSWERS_HAS_SEARCH_TERM_CLUSTER": "Yes", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Has Voice Search | Includes only searches made using voice search. | ANSWERS_HAS_VOICE_SEARCH | String |
{ "ANSWERS_SEARCHES": 8283, "ANSWERS_HAS_VOICE_SEARCH": "No" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Integration Source | The integration source from which this search originated. This includes the following options: STANDARD (standard search bar) and OVERLAY (within an search overlay). | ANSWERS_QUERY_SOURCE | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_QUERY_SOURCE": "STANDARD" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Legacy Search Term | Normalized version of Search Term used for search using legacy search term normalizer. This dimension / filter is meant for historical comparison and will be deprecated in a future release. | ANSWERS_LEGACY_SEARCH_TERM | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_LEGACY_SEARCH_TERM": "test" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Locale | Locale Search was run in. Can only be used with Answers metrics. | ANSWERS_LOCALE | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_LOCALE": "en" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Raw Search Term | Raw Search Term entered by user for Search. | ANSWERS_RAW_SEARCH_TERM | String |
{ "ANSWERS_RAW_SEARCH_TERM": "test", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Referrer Domain | Domain of page where user was sent from, e.g. jobs.mysite.com. | ANSWERS_REFERRER_DOMAIN | String |
{ "ANSWERS_REFERRER_DOMAIN": "www.yext.com", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Referrer URL | URL of page where user was sent from, e.g. https://jobs.mysite.com/careers/open-positions/. | ANSWERS_REFERRER_PAGE_URL | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_REFERRER_PAGE_URL": "https://www.yext.com/s/" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Result Entity Position | Position Entity was returned within Vertical. | ANSWERS_RESULT_ENTITY_POSITION | String |
{ "ANSWERS_RESULT_ENTITY_POSITION": "1", "ANSWERS_SEARCHES": 19701 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Result Title | Title of Result from Third Party Backends. For results that come from the Yext Knowledge Graph backends, this will be blank. | ANSWERS_RESULT_TITLE | String |
{ "ANSWERS_CLICKS": 56, "ANSWERS_RESULT_TITLE": " Approve quarantined first party reviews" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Result Vertical Position | Position of Verticals in Result. | ANSWERS_RESULT_VERTICAL_POSITION | String |
{ "ANSWERS_SEARCHES": 19761, "ANSWERS_RESULT_VERTICAL_POSITION": "1" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search ID | ID of Search. Can only be used with Answers metrics. | ANSWERS_SEARCH_ID | String |
{ "ANSWERS_SEARCH_ID": "017f0af7-6bf3-23ca-ef97-71fbd69a44e1", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Term | Normalized Search Term of Search. Normalization removes: Capitalization, Punctuation, White Space. Can only be used with Answers metrics. | ANSWERS_SEARCH_TERM | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_SEARCH_TERM": "test" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Term Cluster | Name of the Cluster a Search Term belongs to. Search Term Clusters are named by using the most popular Search Term (based on Sessions) within the Cluster. | ANSWERS_CLUSTER | String |
{ "ANSWERS_CLUSTER": "add a custom field", "ANSWERS_SEARCHES": 105 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Term Cluster Performance | Identify how well a cluster is performing based on % of Total Searches and Click Through Rate. Cluster Performance breaks down into four groups: Needs Attention - Large Cluster, Needs Attention - Small Cluster, Performing Well - Small Cluster and Performing Well - Large Cluster. | ANSWERS_SEARCH_TERM_CLUSTER_PERFORMANCE | String |
{ "ANSWERS_SEARCH_TERM_CLUSTER_PERFORMANCE": "Needs Attention - Large Cluster", "ANSWERS_SEARCHES": 2278 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Search Term Word Count | Indicates the number of words in a Search Term | ANSWERS_SEARCH_TERM_WORD_COUNT | String |
{ "ANSWERS_SEARCH_TERM_WORD_COUNT": "11", "ANSWERS_SEARCHES": 268 } |
[] |
Search Vertical | Vertical Search was ran on. Can only be used with Answers metrics. | ANSWERS_SEARCH_VERTICAL | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_SEARCH_VERTICAL": "Universal" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Session ID | ID of Session Search was run in. Can only be used with Answers metrics. | ANSWERS_SESSION_ID | String |
{ "ANSWERS_SESSION_ID": "5545f5c1-9a83-45e7-b72e-6c8318d15561", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Traffic Type | External or Internal. Can only be used with Answers metrics. | ANSWERS_TRAFFIC_TYPE | String |
{ "ANSWERS_TRAFFIC_TYPE": "Internal", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Browser | Browser of the user running the Search. | ANSWERS_USER_BROWSER | String |
{ "ANSWERS_USER_BROWSER": "Chrome", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User City | City of user running Search. | ANSWERS_USER_CITY | String |
{ "ANSWERS_USER_CITY": "Arlington", "ANSWERS_SEARCHES": 441 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Country | Country of user running Search. | ANSWERS_USER_COUNTRY | String |
{ "ANSWERS_USER_COUNTRY": "US", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Device Class | Device of user running Search. | ANSWERS_USER_DEVICE_CLASS | String |
{ "ANSWERS_SEARCHES": 1, "ANSWERS_USER_DEVICE_CLASS": "DESKTOP" } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Lat, Long | Lat, Long of user running Search. | ANSWERS_USER_LAT_LONG | String |
{ "ANSWERS_USER_LAT_LONG": "37.751, -97.822", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Location Accuracy | Method for identifying user location. Options include Unknown, Device, and IP. | ANSWERS_USER_LOCATION_ACCURACY | String |
{ "ANSWERS_USER_LOCATION_ACCURACY": "IP", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Postal Code | Postal code of the user running the Search. | ANSWERS_USER_POSTAL_CODE | String |
{ "ANSWERS_USER_POSTAL_CODE": "11249", "ANSWERS_SEARCHES": 1 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
User Region | Region of the user running the Search. | ANSWERS_USER_REGION | String |
{ "ANSWERS_USER_REGION": "New York", "ANSWERS_SEARCHES": 77 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Vertical Returned | Vertical returned in results for a Search. | ANSWERS_VERTICAL_RETURNED | String |
{ "ANSWERS_VERTICAL_RETURNED": "app_directories", "ANSWERS_SEARCHES": 9719 } |
['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Competitors
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Compatible Dimensions |
Competitor | Competitors monitored by the Intelligent Search Tracker. Can be used with Intelligent Search Tracker metrics and the Cumulative Rating metric. | IST_COMPETITOR | competitor | String |
{ "Total Matches": 994, "competitor": "Apple" } |
[] |
Local Pack Competitor | Local pack competitors monitored by the Intelligent Search Tracker. Can be used with IST_MATCHES_PER_SEARCH and IST_TOTAL_MATCHES. | IST_LOCAL_PACK_COMPETITOR | local_pack_competitor | String |
{ "Total Matches": 16, "local_pack_competitor": "#Cloud Business Center" } |
[] |
Conversion Tracking
Display Name in Report Builder | Description | Request ID & Response ID | Data Type | Example Response | Example Response Value | Compatible Dimensions |
Click Type | Identify the type of click that a conversion is attributed to. Can only be used with Conversion Tracking metrics. | CLICK_TYPE | String |
{ "CLICKS": 2, "CLICK_TYPE": "Featured Message" } |
Featured Message | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'CLICKS', 'CONVERSION_RATE', 'CONVERSION_SEARCHES', 'SESSIONS', 'CONVERSION_VALUE', 'CONVERSIONS', 'VALUE_PER_CONVERSION'] |
Conversion Action | Can only be used with Conversion Tracking metrics. | CONVERSION_ACTION_ID | String |
{ "CONVERSION_VALUE": 2555.0, "CONVERSION_ACTION_ID": "FAQ Row Expand" } |
FAQ Row Expand | [] |
Conversion Type | Type of conversion action (Customer Support, Lead, Page View, Purchase, etc). | CONVERSION_TYPE | String |
{ "CONVERSION_VALUE": 2555.0, "CONVERSION_TYPE": "Customer Support" } |
Customer Support | [] |
Medium | Identify the source of click this conversion is attributed to. Can only be used with Conversion Tracking metrics. | MEDIUM_ID | String |
{ "MEDIUM_ID": "Extended Network", "CLICKS": 7 } |
Extended Network | [] |
Medium Type | Identify the type of source of click this conversion is attributed to. Can only be used with Conversion Tracking metrics. | MEDIUM_TYPE | String |
{ "MEDIUM_TYPE": "Listings Publishers", "CLICKS": 9 } |
Listings Publishers | [] |
Product | Identify conversion analytics by the product in which they occurred. Can only be used with Conversion Tracking metrics. | PRODUCT | String |
{ "PRODUCT": "Listings", "CLICKS": 9 } |
Listings | [] |
Search Term (Normalized) | Raw Search Term entered by user for Search. | SEARCH_TERM | String |
{ "SEARCH_TERM": "2021 release", "CLICKS": 1 } |
2021 release | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS'] |
Traffic Source | Identify conversion analytics by the source of the traffic. | TRAFFIC_SOURCE | String |
{ "TRAFFIC_SOURCE": "EXTERNAL", "CLICKS": 9 } |
EXTERNAL | [] |
Value Proposition | Value Proposition. | VALUE_PROPOSITION | String |
{ "VALUE_PROPOSITION": "COST_SAVING", "CONVERSIONS": 511.0 } |
COST_SAVING | [] |
Vertical Config ID | Vertical Config ID. | VERTICAL_CONFIG_ID | String |
{ "VERTICAL_CONFIG_ID": "App Directories", "CLICKS": 98 } |
App Directories | [] |
Entities
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Entity Group | Identify events by the type group of the corresponding entity. | ENTITY_GROUPS | entity_group | String |
{ "entity_group": "Custom", "Profile Updates": 29 } |
Custom | [] |
Entity Type | Identify events by the type of the corresponding entity. | ENTITY_TYPES | entity_type | String |
{ "entity_type": "Event", "Profile Updates": 659 } |
Event | ['STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Events | Identify events by the corresponding event. | EVENTS | event | String |
{ "Event Profile Views": 1, "event": "Hitchhikers Office Hours: August 25th, 2020" } |
Hitchhikers Office Hours: August 25th, 2020 | ['STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Field Name | The name of the field being updated in your profile (can only be used with the PROFILE_UPDATES metric). | FIELD_NAME | field_name | String |
{ "Profile Updates": 976, "field_name": "Address" } |
Address | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Publisher Suggestion Type | The type of the publisher suggestion (can only be used with the PUBLISHER_SUGGESTIONS metric). | PUBLISHER_SUGGESTION_TYPE | publisher_suggestion_type | String |
{ "Publisher Suggestions": 3, "publisher_suggestion_type": "ACCEPTED" } |
ACCEPTED | |
All Entities | Identify events by the corresponding entity. | ENTITY_IDS | entity_id | String |
{ "Profile Updates": 20926, "entity_id": "1" } |
20926 | |
All Entities | Identify events by folder ID of the corresponding entity. | FOLDER_IDS | folder_id | String |
{ "Profile Updates": 21480, "folder_id": 307405 } |
307405 | |
All Entities | Identify events by store ID of the corresponding location. | LOCATION_IDS | location_id | String |
{ "Profile Updates": 20926, "location_id": "1" } |
1 | |
Folder | Identify events by the folder of the corresponding location. | FOLDER_NAMES | folder | String |
{ "metrics": [ "NEW_REVIEWS" ], "dimensions": [ "FOLDER_NAMES" ] } |
APAC | |
Locations | Identify events by the corresponding location. | LOCATION_NAMES | location | String |
{ "metrics": [ "SEARCHES" ], "dimensions": [ "LOCATION_NAMES" ] } |
My Flower Shop |
Location Listings
Display Name in Report Builder | Description | Request ID | Response ID | Data Types | Example Response | Example Value | Compatible Metrics |
Action | Type of interaction that a user has performed e.g. booked an appointment (Book Appointment) or ordered from your business (Order Now). | ACTION | ACTION | String | { "LISTINGS_ACTIONS": 10, "ACTION": "Call" } |
BOOK_APPOINTMENT DRIVING_DIRECTIONS MESSAGE ORDER_NOW TAP_TO_CALL WEBSITE |
['LISTINGS_ACTIONS'] |
App | For Publishers with multiple interfaces, App indicates where the user’s interaction took place e.g. Google Maps or Google Search. | APP | APP | String | { "LISTINGS_IMPRESSIONS": 10, "APP": "SEARCH" } |
SEARCH | ['LISTINGS_IMPRESSIONS'] |
Customer Action Type | The type of action consumers took through your Google or Yelp listings (Phone Calls, Get Directions, or Website Clicks). Can only be used with the GOOGLE_CUSTOMER_ACTIONS and YELP_CUSTOMER_ACTIONS metrics. Replaces GOOGLE_ACTION_TYPE for v parameters 20170914 and later. | CUSTOMER_ACTION_TYPE | customer_action_type | String |
{ "Google Customer Actions": 133503, "customer_action_type": "Get Directions" } |
Get Directions | [] |
Device | Device of user’s interaction | DEVICE | DEVICE | String | { "LISTINGS_IMPRESSIONS": 5, "DEVICE": "MOBILE" } |
MOBILE | ['LISTINGS_IMPRESSIONS'] |
Google Query Type |
Type of Google Listings Query. Signifies whether the query leading to your Listings impression was a Branded, Direct, or Discovery query.
|
GOOGLE_QUERY_TYPE | google_query_type | String |
{ "Google Search Queries": 161230, "google_query_type": "Branded" } |
Branded | [] |
Is Click | Whether the Action is considered a Click or some other type of interaction. Actions that are considered clicks can be used to calculate metrics like Click Through Rate. | IS_CLICK | IS_CLICK | Boolean | { "LISTINGS_ACTIONS": 5, "IS_CLICK": TRUE } |
TRUE | ['LISTINGS_ACTIONS'] |
Listings Live Type | The type of of listings live, either be Claimed or Created (can only be used with LISTINGS_LIVE metric). | LISTINGS_LIVE_TYPE | listings_live_type | String |
{ "listings_live_type": "Claimed", "New Listings Live": 242 } |
Claimed | [] |
Raw Search Term | Raw version of Search Term used for Search. Raw Search Term is the exact search term (including casing, punctuation and spacing) that was entered by the user. The Raw Search Term is normalized by the algorithm when a search is run (see Search Term dimension / filter). | RAW_SEARCH_TERM | RAW_SEARCH_TERM | String | { "LISTINGS_GOOGLE_SEARCH_TERM_IMPRESSIONS": 100, "RAW_SEARCH_TERM": "Restaurant Near Me" } |
Restaurant Near Me | ['LISTINGS_GOOGLE_SEARCH_TERM_IMPRESSIONS] |
Sites | Groups data about the site-interaction events listed in metrics by the sites on which they occurred. | PUBLISHERS | site | String |
{ "site": "BING", "Searches": 7343 } |
BING | [] |
Pages
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Directory | The directories of your Store Pages. Can only be used with Store Pages metrics. | STOREPAGES_DIRECTORY | directory | String |
{ "directory": "Yext Location Pages - State - City Drilldown", "Call to Action Clicks": 3150 } |
Yext Location Pages - State - City Drilldown | [] |
Page Site | The site domain in which your Pages reside. | PAGE_SITE | page_site | String |
{ "page_site": "About", "Call to Action Clicks": 7460 } |
About | [] |
Page Type | The page types for your Store Pages. Can only be used with Store Pages metrics. | STOREPAGES_PAGE_TYPE | page_type | String |
{ "page_type": "Directory Pages", "Call to Action Clicks": 3150 } |
Directory Pages | [] |
Page Url | The urls people visited on your Store Pages. Can only be used with Store Pages metrics. | STOREPAGES_PAGE_URL | page_url | String |
{ "page_url": "/2020-hitchhikers-year-in-review-cc49121b846e", "Call to Action Clicks": 18 } |
/2020-hitchhikers-year-in-review-cc49121b846e | [] |
Reviews
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Frequent Words | The words that most frequently appear in your reviews. | FREQUENT_WORDS | frequent_words | String |
{ "Average Rating": 3.33, "frequent_words": "cantonese" } |
cantonese | [] |
Ratings | Can only be used with Reviews metrics except CUMULATIVE_RATING. | RATINGS | ratings | String |
{ "ratings": "0", "Average Rating": 0.0 } |
0 | [] |
Review Keywords | The keywords used in your reviews. | REVIEW_KEYWORDS | review_keywords | String |
{ "review_keywords": "american", "Average Rating": 4.33 } |
american | [] |
Review Labels | Identify reviews by their label. | REVIEW_LABELS | review_labels | String |
{ "review_labels": "Needs Attention", "Average Rating": 1.5 } |
Needs Attention | [] |
Sentiment Collection | Identify reviews by their sentiment collection of keywords. | SENTIMENT_COLLECTION | sentiment_collection | String |
{ "Average Rating": 3.24, "sentiment_collection": "Food" } |
Food | [] |
Site | The sites your reviews appear on. Can only be used with Reviews metrics. | PARTNERS | site | String |
{ "site": "CitySquares", "Average Rating": 5.0 } |
CitySquares | [] |
Search Tracker
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Event Search Schedule Condition | Identify Search Tracker for Events metrics by the event search schedule condition. Can be used with Search Tracker Event metrics. | EVENT_SEARCH_CONDITION | event_search_schedule_condition | String |
{ "event_search_schedule_condition": "28 Days Prior", "Event Matches per Search": 1.76 } |
28 Days Prior | [] |
Keyword | The keyword used to create search requests. Can only be used with Intelligent Search Tracker metrics. | IST_KEYWORD | keyword | String |
{ "keyword": "Digital Knowledge", "Search Requests": 31216 } |
Digital Knowledge | [] |
Match Position | The local pack or organic position of the search result. Can only be used with Intelligent Search Tracker metrics. | IST_MATCH_POSITION | match_position | String |
{ "match_position": "1", "Total Matches": 35595 } |
1 | [] |
Match Type | One of Local Map Pack, Listings, Pages and Corporate Website. Can only be used with Intelligent Search Tracker metrics. | IST_MATCH_TYPE | match_type | String |
{ "Total Matches": 52710, "match_type": "Corporate Website" } |
Corporate Website | [] |
Query Template | The query template used to create search requests. Can only be used with Intelligent Search Tracker metrics. | IST_QUERY_TEMPLATE | query_template | String |
{ "Total Matches": 33102, "query_template": "[[KEYWORD]]" } |
[[KEYWORD]] | [] |
Search Engine | The search engine used for the Intelligent Search Tracker. Can only be used with Intelligent Search Tracker metrics. | IST_SEARCH_ENGINE | search_engine | String |
{ "Total Matches": 54775, "search_engine": "Bing Desktop" } |
Bing Desktop | [] |
Search Result Type | One of Organic, Local Pack or Knowledge Card. Can only be used with Intelligent Search Tracker metrics. | IST_SEARCH_RESULT_TYPE | search_result_type | String |
{ "Total Matches": 14932, "search_result_type": "Knowledge Card" } |
Knowledge Card | [] |
Social
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Age | The age range of a Facebook user. Can be used with FACEBOOK_LIKES, FACEBOOK_TALKING_ABOUT, FACEBOOK_CHECKINS, FACEBOOK_IMPRESSIONS, and FACEBOOK_PAGE_VIEWS. | AGE | age | String |
{ "Facebook Check-ins": 4, "age": "18-24" } |
18-24 | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'FACEBOOK_CHECKINS', 'FACEBOOK_LIKES', 'FACEBOOK_IMPRESSIONS', 'FACEBOOK_PAGE_VIEWS', 'FACEBOOK_TALKING_ABOUT'] |
Facebook Impression Type | Indicates whether your Facebook Impressions came from Organic, Paid, or Viral content. Can only be used with the FACEBOOK_IMPRESSIONS and FACEBOOK_POST_IMPRESSIONS metrics. | FACEBOOK_IMPRESSION_TYPE | impression_type | String |
{ "Facebook Page Impressions": 185325, "impression_type": "Organic" } |
Organic | [] |
Facebook RSVP Type | Identify Facebook Events by RSVP type. Can be used with FACEBOOK_EVENT_NEW_RSVPS. | FACEBOOK_RSVP_TYPE | rsvp_type | String |
{ "rsvp_type": "Interested", "Facebook Event New RSVPs": 35 } |
Interested | [] |
Facebook Story Type | How people are talking about your Page (e.g., posts, likes, comments). Can only be used with the FACEBOOK_TALKING_ABOUT metric. | FACEBOOK_STORY_TYPE | story_type | String |
{ "story_type": "Page Likes", "Facebook Talking About This": 539 } |
Page Likes | [] |
Gender | The gender of a Facebook user. Can be used with FACEBOOK_LIKES, FACEBOOK_TALKING_ABOUT, FACEBOOK_CHECKINS, FACEBOOK_IMPRESSIONS, and FACEBOOK_PAGE_VIEWS. | GENDER | gender | String |
{ "gender": "Female", "Facebook Talking About This": 169 } |
Female | [] |
Time
Display Name in Report Builder | Description | Request ID | Response ID | Example Response | Example Value | Compatible Metrics |
Day of Week | Identify events by day of the week (Monday, Tuesday, etc.). | DAY_OF_WEEK | day_of_week |
{ "Profile Updates": 11409, "day_of_week": "Friday" } |
Friday | [] |
Days | Identify events by day. | DAYS | day |
{ "ANSWERS_SEARCHES": 1, "day": "2022-02-18" } |
2/18/22 | [] |
Months | Identify events by months of the Gregorian calendar (January, February, etc.). | MONTHS | month |
{ "month": "2022-02-01", "ANSWERS_SEARCHES": 1 } |
2/1/22 | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'CLICKS', 'CONVERSION_RATE', 'CONVERSION_SEARCHES', 'SESSIONS', 'CONVERSION_VALUE', 'CONVERSIONS', 'VALUE_PER_CONVERSION', 'EVENT_PROFILEVIEWS', 'EVENT_SEARCHES', 'FACEBOOK_EVENT_NEW_RSVPS', 'TICKET_CLICKS', 'POWERLISTINGS_LIVE', 'GOOGLE_CUSTOMER_ACTIONS', 'GOOGLE_MAP_VIEWS', 'GOOGLE_SEARCH_QUERIES', 'GOOGLE_SEARCH_VIEWS', 'PROFILE_VIEWS', 'SEARCHES', 'TOTAL_LISTINGS_IMPRESSIONS', 'YELP_PAGE_VIEWS', 'GSC_POSITION', 'GSC_CTR', 'GSC_CLICKS', 'GSC_IMPRESSIONS', 'AVERAGE_RATING', 'KEYWORD_MENTIONS', 'KEYWORD_SENTIMENT', 'RESPONSE_COUNT', 'RESPONSE_RATE', 'RESPONSE_TIME', 'NEW_REVIEWS', 'IST_AD_MATCHES', 'IST_AD_PRESENCE', 'IST_AVERAGE_FIRST_LOCAL_PACK_MATCH_POSITION', 'IST_AVERAGE_FIRST_MATCH_POSITION', 'IST_AVERAGE_FIRST_ORGANIC_MATCH_POSITION', 'IST_AVERAGE_LOCAL_PACK_NUMBER_OF_RESULTS', 'IST_AVERAGE_LOCAL_PACK_POSITION', 'ST_EVENT_MATCHES_PER_SEARCH', 'ST_EVENT_RICH_RESULT_PRESENCE', 'ST_EVENT_SHARE_OF_INTELLIGENT_SEARCH', 'IST_KNOWLEDGE_CARD_EXISTED', 'IST_LOCAL_PACK_EXISTED', 'IST_LOCAL_PACK_PRESENCE', 'IST_LOCAL_PACK_SHARE_OF_SEARCH', 'IST_MATCHES_PER_SEARCH', 'IST_ORGANIC_SHARE_OF_SEARCH', 'IST_SEARCH_REQUESTS', 'IST_SHARE_OF_INTELLIGENT_SEARCH', 'IST_TOTAL_MATCHES', 'FEATURED_MESSAGE_CLICKS', 'CUMULATIVE_RATING'] |
Quarters | Identify events by quarter. Only supported for Review metrics. | QUARTERS | quarter |
{ "Average Rating": 0.0, "quarter": "1980-01-01" } |
1/1/80 | [] |
Week Number | A given week labeled with the number of weeks into a year and its corresponding year. A week is always Monday to Sunday, “Week 1” will always contain January 1st, and the year is the year of the last day (Sunday) of that week (Week 1 (2017), Week 2 (2017), etc.). | WEEK_NUMBER | week_number |
{ "Profile Updates": 22, "week_number": "Week 1 (2013)" } |
Week 1 (2013) | ['EVENT_PROFILEVIEWS', 'EVENT_SEARCHES', 'FACEBOOK_EVENT_NEW_RSVPS', 'TICKET_CLICKS', 'POWERLISTINGS_LIVE', 'DUPLICATES_DETECTED', 'DUPLICATES_SUPPRESSED', 'GOOGLE_CUSTOMER_ACTIONS', 'GOOGLE_MAP_VIEWS', 'GOOGLE_SEARCH_QUERIES', 'GOOGLE_SEARCH_VIEWS', 'LISTINGS_LIVE', 'PROFILE_VIEWS', 'SEARCHES', 'TOTAL_LISTINGS_IMPRESSIONS', 'YELP_PAGE_VIEWS', 'STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'GSC_POSITION', 'GSC_CTR', 'GSC_CLICKS', 'GSC_IMPRESSIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}', 'PROFILE_UPDATES', 'PUBLISHER_SUGGESTIONS', 'AVERAGE_RATING', 'KEYWORD_MENTIONS', 'KEYWORD_SENTIMENT', 'RESPONSE_COUNT', 'RESPONSE_RATE', 'RESPONSE_TIME', 'NEW_REVIEWS', 'IST_AD_MATCHES', 'IST_AD_PRESENCE', 'IST_AVERAGE_FIRST_LOCAL_PACK_MATCH_POSITION', 'IST_AVERAGE_FIRST_MATCH_POSITION', 'IST_AVERAGE_FIRST_ORGANIC_MATCH_POSITION', 'IST_AVERAGE_LOCAL_PACK_NUMBER_OF_RESULTS', 'IST_AVERAGE_LOCAL_PACK_POSITION', 'ST_EVENT_MATCHES_PER_SEARCH', 'ST_EVENT_RICH_RESULT_PRESENCE', 'ST_EVENT_SHARE_OF_INTELLIGENT_SEARCH', 'IST_KNOWLEDGE_CARD_EXISTED', 'IST_LOCAL_PACK_EXISTED', 'IST_LOCAL_PACK_PRESENCE', 'IST_LOCAL_PACK_SHARE_OF_SEARCH', 'IST_MATCHES_PER_SEARCH', 'IST_ORGANIC_SHARE_OF_SEARCH', 'IST_SEARCH_REQUESTS', 'IST_SHARE_OF_INTELLIGENT_SEARCH', 'IST_TOTAL_MATCHES', 'FACEBOOK_CHECKINS', 'FACEBOOK_CTA_CLICKS', 'FACEBOOK_LIKES', 'FACEBOOK_IMPRESSIONS', 'FACEBOOK_PAGE_VIEWS', 'FACEBOOK_POST_IMPRESSIONS', 'FACEBOOK_TALKING_ABOUT', 'GOOGLE_USER_PHOTOS', 'SOCIAL_ACTIVITIES', 'FEATURED_MESSAGE_CLICKS'] |
Weeks | Identify events by week. A weeks is always Monday to Sunday, and is labeled with the date corresponding to the first day of that week. | WEEKS | week |
{ "week": "2022-02-14", "ANSWERS_SEARCHES": 1 } |
2/14/22 | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'CLICKS', 'CONVERSION_RATE', 'CONVERSION_SEARCHES', 'SESSIONS', 'CONVERSION_VALUE', 'CONVERSIONS', 'VALUE_PER_CONVERSION', 'EVENT_PROFILEVIEWS', 'EVENT_SEARCHES', 'FACEBOOK_EVENT_NEW_RSVPS', 'TICKET_CLICKS', 'POWERLISTINGS_LIVE', 'BING_SEARCHES', 'DUPLICATES_DETECTED', 'DUPLICATES_SUPPRESSED', 'GOOGLE_CUSTOMER_ACTIONS', 'GOOGLE_MAP_VIEWS', 'GOOGLE_SEARCH_QUERIES', 'GOOGLE_SEARCH_VIEWS', 'LISTINGS_LIVE', 'PROFILE_VIEWS', 'SEARCHES', 'TOTAL_LISTINGS_IMPRESSIONS', 'YELP_PAGE_VIEWS', 'STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'GSC_POSITION', 'GSC_CTR', 'GSC_CLICKS', 'GSC_IMPRESSIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}', 'PROFILE_UPDATES', 'PUBLISHER_SUGGESTIONS', 'AVERAGE_RATING', 'KEYWORD_MENTIONS', 'KEYWORD_SENTIMENT', 'RESPONSE_COUNT', 'RESPONSE_RATE', 'RESPONSE_TIME', 'NEW_REVIEWS', 'IST_AD_MATCHES', 'IST_AD_PRESENCE', 'IST_AVERAGE_FIRST_LOCAL_PACK_MATCH_POSITION', 'IST_AVERAGE_FIRST_MATCH_POSITION', 'IST_AVERAGE_FIRST_ORGANIC_MATCH_POSITION', 'IST_AVERAGE_LOCAL_PACK_NUMBER_OF_RESULTS', 'IST_AVERAGE_LOCAL_PACK_POSITION', 'ST_EVENT_MATCHES_PER_SEARCH', 'ST_EVENT_RICH_RESULT_PRESENCE', 'ST_EVENT_SHARE_OF_INTELLIGENT_SEARCH', 'IST_KNOWLEDGE_CARD_EXISTED', 'IST_LOCAL_PACK_EXISTED', 'IST_LOCAL_PACK_PRESENCE', 'IST_LOCAL_PACK_SHARE_OF_SEARCH', 'IST_MATCHES_PER_SEARCH', 'IST_ORGANIC_SHARE_OF_SEARCH', 'IST_SEARCH_REQUESTS', 'IST_SHARE_OF_INTELLIGENT_SEARCH', 'IST_TOTAL_MATCHES', 'FACEBOOK_CHECKINS', 'FACEBOOK_CTA_CLICKS', 'FACEBOOK_LIKES', 'FACEBOOK_IMPRESSIONS', 'FACEBOOK_PAGE_VIEWS', 'FACEBOOK_POST_IMPRESSIONS', 'FACEBOOK_TALKING_ABOUT', 'GOOGLE_USER_PHOTOS', 'SOCIAL_ACTIVITIES', 'FEATURED_MESSAGE_CLICKS'] |
Traffic Source
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Compatible Metrics |
Platform | Groups data by the platform on which the action measured in metrics was conducted (e.g., Desktop, Mobile). | PLATFORM | platform | String |
{ "Google Search Clicks": 55043, "platform": "Desktop" } |
Desktop | [] |
Visitors
Display Name in Report Builder | Description | Request ID | Response ID | Data Type | Example Response | Example Value | Example Value |
Visitor Email | Email of Unique Visitor who triggered event. | VISITOR_EMAIL | visitor_email | String |
{ "ANSWERS_SEARCHES": 1966, "visitor_email": "alyang+support_demo@yext.com" } |
alyang+support_demo@yext.com | [] |
Visitor ID | ID of Unique Visitor who triggered event. | VISITOR_ID | visitor_id | String |
{ "visitor_id": "13475004", "ANSWERS_SEARCHES": 1966 } |
13475004 | ['STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Visitor ID Method | Method used to identify Visitor. | VISITOR_ID_METHOD | visitor_id_method | String |
{ "visitor_id_method": "YEXT_USER", "ANSWERS_SEARCHES": 19011 } |
YEXT_USER | ['STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Visitor Name | Name of Unique Visitor who triggered event. | VISITOR_NAME | visitor_name | String |
{ "ANSWERS_SEARCHES": 1966, "visitor_name": "Alex Yang" } |
Alex Yang | ['ANSWERS_CLICK_THROUGH_RATE', 'ANSWERS_CLICKS', 'ANSWERS_CLUSTERS', 'ANSWERS_SEARCHES', 'ANSWERS_SEARCHES_WITH_CLICKS', 'ANSWERS_SEARCHES_WITH_KG_RESULTS', 'ANSWERS_SESSIONS', 'ANSWERS_VOICE_SEARCHES', 'ANSWERS_CASE_DEFLECTION_RATE', 'ANSWERS_CASE_DEFLECTIONS', 'ANSWERS_CASE_STARTS', 'ANSWERS_CASE_SUBMITS', 'ANSWERS_KG_RESULT_RATE', 'ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES', 'ANSWERS_SEARCH_TERMS', 'ANSWERS_THUMBS_DOWN_EVENTS', 'ANSWERS_THUMBS_UP_EVENTS', 'STOREPAGES_CALLTOACTIONCLICKS', 'STOREPAGES_CLICKSTOWEBSITE', 'STOREPAGES_DRIVINGDIRECTIONS', 'STOREPAGES_PAGEVIEWS', 'STOREPAGES_SESSIONS', 'STOREPAGES_PHONECALLS', 'STOREPAGES_EVENT_{EVENT_TYPE}'] |
Comments
0 comments
Article is closed for comments.