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/version/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 that 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 parameter Modes   Description Authent-
ication required
summary.merchant.identifier all, service, product, nps  The merchant identifier the response relates to.

No
summary.merchant.name all, service, product, nps  The merchant display name of the account the response relates to.

No
summary.merchant.url all, service, product, nps  The merchant’s website forwarding URL.

No
summary.merchant.review_url all, service, product, nps  The URL of the merchant’s Feefo page, for example, www.feefo.com/reviews/merchant_identifier No
summary.merchant.logo all, service, product, nps  The URL of the merchant’s logo held on Feefo.

No
summary.meta.count all, service, product, nps  The total number of sales corresponding to the feedback result set.

No
summary.meta.pages all, service, product, nps  The number of pages of results available.

No
summary.meta.page_size all, service, product, nps  The number of results per page.

No
summary.rating.min all, service, product  The lowest possible Feefo average rating. The default is 1.0.

No
summary.rating.min nps The lowest possible NPS score. The default is -100. Yes
summary.rating.max all, service, product  The highest possible Feefo average rating. The default is 5.0.

No
summary.rating.max nps The highest possible NPS score. The default is 100. Yes
summary.rating.rating all, service  The 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.rating product The 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.rating nps The 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_star all, service  A count of the number of 1 star rated service reviews included within the result set.

No
summary.rating.service.2_star all, service  A count of the number of 2 star rated service reviews included within the result set.

No
summary.rating.service.3_star all, service  A count of the number of 3 star rated service reviews included within the result set.

No
summary.rating.service.4_star all, service  A count of the number of 4 star rated service reviews included within the result set.

No
summary.rating.service.5_star all, service  A count of the number of 5 star rated service reviews included within the result set.

No
summary.rating.service.count all, service  A count of the number of service reviews included within the result set.

No
summary.rating.product.1_star all, product  A count of the number of 1 star rated product reviews included within the result set.

No
summary.rating.product.2_star all, product  A count of the number of 2 star rated product reviews included within the result set.

No
summary.rating.product.3_star all, product   A count of the number of 3 star rated product reviews included within the result set.

No
summary.rating.product.4_star all, product  A count of the number of 4 star rated product reviews included within the result set.

No
summary.rating.product.5_star all, product  A count of the number of 5 star rated product reviews included within the result set.

No
summary.rating.product.count all, product  A count of the number of product reviews included within the result set.

No
summary.rating.product.attributes[].name product  The name of the product attribute.

No
summary.rating.product.attributes[].min product The lowest possible Feefo average rating for the product attribute. The default is 1.0.

No
summary.rating.product.attributes[].max product The highest possible Feefo average rating for the product attribute. The default is 5.0.

No
summary.rating.product.attributes[].rating product The 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[].count product The count of ratings for this attribute within the result set rounded to 1 decimal place.

No
summary.rating.nps.nps_0 nps The number of NPS responses rated as 0.    

Yes
summary.rating.nps.nps_1 nps The number of NPS responses rated as 1.  

Yes
summary.rating.nps.nps_2 nps The number of NPS responses rated as 2.    

Yes
summary.rating.nps.nps_3 nps The number of NPS responses rated as 3.  

Yes
summary.rating.nps.nps_4 nps The number of NPS responses rated as 4.    

Yes
summary.rating.nps.nps_5 nps The number of NPS responses rated as 5.    

Yes
summary.rating.nps.nps_6 nps The number of NPS responses rated as 6.  

Yes
summary.rating.nps.nps_7 nps The number of NPS responses rated as 7.    

Yes
summary.rating.nps.nps_8 nps The number of NPS responses rated as 8.  

Yes
summary.rating.nps.nps_9 nps The number of NPS responses rated as 9.  

Yes
summary.rating.nps.nps_10 nps The number of NPS responses rated as 10.

Yes
summary.rating.nps.promoters nps The number of NPS ratings for 9 or 10.

Yes
summary.rating.nps.passives nps The number of NPS ratings for 7 or 8.

Yes
summary.rating.nps.detractors nps The number of NPS ratings <= 6.

Yes
summary.product.parent_sku product Parent 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
Reviews API Request Parameters (Summary)Reviews API Request Parameters (Reviews)