v1
latestOpenAPI 3.0.12026-07-139031.1 KBFetch a number of reviews
This is a general purpose endpoint to retrieve reviews about the merchant or company. It is by default limited to 100 reviews at a time. Higher amounts may be requested, but could time out if the request becomes too large.
Path parameters
The SiteId for which you are requesting reviews.
Query parameters
The site's API token.
The first date in your desired range of results. Should be given in YYYY-MM-DD format. Defaults to 30 days prior from the current date.
The last date in your desired range of results. Should be given in YYYY-MM-DD format. Defaults to the current date.
Returns only reviews with the given star rating(s). Provided as a comma separated list without spaces.
How you would like your results sorted upon response. The 'featured' sort type will return only hand-picked reviews.
How many reviews you want the response to include per page. This value must be at least 1.
Include customer full name or abbreviate last name.
The offset of reviews. Starts at page 0.
Include removed reviews? If set to 1 then reviews will include a 'removed' value equal to 1 if the review was removed and 0 if the review is active.
A value of 1 will include reviews that have been marked as test or possible spam.
If true, this will return an XML tree instead of a JSON response.
Response
Success - A JSON dictionary of your reviews will be returned.