Step 1: Fetch your Reviews

Overview

The Reviews Get and List endpoints allow you to fetch the reviews stored in your account. You can pass query parameters to filter your request based on certain criteria, such as fetching reviews for a specific entity, a specific publisher, or within a given date range.

Reviews: List - Endpoint Information:

Element	Description
URL	https://api.yext.com/v2/accounts/{accountId}/reviews
Permissions	Reviews: READ
Description	Retrieve all Reviews matching the provided criteria

Example Request:

GET https://api.yext.com/v2/accounts/{accountId}/reviews?api_key={API_KEY}&v=20210504&minPublisherDate=2020-04-02

Example Response:

"response": {
        "reviews": [
            {
                "id": 1128344100,
                "rating": 5.0,
                "content": "Exceptional food, exceptional service. Highly recommend the quinoa bowl - so delicious and nutritious!",
                "authorName": "Wendy S.",
                "authorEmail": "wendy@gmail.com",
                "url": "",
                "publisherDate": 1619012392000,
                "locationId": "7972419111777200246",
                "accountId": "1283278",
                "publisherId": "FIRSTPARTY",
                "lastYextUpdateTime": 1619029039610,
                "comments": [
                    {
                        "id": 188861974,
                        "publisherDate": 1619029039610,
                        "authorName": "Delish and Nutrish",
                        "authorEmail": "johnsmith123@gmail.com",
                        "authorRole": "BUSINESS_OWNER",
                        "content": "\r\n\r\nThank you for the review.",
                        "visibility": "PUBLIC"
                    }
                ],
                "status": "LIVE",
                "reviewLabels": [
                    {
                        "id": 913,
                        "name": "Positive"
                    },
                    {
                        "id": 203,
                        "name": "Service"
                    }
                ],
                "externalId": "b6df38d7-4aa3-4308-af33-1c4489cbea64",
                "flagStatus": "NOT_FLAGGED",
                "reviewLanguage": "en"
            },
            {
                "id": 1128343515,
                "rating": 5.0,
                "content": "The donuts here are truly amazing. I had the one with raspberry sprinkles!",
                "authorName": "Matthew H",
                "authorEmail": "matthew@gmail.com",
                "url": "",
                "publisherDate": 1619011978000,
                "locationId": "6915443573468587404",
                "accountId": "1283278",
                "publisherId": "FIRSTPARTY",
                "lastYextUpdateTime": 1619012205591,
                "comments": [
                    {
                        "id": 188813686,
                        "publisherDate": 1619012205591,
                        "authorName": "Demo User (johnsmith123@yext.com)",
                        "authorEmail": "johnsmith123@yext.com",
                        "authorRole": "BUSINESS_OWNER",
                        "content": "So glad that you enjoyed the donuts! The raspberry sprinkle is a special only available for the month of April - be sure to tell your friends to come try it before it's gone!",
                        "visibility": "PUBLIC"
                    }
                ],
                "status": "LIVE",
                "reviewLabels": [
                    {
                        "id": 913,
                        "name": "Positive"
                    }
                ],
                "externalId": "8740b563-da5d-4c2d-a7a2-22ca4ac06f0d",
                "flagStatus": "NOT_FLAGGED",
                "reviewLanguage": "en"
            }
  }

As with most other Yext endpoints, you can also fetch a specific record using the ID - in this case, the Review ID. You can find a Review ID from the Reviews: List API response, or by clicking the “View” or “Respond” button on a review in the Yext Platform and examining the URL to find the Review ID.

Review: Get - Endpoint Information:

Element	Description
URL	https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}
Permissions	Reviews: READ
Description	Retrieve a specific Review

Example Request:

GET https://api.yext.com/v2/accounts/{accountId}/reviews/{reviewId}?api_key={API_KEY}&v=20210504

Things to note:

Reviews for certain publishers are not available to be fetched via API
If you intend to publish this set of reviews on a consumer-facing website, we recommend filtering to only reviews with status =”LIVE” & “flagStatus”=”NOT_FLAGGED”. This filter ensures that no quarantined, removed, or flagged reviews will be included in the results of your request.

Feedback

<% elem.innerText %>