Skeepers
API docs by Redocly

Product Reviews API (1.0.0)

Download OpenAPI specification:

Introduction

Welcome to the Skeepers Product Reviews API documentation! This API empowers you to explore the ratings and reviews associated with your products, enabling seamless synchronization with your system and unlocking the full potential of User-Generated Content (UGC)!

With the Product Reviews API, you can:

  • Retrieve product ratings.
  • Access detailed product reviews.

This documentation provides clear examples and guidance on how to use the API's individual endpoints.

API URL

The base URL for accessing the Product Reviews API is:

https://api-product-reviews.rr.skeepers.io/v1

Get product ratings

Retrieve product ratings for one or more products associated with a website.

A product rating represents the collective assessment of customers' experiences with a particular product. It includes the average rating, total number of reviews, and the distribution of ratings from 1 to 5 stars.

path Parameters
website_id
required
string <uuid>
Example: 5f7b1b3a-5b0b-4b5a-9b0a-5e8b1b3a5b0b

The ID of the website.

query Parameters
ref
string
Example: ref=ref1,ref2,ref3

Optional: The urlencoded product reference(s) to fetch ratings for. If not specified, returns data for all products. Use ',' as a separator for multiple references. Prefer alphabetical order for better caching.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product reviews

Retrieve product reviews for one or more products associated with a website.

A product review provides detailed feedback from customers, including the review text, rating, date, language, customer information, product information, associated comments and more.

The reviews are sorted by descending publication date, from the most recent to the oldest.

This API returns reviews by product reference. Which means any filter will be applied to the list of reviews for each product reference and not on a list of reviews directly. For example, if you only filter by rate, the API will return an object of all your product references as keys and the reviews for each product reference as values which will be filtered by the rate you provided.

path Parameters
website_id
required
string <uuid>
Example: 5f7b1b3a-5b0b-4b5a-9b0a-5e8b1b3a5b0b

The ID of the website.

query Parameters
ref
string
Example: ref=ref1,ref2,ref3

Optional: The urlencoded product reference(s) to fetch reviews for. If not specified, returns data for all products. Use ',' as a separator for multiple references. Prefer alphabetical order for better caching.

rate
string
Example: rate=1,2,3,4,5

Optional: The rate of the reviews you want to filter on. This value must be between 1 and 5.

sortBy
string
Example: sortBy=publish_date,firstname,review

Optional: Sort on any reviews field. Use the exact name of the variable in the reviews.

sortDirection
string
Example: sortDirection=ASC,DESC

Optional: Choose the direction in which the sorting will occur. Either ASC for ascending or DESC for descending

limit
integer
Example: limit=10

Optional: The maximum number of reviews to return per product.

offset
integer
Example: offset=5

Optional: The number of reviews to skip.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}