Here we'll take a closer look at the available parameters and values for the Review API endpoint that retrieves summary information such as counts and average scores (no detailed review content is included. The parameters for detailed content can be found at Reviews API Request Parameters (Reviews).
https://api.feefo.com/api/version/reviews/summary/

Note that in all examples on this page, version should be replaced with the appropriate version number of the API. The current version number for Reviews API can be found in API Versions.

There are four possible modes for this endpoint:

  1. https://api.feefo.com/api/version/reviews/summary/all

    mode = all: Creates a summary for both your service and product reviews. Authentication is not required.


  2. https://api.feefo.com/api/version/reviews/summary/service

    mode = service: Creates a summary of your service reviews. Authentication is not required. 


  3. https://api.feefo.com/api/version/reviews/summary/product

    mode = product: Creates a summary of your product reviews. Authentication is not required.


  4. https://api.feefo.com/api/version/reviews/summary/nps

    mode = nps: Creates a summary of your NPS feedback. Authentication is required. See API Authentication for more details.


The following table lists all parameters available for the https://api.feefo.com/api/version/reviews/summary/ endpoint. Click on the parameter name for more details:

Request parameterBrief description ValueRequired or optionalDefault Authentication required 
merchant_identifier 
Unique identifier for the merchant account.stringRequiredNoneNo
tags 
Filter for reviews with corresponding tags. stringOptionalNoneNo
date_time 
Filter reviews to those created on a specified UTC date / time. stringOptionalNone 
No
updated_date_time 
Filter reviews to those updated on a specified UTC date / time. stringOptionalNone 
No 
since_period 
Filter reviews to those created during the specified period. enumOptionalyearNo
since_updated_period 
Filter reviews to those updated during the specified period. enumOptionalyearNo
originDefines the domain name of the web page calling the Reviews API feed.
stringOptional but required when using multiple domains to call the same reviews API feed
NoneNo
id 
Filter reviews based on the feedback id. stringOptionalNone 
No 
parent_product_sku 
Filter for product reviews assigned to the specified parent product search code. stringOptional for:
mode = all
mode = service
mode = nps
Required for:
mode = product (if product_sku is not used)
None 
No
product_sku 
Filter for product reviews assigned to the specified product search code. stringOptional for:
mode = all
mode = service
mode = nps
 
Required for:
mode = product (if parent_product_sku is not used)
 
None 
No
customer_reference 
Filter for reviews from a specific customer based on a unique customer reference. stringOptionalNone 
Yes
customer_email 
Filter for reviews from a specific customer email. stringOptionalNone 
Yes 
order_reference 
Retrieve the feedback relating to a specific order. stringOptionalNone 
Yes
rating
Defines the number of stars or the NPS score that the reviews should have to be included in the feed.
stringOptionalNoneNo
children 
Specified if feedback from child account should be included in the result set. enumOptionalinclude No 
media 
Specifies filters applied to feedback with associated media. enumOptionalincludeNo 
empty_product_comments 
Specifies how product reviews with no comments should be handled. enumOptionaldefaultNo 
unanswered_feedback 
Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.enumOptionalinclude No 
enhanced_insight
Only functional if the account has Smart Themes enabled.
Specifies if enhanced insight data should be included in the API response.
enumOptionalexcludeNo
feature
Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter.
Filter reviews to those that include the associated feature.

stringOptional for:
mode = service
mode = product
Unsupported for:
mode = all
mode = nps
NoneNo
Reviews API IntroductionReviews API Response Parameters (Summary)