Yext Knowledge APIInstall

Summary

Retrieve a paginated list of reviews from the Yext Knowledge API filtered by various optional criteria such as entity IDs, publisher IDs, date ranges, languages, rating bounds, and more.

Inputs

• Account Id (required) — The Yext account identifier to query reviews for.
• V (required) — API version date in YYYYMMDD format, required for date-based and certain filter behavior.
• Limit — Number of reviews to return in the response (default 10).
• Offset — Number of results to skip for pagination, cannot be used with pageToken.
• Entity Ids — List of entity IDs to filter reviews for specific entities.
• Api Identifiers — Filter reviews by specific API identifiers.
• Folder Id — Filter reviews to those belonging to locations within a specified folder and its subfolders.
• Countries — Filter reviews by location countries using ISO 3166 2-letter codes.
• Location Labels — Filter reviews by location labels.
• Publisher Ids — Filter reviews by specified publisher IDs.
• Review Content — Filter reviews containing specified content string.
• Min Rating — Filter reviews with at least this rating.
• Max Rating — Filter reviews with at most this rating.
• Min Publisher Date — Filter reviews published on or after this date (YYYY-MM-DD). Behavior depends on version parameter.
• Max Publisher Date — Filter reviews published on or before this date (YYYY-MM-DD). Behavior depends on version parameter.
• Min Last Yext Update Date — Filter reviews last updated by Yext on or after this date (YYYY-MM-DD). Behavior depends on version parameter.
• Max Last Yext Update Date — Filter reviews last updated by Yext on or before this date (YYYY-MM-DD). Behavior depends on version parameter.
• Awaiting Response — Filter reviews awaiting owner replies, by review, comment, or both.
• Min Non Owner Comments — Filter reviews with at least this number of comments from non-owners.
• Reviewer Name — Filter reviews whose author's name contains this string.
• Status — Filter reviews by status, effective with version 20170830 or later.
• Page Token — Pagination token to retrieve the next page of results, effective with version 20170901 or later.
• Review Language — Filter reviews by language(s) using ISO 639-1 codes (comma separated).
• Label Ids — Filter reviews by review label IDs.
• Review Type — Filter Facebook reviews by type ('Rating' or 'Recommendation'), effective with version 20181002 or later.
• Recommendation — Filter Facebook reviews by recommendation status, effective with version 20181002 or later.
• Flag Status — Filter reviews by flagging status indicating inappropriate content.
• Is Yext Response Eligible — Filter reviews based on eligibility to receive responses via Yext.

Output shape

A JSON object containing a list of review records matching the filters, typically paginated and including metadata such as nextPageToken if available.

Supports pagination through 'limit', 'offset', and 'pageToken' depending on API version. Many filters are optional, allowing refined queries. Returned data structure depends on Yext API specification for reviews, including review content, ratings, dates, statuses, and associated metadata.