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
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
get
/stores/products/{id}/rating
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 --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
PreviousList ReviewsNextCheck if Site is Using Fera

Last updated

Was this helpful?