<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Multi-Language Experiences Track Completed Chat Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
< DOCS HOME
Search
Content Delivery APIs
No results in this galaxy.
Try searching all of Hitchhikers here.
Introduction
Overview - Policies and Conventions
API Availability
Authentication
Versioning
Serialization
Content-Type Headers
PUT Requests
Dates and Times
Account ID
Actor Headers
Response Format
Client vs Yext-assigned IDs
Logging
Errors
Issues and Warnings
Status Codes
Errors and Debugging — Secure Token API
Changelog
October 30, 2024 Release
September 18, 2024 Release
September 10, 2024 Release
August 7, 2024 Release
July 2, 2024 Release
May 15, 2024 Release
April 3, 2024 Release
Content
Content
Content: Get
Content: List
ECLs
Menus: Get
Bios: Get
Products: Get
Events (Legacy): Get
Q&A Submission
Q&A Submission
Question: Create
Review Submission
Review Submission
Review: Create
Review: Update
Review: Delete
Search
Universal Search
Universal Search: Autocomplete
Universal Search: Query
Vertical Search
Vertical Search: Autocomplete
Vertical Search: Query
Vertical Search: Filter Search
Generate Answer
Answer: Generate
Chat
Chat
Chat: Message Endpoint
Legacy
Entities
Entities: List
Entities: Get
Entities: GeoSearch
Entities Schema: Get
Entity Language Profiles: Get
Entity Language Profiles: List
Entity Language Profiles: List All
Locations
Language Profiles (Legacy): Get
Language Profiles Schema (Legacy): Get
Locations (Legacy): Get
Locations (Legacy): List
Locations Schema (Legacy): Get
Locations (Legacy): GeoSearch
home

Changelog

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)

  • Dimensions:

    • Facebook Page Negative Action Type (FB_PAGE_NEGATIVE_ACTION_TYPE)

  • Dimensions that can no longer be used with the Facebook Page Impressions (FACEBOOK_IMPRESSIONS) metric:

    • AGE
    • GENDER
    • COUNTRY
    • CITY
    • LOCALE

  • 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, or MUST_BE_LOGGED_IN
  • algorithmConfiguration: maps to Configure Algorithm setting in the platform
    • list of enum of RATING, RECENCY, or WEBSITE
  • 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

light bulb
BREAKING CHANGES
This release includes updates with breaking changes. Any update with breaking changes will be noted below along with additional setup details.

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

light bulb
BREAKING CHANGES
This update has breaking changes. Read the full post to learn more.

The following updates have been made to the Reviews API:

  • Updated Reviews: Create Management API endpoint
    • Added support for publisherID.
      • publisherId not included in the request and v param before 20240515 (default to External First Party).
      • publisherId not included in the request and v param equal to or after 20240515 (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 replace locationId. Any v param after 20240515 will not accept locationId and require an entityId to be set.
  • Updated Reviews: Update Management API endpoint
    • BREAKING CHANGE. Added support for entityId. This field will replace locationId. Any v param after 20240515 will not accept locationId and require an entityId to be set.
  • 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.
    • Added support for suppressReviewerContact. suppressReviewerContact should default to false. When suppressReviewerContact == 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.


Offset Pagination Deprecation

Management API

light bulb
BREAKING CHANGES
This update has breaking changes. Read the full post to learn more.

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
Feedback