API Reference
SupportSiteVibes Login

Products Reviews

get
https://api.sitevibes.com/v1/product-reviews

Returns list of product reviews

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Identifier used to differentiate different applications api is used in

integer
Defaults to 1

The page of paginated data that will be returned

integer
1 to 100
Defaults to 20

The maximum number of objects that may be returned

string

return only reviews for specific product

string

return only reviews created from specific email address

boolean
Defaults to false

return only summary information without reviews

string
enum
Defaults to newest

Sorting logic for returned reviews

  • newest - order by Newest reviews
  • oldest - order by Oldest reviews
  • rating-desc - order by review rating descending
  • rating-asc - order by review rating ascending
  • votes-desc - order by review votes descending
  • votes-asc - order by review votes ascending
Allowed:
date

Return only reviews created since selected date

date

Return only reviews updated since selected date

string

Include additional information, multiple options can be seperated by comma

  • summary - include data with total reviews, rating, rating distribution
  • media - include published media inside each review
integer
1 to 5

Return only reviews with specified rating value

string

Return only reviews with specified keyword

string

Filter results, multiple options can be seperated by comma

  • rating - filter reviews by rating, example rating:4
  • has:media - filter only reviews that have attached media
  • customFieldX - filter reviews by custom field value, example customField23:Great
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?