Retrieve Product Ratings

Retrieve product ratings from the site

Use this endpoint to grab a product's rating from a store if you only have the store's domain/url:

Retrieve Product Ratings

Retrieve a specific product's aggregate rating information (average rating and rating/review count).

GEThttps://api.fera.ai/v3/partners/stores/products/{id}/rating

Authorization

apiKey

Path parameters

id*string

Product ID want to retrieve the rating for. External product ID is also accepted here.

Example: "fpro_12ab"

Query parameters

Response

200404

Successful response

Body

application/json

subjectenum

What is this content about - a specific product, or the store (overall experience)?

productstore

external_product_idstring

Related external product ID (usually the Wix, Shopify or other eCommerce platform product ID).

Example: "12345678"

product_idstring

Related Fera product ID.

Example: "fpro_12ab"

averagenumber (float)

Average rating of the subject (product or store). Only approved reviews/ratings are included in this count.

Example: 4.8

countnumber (int32)

Total number of reviews received about the subject (product or store). Only approved reviews/ratings are included in this count.

Example: 123

ungrouped_averagenumber (float)

Average product rating without product grouping applied.

Example: 4.7

ungrouped_countnumber (int32)

Total number of product reviews/ratings without product grouping applied.

Example: 12

Request

JavaScriptCurlPython

const response = await fetch('https://api.fera.ai/v3/partners/stores/products/{id}/rating?domain=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "subject": "product",
  "external_product_id": "12345678",
  "product_id": "fpro_12ab",
  "average": 4.8,
  "count": 123,
  "ungrouped_average": 4.7,
  "ungrouped_count": 12
}

Code Examples

CURL

curl --request GET \
     --url https://api.fera.ai/v3/partners/stores/products/123456789/rating?domain=example.com \
     --header 'Api-Key: YOUR_PARTNER_API_KEY'
# See JSON response examples above