Reviews Summary API
      Back to home
      1. Knowledge Base
      2. For Developers
      3. Reviews Summary API

      Reviews API Summary Response

      Note, If you would like to manage your own display solution, Feefo's Review API allows you to retrieve all the data you need. However, this solution is not suitable as a means of batch retrieving review content if you plan to self-host the data due to network edge caching. If you would like to self-host your review content please contact us to discuss the best options taking your requirements into consideration.


      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 

      You can view and run API calls from our developer knowledge base https://feefo.readme.io/reference/reviews-summary-api-response 

      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 parameter Modes Description Authentication 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 pag 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
      summary.product.sku[] product Product 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.title product The 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.description product The 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.url product The 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_url product The 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_url product The 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[] product The 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[].text all, service, product Only 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[].count all, service, product Only 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[].score all, service, product Only 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[].text all, service, product Only 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, product Only 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, product Only 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, product Only 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