The data returned from a summary API call is described in the following table. For documentation purposes, the format of each parameter has been abbreviated to the form summary.<parameter_name>.<parameter_name> whereas in fact the data would be presented in a similar format to the following example:


https://api.feefo.com/api/20/reviews/summary/all?merchant_identifier=example-retail-merchant

This would produce the following review data from Feefo:

{   
  
"merchant": {    
    "identifier": "example-retail-merchant",    
    "name": "Example Retail Merchant",
    "url": "<http://www.exampleretailmerchant.co.uk">,
    "logo": "example-retail-merchant-logo.png",
    "review_url": "<http://www.feefo.com/en_GB/reviews/example-retail-merchant">  
},  

"meta": {
    "count": 3878,
    "pages": 194,
    "page_size": 20
},   

"rating": {
    "min": 1,
    "max": 5,
    "rating": 4.9, 
    "service": {
         "count": 3878,
         "1_star": 8,
         "2_star": 28,
         "3_star": 0,
         "4_star": 181,
         "5_star": 3661
 },  

"product": {
    "count": 6240,
    "1_star": 55,
    "2_star": 102,
    "3_star": 0,
    "4_star": 724,
    "5_star": 5359
}
}

Note: Any parameter listed in the table with square brackets [] could have an array/multiple results. For example, reviews[].service.custom[] indicates there may be multiple reviews, each of which will have just one service review within which there may be multiple custom question responses.



Response parameterModesDescriptionAuthentication required
summary.merchant.identifierall, service, product, npsThe merchant identifier the response relates to.No
summary.merchant.nameall, service, product, npsThe merchant display name of the account the response relates to.No
summary.merchant.urlall, service, product, npsThe merchant’s website forwarding URLNo
summary.merchant.review_urlall, service, product, npsThe URL of the merchant’s Feefo page, for example, www.feefo.com/reviews/merchant_identifierNo
summary.merchant.logoall, service, product, npsThe URL of the merchant’s logo held on Feefo.No
summary.meta.countall, service, product, npsThe total number of sales corresponding to the feedback result set.No
summary.meta.pagesall, service, product, npsThe number of pages of results available.No
summary.meta.page_sizeall, service, product, npsThe number of results per pagNo
summary.rating.minall, service, productThe lowest possible Feefo average rating. The default is 1.0.No
summary.rating.minnpsThe lowest possible NPS score. The default is -100.Yes
summary.rating.maxall, service, productThe highest possible Feefo average rating. The default is 5.0.No
summary.rating.maxnpsThe highest possible NPS score. The default is 100.Yes
summary.rating.ratingall, serviceThe average 5_ score for all service ratings within the result set rounded to 1 decimal place. Where there are no reviews available for the specified query 0.0 will be returned.No
summary.rating.ratingproductThe average 5 star score for all product ratings within the result set rounded to 1 decimal place. Where there are no reviews available for the specified query 0.0 will be returned.No
summary.rating.ratingnpsThe NPS score for the result set calculated as follows: ((X/Z) _ 100) – ((Y/Z) * 100) where: X = total feedbacks where NPS = 9 or 10, R = total feedbacks where NPS = 7 or 8, Y = total feedbacks where NPS <= 6, Z = total feedbacks which have an NPS score.Yes
summary.rating.service.1_starall, serviceA count of the number of 1 star rated service reviews included within the result set.No
summary.rating.service.2_starall, serviceA count of the number of 2 star rated service reviews included within the result set.No
summary.rating.service.3_starall, serviceA count of the number of 3 star rated service reviews included within the result set.No
summary.rating.service.4_starall, serviceA count of the number of 4 star rated service reviews included within the result set.No
summary.rating.service.5_starall, serviceA count of the number of 5 star rated service reviews included within the result set.No
summary.rating.service.countall, serviceA count of the number of service reviews included within the result set.No
summary.rating.product.1_starall, productA count of the number of 1 star rated product reviews included within the result set.No
summary.rating.product.2_starall, productA count of the number of 2 star rated product reviews included within the result set.No
summary.rating.product.3_starall, productA count of the number of 3 star rated product reviews included within the result set.No
summary.rating.product.4_starall, productA count of the number of 4 star rated product reviews included within the result set.No
summary.rating.product.5_starall, productA count of the number of 5 star rated product reviews included within the result set.No
summary.rating.product.countall, productA count of the number of product reviews included within the result set.No
summary.rating.product.attributes[].nameproductThe name of the product attribute.No
summary.rating.product.attributes[].minproductThe lowest possible Feefo average rating for the product attribute. The default is 1.0.No
summary.rating.product.attributes[].maxproductThe highest possible Feefo average rating for the product attribute. The default is 5.0.No
summary.rating.product.attributes[].ratingproductThe average 5 star score for the product attribute within the result set rounded to 1 decimal place over the specified time period.No
summary.rating.product.attributes[].countproductThe count of ratings for this attribute within the result set rounded to 1 decimal place.No
summary.rating.nps.nps_0npsThe number of NPS responses rated as 0.Yes
summary.rating.nps.nps_1npsThe number of NPS responses rated as 1Yes
summary.rating.nps.nps_2npsThe number of NPS responses rated as 2.Yes
summary.rating.nps.nps_3npsThe number of NPS responses rated as 3.Yes
summary.rating.nps.nps_4npsThe number of NPS responses rated as 4.Yes
summary.rating.nps.nps_5npsThe number of NPS responses rated as 5.Yes
summary.rating.nps.nps_6npsThe number of NPS responses rated as 6.Yes
summary.rating.nps.nps_7npsThe number of NPS responses rated as 7.Yes
summary.rating.nps.nps_8npsThe number of NPS responses rated as 8.Yes
summary.rating.nps.nps_9npsThe number of NPS responses rated as 9.Yes
summary.rating.nps.nps_10npsThe number of NPS responses rated as 10.Yes
summary.rating.nps.promotersnpsThe number of NPS ratings for 9 or 10.Yes
summary.rating.nps.passivesnpsThe number of NPS ratings for 7 or 8.Yes
summary.rating.nps.detractorsnpsThe number of NPS ratings <= 6.Yes
summary.product.parent_skuproductParent product search code the reviews relates to. A parent product search code can span multiple product search codes / variants. If this value is not set against the product it will not be returned.No
summary.product.sku[]productProduct search code the review relates to. Where multiple product SKUs are returned from the use of a parent product search code, an array of product SKUs will be returned. Where a wildcard product SKU has been submitted in the request, the wildcard value will be returned.No
summary.product.titleproductThe title of the product for the corresponding parent product search code / product search code. This will be sourced in the following order:

1. Google product feed supplied title where provided.
2. Feefo product catalogue uploaded product title.
3. Sale provided product title.		No
summary.product.descriptionproductThe description of the product as supplied in:

1. The Google product feed.
2. The Feefo product catalogue upload. If it has not been supplied, the value will be omitted from the feed		No
summary.product.urlproductThe URL of the product on the merchant’s website. In order of preference, the following URL will be returned:

1. The product URL specified in the Google product feed.
2. The product URL specified in an uploaded catalogue.
3. The product URL specified in the sales file.
4. The URL specified as the product forwarding URL within the merchant settings.
5. The URL specified as the website forwarding URL within the merchant settings.		No
summary.product.reviews_urlproductThe URL for all reviews for the product on Feefo’s website http://ww2.feefo.com/locale/reviews/merchant-identifier/products/?sku=
Where a parent product SKU has been provided the link will pass through the parent SKU.
The product title should be included in the URL which will be sourced in the following order:

1. The Google product feed supplied title where provided.
2. The Feefo product catalogue uploaded product title.
3. The sale provided product title.		No
summary.product.image_urlproductThe URL of the product image stored by Feefo, as uploaded via:

1. The Google product feed.
2. The Feefo product catalogue.
Where an image is unavailable, this will be omitted.		No
summary.product.additional_image_url[]productThe URLs of any additional product images stored by Feefo as uploaded via the Google product feed. Where additional images are unavailable, this will be omitted.No
summary.sentiment.features[].textall, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, the text of the top 50 mentioned features associated with the service in order of count of occurrences, highest to lowest.
If mode = product, the text of the top 50 mentioned features associated with the selected products in order of count of occurrences, highest to lowest.		No
summary.sentiment.features[].countall, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, the count of any features associated with the service in order of count of occurrences, highest to lowest.
If mode = product, the count of any features associated with the selected products in order of count of occurrences, highest to lowest.		No
summary.sentiment.features[].scoreall, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, the average sentiment score between -1 and +1 of any features associated with the service in order of count of occurrences, highest to lowest.
If mode = product, the average sentiment score between -1 and +1 of any features associated with the selected products in order of count of occurrences, highest to lowest.		No
summary.sentiment.positive_snippets[].textall, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, a list of the top 10 positively categorised snippets associated with the service feedback ordered by sentiment score, highest to lowest.
If mode = product, a list of the top 10 positively categorised snippets associated with the product feedback ordered by sentiment score, highest to lowest.		No
summary.sentiment.positive_
snippets[].score		all, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, the sentiment score between -1 and +1 of the top 10 positively categorised snippets associated with the service feedback ordered by sentiment score, highest to lowest.
If mode = product, the sentiment score between -1 and +1 of positively categorised snippets associated with the product feedback ordered by sentiment score, highest to lowest.		No
summary.sentiment.negative_
snippets[].text		all, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, list of the top 10 negatively categorised snippets associated with the service feedback ordered by sentiment score, lowest to highest.
If mode = product, a list of the top 10 negatively categorised snippets associated with the product feedback ordered by sentiment score, lowest to highest.		No
summary.sentiment.negative_
snippets[].score		all, service, productOnly included if the account has Smart Themes enabled and enhanced_insight = include.
If mode = service or mode = all, the sentiment score between -1 and +1 of negatively categorised snippets associated with the service feedback ordered by sentiment score, lowest to highest.
If mode = product, the sentiment score between -1 and +1 of the top 10 negatively categorised snippets associated with the product feedback ordered by sentiment score, lowest to highest.		No