Top Level Meta Data | Yext Hitchhikers Platform

For each page, there are a few top level settings you can set that are specific to that page. These are not visible to the end user but are important for the page to work or for search engines. Learn more in the Edit Page and Component Settings unit .


  "verticalKey": "locations",
  "pageTitle": "Location Search",
  "metaDescription": "Use our search to find locations for our business",
  "canonicalUrl": "",
  "keywords": "Yext, Locations, Offices",

Required Properties

Property Description Example
verticalKey (vertical page only) The verticalKey is the same verticalKey that exists in your Search configuration (e.g., ‘faqs’ or ‘restaurants’). Make sure this matches the key you specified in the Search configuration exactly as this is a common mistake. “faqs”

Optional Properties

Property Description Example
pageTitle While not required, we strongly recommend that you specify the page title, which will appear as the page title in the tab on a browser. We recommend something like “[brandName] Search” for universal search or “[verticalName] Search” on vertical search. This is important for SEO since it helps search engines understand the purpose of the page. “FAQ Search”
metaDescription The meta description provides a concise, human-readable summary of your page’s content. Search engines may include the meta description in search results snippets, so it’s important that this is descriptive and reflective of the content on your page. This should be around 50 to 160 characters in length. Note: You only need to fill this out if Yext is hosting the page on a subdomain “Use our search to find frequently asked questions about our business”
canonicalUrl A canonical tag identifies the primary page or data source when multiple copies of a web page exist at different URLs. In the search context, it helps to ensure that any URL variants (think query parameters) aren’t separately indexed by search engines. Note: You only need to fill this out if Yext is hosting the page on a subdomain.
keywords Keywords are optional - they may help in some search engines to rank content. Google has stopped supporting keywords, but other search engines may use them. Note: You only need to fill this out if Yext is hosting the page on a subdomain. “Yext, Content, Search”