Request parameter
 Value
 Required or optional
 Default
 Endpoints
 Authentication required 
rating
 string
 Optional
 None
 summary, reviews
 No

rating defines the number of stars or the NPS score that the reviews should have to be returned within the Reviews API feed.

The possible values for rating will depend on the mode:

  • For mode = all, mode = service and mode = product, the request can include a rating of one or more integer values between 1 and 5, each separated by a comma.
  • For mode = nps, the request can include a rating of one or more integer values between 0 and 10, each separated by a comma.
The level of filtering also depends on the mode:
  • mode = all
    The review will be suppressed if the service or product has a star rating which does not match a value listed in rating.
  • mode = service
    The review will be suppressed if the service has a star rating which does not match a value listed in rating.
  • mode = product
    The review will be suppressed if the product has a rating which does not match a value listed in rating.
  • mode = nps
    The review will be suppressed if the NPS score which does not match a value listed in rating.
An example Reviews API call using rating is:
https://api.feefo.com/api/version/reviews/all?merchant_identifier=example-retail-merchant&rating=4,5

Where:

  • version = the version of the API associated with the URL. See API Versions for the version number.
  • all = returns both service and product reviews.
  • merchant_identifier = the merchant's unique Feefo identifier, which in this example is example-retail-merchant.
  • rating = a filter that is applied to the results to show reviews with only these ratings. In this example, as the mode = all, only reviews with a service and product star rating of 4 or 5 will be displayed.
     

Full details about the API can be found at Reviews API (Customisable Integration).

Reviews API Parameter: order_referenceReviews API Parameter: children