Review Management | Hitchhikers

Reviews: List

Retrieve all Reviews matching the given criteria.

NOTE: Not all publishers' reviews will be included in the response. For more details, please contact your Account Manager.

path Parameters

accountId

required

string

query Parameters

v required	string A date in `YYYYMMDD` format.
limit	integer <= 100 Default: 10 Number of results to return.
offset	integer <= 9900 Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`. If the `v` parameter is before `20211115`, the maximum offset is not enforced. However, users are still encouraged to migrate to `pageToken` for queries requiring large offsets, as these may result in errors.
entityIds	Array of strings When provided, only reviews for the requested entities will be returned. Before 12/13/21, the parameter name was `locationIds`. Specifying either `locationsIds` or `entityIds` as the parameter name will have the same result. By default, reviews will be returned for all entities subscribed to Review Monitoring. Example: entity123,entity456,entity789
apiIdentifiers	Array of strings When provided, only reviews for the requested API identifiers will be returned.
folderId	string When provided, only reviews for locations in the given folder and its subfolders will be included in the results.
countries	Array of strings When present, only reviews for locations in the given countries will be returned. Countries are denoted by ISO 3166 2-letter country codes.
locationLabels	Array of strings When present, only reviews for locations with the provided labels will be returned.
publisherIds	Array of strings List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. Example: MAPQUEST,FACEBOOK
reviewContent	string When specified, only reviews that include the provided content will be returned.
minRating	number <double> When specified, only reviews with the provided minimum rating or higher will be returned.
maxRating	number <double> When specified, only reviews with the provided maximum rating or lower will be returned.
minPublisherDate	string <date> (`YYYY-MM-DD` format) When specified, only reviews with a publisher date on or after the given date will be returned. If the `v` parameter is before `20170617`: returns reviews with a publisher date on or after the given date in EST If the `v` parameter is `20170617` or later: returns reviews with a publisher date on or after the given date in UTC
maxPublisherDate	string <date> (`YYYY-MM-DD` format) When specified, only reviews with a publisher date on or before the given date will be returned. If the `v` parameter is before `20170617`: returns reviews with a publisher date on or before the given date in EST If the `v` parameter is `20170617` or later: returns reviews with a publisher date on or before the given date in UTC
minLastYextUpdateDate	string <date> (`YYYY-MM-DD` format) When specified, only reviews with a last Yext update date on or after the given date will be returned. If the `v` parameter is before `20170617`: returns revies with a last Yext update date on or after the given date in EST If the `v` parameter is `20170617` or later: returns revies with a last Yext update date on or after the given date in UTC
maxLastYextUpdateDate	string <date> (`YYYY-MM-DD` format) When specified, only reviews with a last Yext update date on or before the given date will be returned. If the `v` parameter is before `20170617`: returns reviews with a last Yext update date on or before the given date in EST If the `v` parameter is `20170617` or later: returns reviews with a last Yext update date on or before the given date in UTC
awaitingResponse	string Enum: "REVIEW" "COMMENT" "REVIEW_OR_COMMENT" When specified, only reviews that are awaiting an owner reply on the given objects will be returned. For example, when `awaitingResponse=COMMENT`, reviews will only be returned if they have at least one comment that has not been responded to by the owner.
minNonOwnerComments	integer When specified, only reviews that have at least the provided number of non-owner comments will be returned.
reviewerName	string When specified, only reviews whose authorName contains the provided string will be returned.
status	string Enum: "LIVE" "QUARANTINED" "REMOVED" When specified, only reviews with the given `status` values will be returned. The `status` parameter will only be respected with the inclusion of a `v` parameter of `20170830` or later.
pageToken	string If a response to a previous request contained the `nextPageToken` field, pass that field's value as the `pageToken` parameter to retrieve the next page of data. The `pageToken` parameter will only be respected with the inclusion of a `v` parameter of `20170901` or later.
reviewLanguage	string When provided, only reviews in the given languages will be included in the results. Languages must be specified by their ISO 639-1 codes. If specifying multiple languages, enter the language codes as a comma-separated list. Example: 'en,fr,zh'
labelIds	Array of strings When present, only reviews with the provided review label IDs will be returned.
reviewType	string Enum: "Rating" "Recommendation" When specified, only reviews that are of the given `reviewType` will be returned. Only applicable to Facebook reviews. The `reviewType` parameter will only be respected with the inclusion of a `v` parameter of `20181002` or later.
recommendation	string Enum: "Recommended" "Not Recommended" When specified, only reviews with the given `recommendation` value will be returned. Only applicable to Facebook reviews. The `recommendation` parameter will only be respected with the inclusion of a `v` parameter of `20181002` or later.
flagStatus	string Enum: "FLAGGED" "NOT_FLAGGED" When specified, only reviews with the given `flagStatus` value will be returned. `flagStatus` indicates whether the review has been flagged for inappropriate or irrelevant content. For review publishing, Yext recommends filtering to reviews with `flagStatus = NOT_FLAGGED`, as flagged reviews are being examined for inappropriate or irrelevant content. Note that only First Party and External First Party reviews can be flagged.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"averageRating": 0,
"reviews": [{"id": 0,
"locationId": "string",
"accountId": "string",
"publisherId": "string",
"rating": 0,
"title": "string",
"content": "string",
"authorName": "string",
"authorEmail": "string",
"url": "string",
"publisherDate": 0,
"lastYextUpdateTime": 0,
"status": "LIVE",
"flagStatus": "FLAGGED",
"reviewLanguage": "string",
"comments": [{"id": 0,
"parentId": 0,
"publisherDate": 0,
"authorName": "string",
"authorEmail": "string",
"authorRole": "BUSINESS_OWNER",
"content": "string",
"visibility": "PUBLIC",
"date": "2019-08-24",
"suppressReviewerContact": true
}
],
"labelIds": [0
],
"reviewLabels": [{"id": 0,
"name": "string"
}
],
"reviewType": "Rating",
"recommendation": "Recommended",
"transactionId": "string",
"invitationId": "string",
"apiIdentifier": "string"
}
],
"nextPageToken": "string"
}
}

Reviews: Create

Create a new External First Party Review.

path Parameters

accountId

required

string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

entityId required	string ID of the entity associated with this review.
authorName required	string The name of the person who wrote the review.
rating required	number <double> Normalized rating out of 5.
content	string Content of the review.
authorEmail	string The email address of the person who wrote the review.
status	string Enum: "LIVE" "QUARANTINED" "REMOVED" The current status of the review; only returned for First Party and External First Party reviews. Defaults to `QUARANTINED` when creating.
date	string <date> If the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date you received the review from the customer. Date defaults to the date the review was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00
publisherId	string The ID of the publisher associated with the review. If v parameter is after 20240515, defaults to `FIRSTPARTY`. If v parameter is before 20240515, defaults to `EXTERNALFIRSTPARTY`.
externalId	string The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per entity and publisher pair.
invitationUid	string The ID of the invitation which should be associated with this review.

Responses

Request samples

Payload

Content type

application/json

{"entityId": "string",
"authorName": "string",
"rating": 0,
"content": "string",
"authorEmail": "string",
"status": "LIVE",
"date": "2019-08-24",
"publisherId": "string",
"externalId": "string",
"invitationUid": "string"
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Review: Get

Retrieve a specific Review.

path Parameters

accountId required	string
reviewId required	integer ID of this Review.

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": 0,
"locationId": "string",
"accountId": "string",
"publisherId": "string",
"rating": 0,
"title": "string",
"content": "string",
"authorName": "string",
"authorEmail": "string",
"url": "string",
"publisherDate": 0,
"lastYextUpdateTime": 0,
"status": "LIVE",
"flagStatus": "FLAGGED",
"reviewLanguage": "string",
"comments": [{"id": 0,
"parentId": 0,
"publisherDate": 0,
"authorName": "string",
"authorEmail": "string",
"authorRole": "BUSINESS_OWNER",
"content": "string",
"visibility": "PUBLIC",
"date": "2019-08-24",
"suppressReviewerContact": true
}
],
"labelIds": [0
],
"reviewLabels": [{"id": 0,
"name": "string"
}
],
"reviewType": "Rating",
"recommendation": "Recommended",
"transactionId": "string",
"invitationId": "string",
"apiIdentifier": "string"
}
}

Review: Update

Updates an External First Party Review or a First Party Review.

NOTE: Despite using the PUT method, Reviews: Update only updates supplied fields. Omitted fields are not modified.

path Parameters

accountId required	string
reviewId required	integer ID of this Review.

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

locationId	string ID of the location associated with this review
rating	number <double> Normalized rating out of 5. Can only be specified for External First Party Reviews.
content	string Content of the review. Can only be specified for External First Party Reviews.
authorName	string The name of the person who wrote the review. Can only be specified for External First Party Reviews.
authorEmail	string The email address of the person who wrote the review. Can only be specified for External First Party Reviews.
status	string Enum: "LIVE" "QUARANTINED" "REMOVED" The current status of the review.

Responses

Request samples

Payload

Content type

application/json

{"locationId": "string",
"rating": 0,
"content": "string",
"authorName": "string",
"authorEmail": "string",
"status": "LIVE"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

Comment: Create

Creates a new Comment on a Review.

Required fields

content

Optional fields
parentId
visibility

path Parameters

accountId required	string
reviewId required	integer ID of this Review.

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

parentId	integer If this comment is in response to another comment, this is the ID of the parent comment.
content	string Content of the comment.
visibility	string Enum: "PUBLIC" "PRIVATE" Defaults to `PUBLIC` when creating a comment
date	string <date> If the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date the comment was posted. Date defaults to the date the comment was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date the comment was posted. Date defaults to the date the comment was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00
suppressReviewerContact	boolean Indicates whether or not the reviewer receives an email notification when a comment is posted. Defaults to `false`.

Responses

Request samples

Payload

Content type

application/json

{"parentId": 0,
"content": "string",
"visibility": "PUBLIC",
"date": "2019-08-24",
"suppressReviewerContact": true
}

Response samples

201
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": 0
}
}

Comment: Generate

Gets a content generated response for a particular review

path Parameters

accountId required	string
reviewId required	integer ID of this Review.

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"content": "string"
}
}

Comment: Update

Updates a Comment on a Review.

Optional fields

content
visibility

path Parameters

accountId required	string
reviewId required	integer ID of this Review.
commentId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

content	string Content of the comment.
visibility	string Enum: "PUBLIC" "PRIVATE"

Responses

Request samples

Payload

Content type

application/json

{"content": "string",
"visibility": "PUBLIC"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Comment: Delete

Deletes a Comment on a Review.

path Parameters

accountId required	string
reviewId required	integer ID of this Review.
commentId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}

Review Labels: Update

Adds the specified review labels to the specified review.

path Parameters

accountId required	string
reviewId required	integer ID of this Review.

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

labelIds

Array of integers

The IDs of the review labels added to the review.

Responses

Request samples

Payload

Content type

application/json

{"labelIds": [0
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": 0,
"labelIds": [0
]
}
}