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

get

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

Authorizations

apiKeyoauth2

api_keystringRequired

You can find your partner API key in your partner portal dashboard.

Path parameters

idstringRequired

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

Example: fpro_12ab

Query parameters

domainstringRequired

Domain, URL, public key or Fera ID of the shop/store.

Example: example.myshopify.com

Responses

200

Successful response

application/json

subjectstring · enumOptional

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

Possible values:

external_product_idstringOptional

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

Example: 12345678

product_idstringOptional

Related Fera product ID.

Example: fpro_12ab

averagenumber · floatRead-onlyOptional

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

Example: 4.8

countnumber · int32Read-onlyOptional

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

Example: 123

ungrouped_averagenumber · floatRead-onlyOptional

Average product rating without product grouping applied.

Example: 4.7

ungrouped_countnumber · int32Read-onlyOptional

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

Example: 12

404

Not found error

application/json

get

/stores/products/{id}/rating

HTTPcURLJavaScriptPython

GET /v3/partners/stores/products/{id}/rating?domain=text HTTP/1.1
Host: api.fera.ai
Accept: */*

{
  "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