Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 2.31 KB

search-core.universalsearchresponse.md

File metadata and controls

28 lines (20 loc) · 2.31 KB

Home > @yext/search-core > UniversalSearchResponse

UniversalSearchResponse interface

A representation of a response from a universal search.

Signature:

export interface UniversalSearchResponse 

Properties

Property Type Description
directAnswer? FeaturedSnippetDirectAnswer | FieldValueDirectAnswer (Optional) A direct answer to a search.
failedVerticals? FailedVertical[] (Optional) Error information from when a vertical fails to return results.
locationBias? LocationBias (Optional) Information about the user's location.
queryId? string (Optional) The ID of the search query.
queryRulesActionsData? QueryRulesActionsData[] (Optional) Data returned from the Search query rules system.
searchIntents? SearchIntent[] (Optional) An array of SearchIntents which represents requests from the API.
spellCheck? SpellCheck (Optional) A spellcheck response from a search query.
uuid string A unique id which corresponds to the request.
verticalResults VerticalResults[] An array of VerticalResults which represent the results for each vertical.