Yext Answers APIInstall

Summary

Perform a filter search on the Yext Answers API to retrieve filters matching a user's input within a specific account, experience, and vertical scope.

Inputs

• Account Id (required) — Identifier for the Yext account to which the search request is scoped.
• V (required) — A date string in YYYYMMDD format indicating the API version to use.
• Experience Key (required) — Key uniquely identifying the Search experience.
• Vertical Key (required) — Key uniquely identifying the vertical to scope the filter search request within.
• Locale (required) — Locale code of the experience, e.g., en_GB.
• Input (required) — Search term entered by the user to find matching filters.
• Search Parameters (required) — URL-encoded JSON string detailing filter search parameters, including which fields to filter on and optionally whether to fetch entities and section results.
• Version — Experience configuration label or version number, e.g., STAGING or PRODUCTION; defaults to PRODUCTION if omitted.
• Excluded — URL-encoded JSON array specifying filter values to exclude from the results.
• Request Options — Optional HTTP request settings including batching, SSL verification skip, proxy, and timeout controls.

Output shape

a JSON response from the Yext Answers API containing filters that match the user's input and search parameters.

The response includes matching filters scoped to the given account, experience, vertical, and locale. Filters may be sectioned if requested. Supports request batching and optional exclusion filters. Errors will be returned in the API's error envelope.