Retrieve reviews
GET
/api/v4/locations/{ReviewlocationId}/reviewsThis endpoint retrieves the reviews for the location
Request
Path Params
ReviewlocationId
string
required
The ID of the location to retrieve reviews for
Query Params
category
string
required
The category of reviews to filter by
siteUrls
string
required
The site URLs to filter reviews
startDate
string <date>
required
The start date for the review period
Example:
2021-03-31
endDate
string <date>
required
The end date for the review period
Example:
2024-09-15
ratingFilters
array[string]
required
Filters for ratings
Request samples
Responses
OK(200)
Unauthorized(401)
Record Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
A list of reviews
Data Schema
array of:
reviewId
string
optional
content
string
optional
rating
number
optional
date
string <date-time>
optional
Example
[
{
"reviewId": "string",
"content": "string",
"rating": 0,
"date": "2019-08-24T14:15:22.123Z"
}
]
Last modified: 5 days ago