Yext Answers APIInstall

Summary

Send a search query to the Yext Answers API to retrieve search results from a specified Yext account and search experience.

Inputs

• Account Id (required) — The identifier for the Yext account to query.
• V (required) — A date in YYYYMMDD format specifying the API version date.
• Experience Key (required) — A string key that uniquely identifies the Search experience.
• Locale (required) — The locale code of the experience to filter results (e.g. 'en_GB').
• Input (required) — The search term input by the user to query.
• Version — The label or version number of the experience configuration to use, such as 'STAGING' or 'PRODUCTION'. Defaults to 'PRODUCTION' if omitted.
• Location — User's location as a comma separated latitude and longitude (e.g. '40.740957,-73.987565').
• Session Id — UUID used to track session state when cookies are blocked.
• Limit — JSON object string specifying result limits per vertical; keys are verticals and values are numbers from 1-50.
• Query Trigger — String value logged for analytics indicating query trigger, e.g., 'suggest' or 'initialize'.
• Context — URL-encoded JSON string passed to query rules for triggering custom behavior.
• Referrer Page Url — URL of the webpage that referred to the request's page.
• Skip Spell Check — Boolean to skip spell checking; defaults to true.
• Restrict Verticals — Comma-separated list of verticals to restrict results to.
• Ignore Query Rules — Boolean to ignore Query Rules affecting results; defaults to true.
• Query Id — UUID to associate multiple requests as the same query session.
• Source — Indicates source of the query for analytics; defaults to 'STANDARD'.
• Js Lib Version — Deprecated: version of the Search UI used for the request.
• Request Options — Settings for batching requests, proxy, timeout, and SSL certificate handling.

Output shape

a single JSON object containing the search results from the Yext Answers API

The response is returned as JSON and includes the search results based on the specified input and parameters. Pagination and detailed error responses depend on the API behavior but are not explicitly documented here.