Changelog
December 11, 2024 Release
Updated Query Matching Behavior
Management API and Live API
Historically, when querying for entities in the Management API and Live API , filters have been treated as a prefix match. With this release, these will be treated as an exact match.
For example, if an account has a field with the following options:
burgerburger_deluxeburger_bacondouble_burger
With the prefix matching behavior, a query for entities where the option = “burger” (i.e., {"c_optionSingle": {"$eq": "burger"}) would return entities with any of the following options specified:
burgerburger_deluxeburger_bacon
With the updated exact matching behavior, the same query above would return entities with only the following option specified:
burger
This update is behind a v parameter of 20241211.
Send Review Invitations at a Specific Time
Management API - Reviews
We have added new fields to the Review Invitations: Create endpoint to support scheduling a specific time when sending review generation invitations via API.
There are two formats to specify when to send them: delay and send time. You can specify delayTime, the amount of time to wait before sending the invitation after the upload is processed, with delayTimeUnit in either hours or days. Alternatively, you can provide a SPECIFIC date and time, using the sendTime parameter, as an ISO formatted date/time value, e.g., 2024-09-04T12:00:00.
To learn more about sending and scheduling review generation invitations, see the Sending Review Generation Invitations unit .
Eligibility API
Management API - Social
With this release, we are introducing the new Eligibility API. You can use the Eligibility: List endpoint to fetch publisher eligibility for a given set of entities.
Decommission Deprecated Facebook and Google Metrics
Management API - Reports
In the October release , we announced that Facebook and Google had deprecated various metrics. As of this release, users can no longer view new or historical data for these metrics
Deprecated Google Business Conversations Metric
Management API - Reports
Google has deprecated the Business_Conversations metric.
As a result, Business Conversations will no longer be included as an Action type within the Google Listings Action metric in Yext reporting.
October 30, 2024 Release
Additional Social Post Metrics
Management API - Reports
We have added 6 new analytics metrics for Social. The following metrics will be available to use when creating reports:
- Facebook Post Like Count (
FB_POST_LIKE_COUNT) - Facebook Post Comment Count (
FB_POST_COMMENT_COUNT) - Facebook Post Share Count (
FB_POST_SHARE_COUNT) - Instagram Post Like Count (
IG_POST_LIKE_COUNT) - Instagram Post Comment Count (
IG_POST_COMMENT_COUNT) - Instagram Post Share Count (
IG_POST_SHARE_COUNT)
Deprecated Facebook Social and Listings Analytics
Management API - Reports
The following Facebook metrics and dimensions have been deprecated by Facebook. Yext stopped pulling in data for these metrics and dimensions as of September 16, 2024. You will be able to view historical data for these metrics and dimensions in Yext until the next release (December 11, 2024).
Metrics:
- Facebook Check-Ins (
FB_PAGE_PLACES_CHECKIN_TOTAL_UNIQUE) - Facebook Page Unique Negative Actions (
FB_PAGE_NEGATIVE_FEEDBACK_UNIQUE) - Facebook Page Clicks (
FB_PAGE_CONSUMPTIONS_UNIQUE) - Facebook Post Engaged Fans (
FB_POST_ENGAGED_FANS) - Facebook Post Unique Negative Actions (
FB_POST_UNIQUE_NEGATIVE_ACTIONS) - Facebook Post Unique Clicks (
FB_POST_UNIQUE_CLICKS)
- Facebook Check-Ins (
Dimensions:
- Facebook Page Negative Action Type (
FB_PAGE_NEGATIVE_ACTION_TYPE)
- Facebook Page Negative Action Type (
Dimensions that can no longer be used with the Facebook Page Impressions (
FACEBOOK_IMPRESSIONS) metric:AGEGENDERCOUNTRYCITYLOCALE
Option that can no longer be used with the Facebook Impression Type dimension:
ORGANIC
Google Business Food Items Metric Deprecated
Management API - Reports
The Google “Business Food Items” metric will be available in Yext to view historical data until March 30, 2025 (by using the BUSINESS_FOOD_ORDERS Listings Action with the ORDER_NOW dimension). Yext stopped pulling in data for this metric as of September 16, 2024.
September 18, 2024 Release
Third-Party Review Generation
Management API - Reviews
We have added new fields to the Review Generation Settings: Update endpoint to support the review balancing algorithm needed for third-party review generation:
balancingOptimization: maps to Balancing Algorithm setting in the platform- enum of
DISTRIBUTION,MORE_REVIEWS, orMUST_BE_LOGGED_IN
- enum of
algorithmConfiguration: maps to Configure Algorithm setting in the platform- list of enum of
RATING,RECENCY, orWEBSITE
- list of enum of
siteDistribution: the distribution of desired review generation from each publisher, including first-party reviews, and the corresponding weight for that publisher- map of string to integer
To learn more about the review balancing algorithm, see this training unit.
September 10, 2024 Release
Video Posting via API
Management API - Social
We have added the ability for users to upload a video to Yext and create a post using the Yext hosted video.
For further context: there will be two endpoints that a user must hit. One is to upload the video, the second is to create the post (and added a param in our existing create post endpoint here ).
August 7, 2024 Release
The updates for this release are automatically available for all versions.
Indicate Nearest Location for Linked Location Searches
Content Delivery API - Search
We have added new properties to the response for Search API queries (
Universal Search: Query
and
Vertical Search: Query
endpoints) where a geolocation search is conducted on a list of linked entities. Within each list of linked entities, the API response will indicate which linked location is closest to the user (by returning nearestToUser as true) and which is closest to any searched location filter (by returning nearestToFilter as true). nearestToFilter will only be populated if there’s a matched location filter for the search, such as “doctors in Arlington” matching on Arlington.
For more information on how to use these new response parameters, check out the Geolocation Search for Linked Locations guide .
Google Food Menu Clicks Metric Available
Management API - Listings
Google Food Menu Clicks is now an available metric. Use the
Reports endpoint
in the Management API and request the google_customer_actions metric with the Action dimension to return the number of Food Menu Clicks.
July 2, 2024 Release
Use ConsumerFeedbackCache to Power ConsumerFeedbackAPI
Management API - Reviews
We have added support for a pageToken parameter when paginating through API requests made to the
Review Invitations: List endpoint
. The pageToken parameter will only be respected with the inclusion of a v param of 20240626 or later.
May 15, 2024 Release
The updates for this release are automatically available for all versions.
Additional Ownership Detail in Rejected Add Request Statuses
Management API - Agreements
We have added more values to the statusDetail property for rejected API requests made to an
Add Requests endpoint
. These additional status details help inform when there are instances of duplicates in your own account, in another account, or in your own and another account.
Notify Users Setting for Creating Users via API
Management API - Account Settings
A notifyUser field has been added to the the
Create User endpoint
. When this field is set to true, an email notification will be sent to the user to confirm user creation.
Content Generation for Review Response Support in CaC & API
Management API - Reviews | Config-as-Code
Users leveraging Generative Review Response can now generate responses via CaC resources and the Reviews API.
Within the
CaC API
, we have added a new resource: reviews/response-generation-settings. This is where you can add instructions to inform the model on how it should generate review responses based on custom criteria.
We have also added a Comment: Generate endpoint in the Reviews API to generate review responses using AI.
To learn more about Generative Review Response, see this training unit .
April 3, 2024 Release
Any updates that require specific versioning will be behind v param of 20240515 for this release. When using this new v param, all of those specified updates will be made to your account so it is important that you read the full post for more details.
Add Status Details Title to Listings API
Management API - Listings
Status Details Title is now viewable in the API as unavailableReasonType within statusDetails. This categorizes and gives a title to the previously available message property. To see a full list of possible statuses, see
this reference doc
.
This feature is included with v param 20240515 or after.
Reviews API Improvements
Management API - Reviews
The following updates have been made to the Reviews API:
- Updated Reviews: Create Management API endpoint
- Added support for
publisherID.publisherIdnot included in the request and v param before20240515(default to External First Party).publisherIdnot included in the request and v param equal to or after20240515(default to First Party).
- Added support for
externalId. The External ID of the review is typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair. - Added support for
invitationUid. - BREAKING CHANGE. Added support for
entityId. This field will replacelocationId. Any v param after20240515will not acceptlocationIdand require anentityIdto be set.
- Added support for
- Updated Reviews: Update Management API endpoint
- BREAKING CHANGE. Added support for
entityId. This field will replacelocationId. Any v param after20240515will not acceptlocationIdand require anentityIdto be set.
- BREAKING CHANGE. Added support for
- Updated Comments: Create Management API endpoint
- Added support for date.
- Date is parsed as an ISO-8601 datetime with offset, datetime (assumed UTC), or date (assumed midnight UTC) past the v param date of
20240515. - Unifying date behavior across our three different create endpoints (Comment: Create and Review: Create in Review Management, and Review: Create in Review Submission) past the v param date of
20240515.
- Date is parsed as an ISO-8601 datetime with offset, datetime (assumed UTC), or date (assumed midnight UTC) past the v param date of
- Added support for
suppressReviewerContact.suppressReviewerContactshould default to false. WhensuppressReviewerContact== true, we will not contact the reviewer. This field is only settable for first-party reviews. - Updated review submission endpoint’s date behavior and stored date as timestamp in API models.
- Added support for date.
Offset Pagination Deprecation
Management API
As of May 15, 2024, Offset Pagination will no longer be supported for our
Management APIs
. V params before this date will continue to support offset pagination, but all v params after this date must use our cursor pagination method to paginate requests to the Management API. To utilize cursor pagination, users will need to use the pageToken param instead of the offset param.
Please ensure that API integrations that do not currently use cursor pagination switch to that method, or use a v param before 20240515 until ready to switch.
Updated Review Response Attribution via API
Management API - Reviews
Any new review responses created through the Yext API will not be attributed to a specific Yext user. When a review response is not attributed to a specific Yext user, authorName and authorEmail will be blank in the API response.
Specific Account Scope in Users API
Management API - Account Settings
The onType values have been updated in the Users API. The enum value “EVERYTHING” has been added which gives a user access to an account and all of its sub-accounts. “ACCOUNT” has been updated to only give access to a specific account.
Previously, “ACCOUNT” gave access to an account and all of its sub-accounts.
For brands with sub-accounts that want to give their users access to specific accounts rather than all accounts, they will need to use v param 20240515 or after.
Google Analytics Metrics No Longer Accessible
Management API - Analytics
Google legacy metrics will be inaccessible as of May 15th for all API versions. Any API calls made to fetch the following metrics will return an error response:
- Google Customer Actions (Legacy):
GOOGLE_CUSTOMER_ACTIONS - Google Map Views (Legacy):
GOOGLE_MAP_VIEWS - Google Phone Calls (Legacy):
GOOGLE_PHONE_CALLS - Google Search Queries (Legacy):
GOOGLE_SEARCHES - Google Search Views (Legacy):
GOOGLE_SEARCH_VIEWS