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 parameterModes  DescriptionAuthent-
ication required
summary.merchant.identifierall, service, product, nps The merchant identifier the response relates to.

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

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

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

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

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

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

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

No
Response parameterModes  DescriptionAuthent-
ication required
summary.rating.minnpsThe lowest possible NPS score. The default is -100.Yes
summary.rating.maxall, service, product The 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, 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.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, service A count of the number of 1 star rated service reviews included within the result set.
No
summary.rating.service.2_starall, service A count of the number of 2 star rated service reviews included within the result set.
No
summary.rating.service.3_starall, service A count of the number of 3 star rated service reviews included within the result set.
No
summary.rating.service.4_starall, service A count of the number of 4 star rated service reviews included within the result set.
No
Response parameterModes  DescriptionAuthent-
ication required
summary.rating.service.5_starall, service A count of the number of 5 star rated service reviews included within the result set.
No
summary.rating.service.countall, service A count of the number of service reviews included within the result set.
No
summary.rating.product.1_starall, product A count of the number of 1 star rated product reviews included within the result set.
No
summary.rating.product.2_starall, product A count of the number of 2 star rated product reviews included within the result set.
No
summary.rating.product.3_starall, product  A count of the number of 3 star rated product reviews included within the result set.
No
summary.rating.product.4_starall, product A count of the number of 4 star rated product reviews included within the result set.
No
summary.rating.product.5_starall, product A count of the number of 5 star rated product reviews included within the result set.
No
summary.rating.product.countall, product A count of the number of product reviews included within the result set.
No
summary.rating.product.attributes[].nameproduct The 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
Response parameterModes  DescriptionAuthent-
ication required
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 1.  
Yes
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
Response parameterModes  DescriptionAuthent-
ication required
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[]
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


Response parameterModes  DescriptionAuthent-
ication required
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


Response parameterModes  DescriptionAuthent-
ication required
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


The data returned from a reviews API call is described in the following table. For documentation purposes, the format of each parameter has been abbreviated to the form reviews.<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/all?merchant_identifier=example-retail-merchant

This API call would produce the following review data from Feefo (for brevity, only a single customer review consisting of service feedback and two sets of product feedback is displayed below):


{     "summary": {         "meta": {             "count": 3878,             "pages": 194,             "page_size": 20,             "current_page": 1         }     },     "reviews": [         {             "merchant": {                 "identifier": "example-retail-merchant"             },             "url": "http://www.feefo.com/en_GB/reviews/example-retail-merchant/572f69dd498ee99ed9348e49/customer-review-fab-as-usual",             "social": {                 "facebook": "http://www.facebook.com/dialog/share?app_id=88240596850xxxx&href=http%3A%2F%2Fwww.feefo.com%2Fen_GB%2Freviews%2Fexample-retail-merchant%2F572f69dd498ee99ed934xxxx%2Fcustomer-review-fab-as-usual&redirect_uri=http%3A%2F%2Fwww.fee.fo%2FyOrn22",                 "twitter": "http://twitter.com/intent/tweet?text=&url=http%3A%2F%2Fwww.fee.fo%2FyOrn22&via=Feefo_Official"             },             "customer": {                 "display_name": "Emily"            },             "service": {                 "rating": {                     "min": 1,                     "max": 5,                     "rating": 5                 },                 "id": "5733aab0498edc149d51xxxx",                 "title": "Fab as usual",                 "review": "Speedy deliver, easy to use website.",                 "created_at": 1463003823439,                 "helpful_votes": 0             },             "products": [                 {                     "rating": {                         "min": 1,                         "max": 5,                         "rating": 5                     },                     "id": "5733aaaf498edc149d51xxxx",                     "review": "Gorgeous scarf, so nice I wanted to keep it myself rather than give it for a gift.",                     "product": {                         "title": "White and Black Stripped Scarf",                         "sku": "1234",                         "url": "http://www.exampleretailmerchant.co.uk/white-and-black-stripped-scarf",                         "reviews_url": "http://www.feefo.com/en_GB/reviews/example-retail-merchant/products/white-and-black-stripped-scarf?sku=1234"                     },                     "created_at": 1463003823983,                     "helpful_votes": 0                 },                 {                     "rating": {                         "min": 1,                         "max": 5,                         "rating": 5                     },                     "id": "5733aab0498edc149d51726b",                     "review": "Smells gorgeous & a the recipe is attached.",                     "product": {                         "title": "Strawberry Cheesecake Candle",                         "sku": "12345",                         "url": "http://www.exampleretailmerchant.co.uk/strawberry-cheescake-candle",                         "reviews_url": "http://www.feefo.com/en_GB/reviews/example-retail-merchant/products/strawberry-cheesecake-candle?sku=12345"                     },                     "created_at": 1463003824282,                     "helpful_votes": 0                 }             ]         },      ] }
 

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 parameterModes DescriptionAuthent-ication required
summary.meta.countall, service, product, nps The total number of matching sales corresponding to the feedback result set.No
summary.meta.pagesall, service, product, nps The number of pages of results available.No
summary.meta.page_sizeall, service, product, nps The number of results per page.No
summary.meta.current_pageall, service, product, nps The current page of results being returned.No
reviews[].merchant.identifierall, service, product, nps The merchant identifier the feedback relates to. Suppressed when include_children = false.No
reviews[].last_updated_dateall, service, product, nps The UTC date/time the customer’s review was last updated.No
reviews[].products_purchased[]all, service, product, npsThe title of all products associated with the sale (including those which have not received feedback).No
reviews[].tags[].keyall, service, product, nps The key of the sale tag associated with the feedback.Yes
reviews[].tags[].values[]all, service, product, nps The value of the sale tag associated with the feedback, there may be multiple values corresponding to the specified key.Yes
Response parameterModes DescriptionAuthent-ication required
reviews[].tags[].typeall, service, product, npsThe type of tag associated with the feedback:
  • sale – provided as part of the sale upload.
  • feedback – applied via Insight Tags.
Yes
reviews[].urlall, service, productThe URL of the review on Feefo’s site.No
reviews[].social.facebookall, service, product The URL of the Facebook share link for the review.No
reviews[].social.twitterall, service, product  The URL of the Twitter share link for the review.No
reviews[].social.google_plus all, service, product The URL of the Google+ share link for the review.No
reviews[].customer.display_nameall, service, product The name the customer has provided to share alongside the review. Where the customer has opted out of displaying their identity this value will be omitted.No
reviews[].customer.display_locationall, service, productThe location the customer has provided to share alongside the review. Where the customer has opted out of displaying their identity this value will be omitted.No
reviews[].customer.nameall, service, product, nps The name of the customer as provided in the original sale uploadYes
reviews[].customer.emailall, service, product, npsThe email address of the customer as provided in the original sale uploadYes
reviews[].customer.mobileall, service, product, npsThe mobile phone number of the customer as provided in the original sale uploadYes
Response parameterModes DescriptionAuthent-ication required
reviews[].customer.order_refall, service, product, nps The order reference associated with the feedbackYes
reviews[].customer.customer_refall, service, product, nps  The customer reference associated with the feedback. This will only be included where there is an associated customer reference.Yes
reviews[].service.rating.minall, service The lowest possible Feefo rating. The default is 1.0.No
reviews[].service.rating.maxall, service The highest possible Feefo rating. The default is 5.0.No
reviews[].service.rating.ratingall, service The service rating assigned to the feedback, between 1 and 5. Where the customer has re-rated their feedback the most recent rating assigned will be returned.No
reviews[].service.idall, serviceThe feedback id for the service review element.No
reviews[].service.created_atall, serviceThe UTC date/time the service feedback was created.No
reviews[].service.titleall, serviceThe title assigned to the service feedback. Where the customer has chosen not to provide a title this will be omitted.No
reviews[].service.reviewall, serviceThe customer’s original review of the merchant’s service.No
reviews[].service.helpful_votesall, serviceThe number of helpful votes the service feedback has received.No
Response parameterModes DescriptionAuthent-ication required
reviews[].service.media[].idall, serviceThe Object ID of the media item.No
reviews[].service.media[].type all, serviceThe type of media attached to the service feedback (photo/video).No
reviews[].service.media[].url all, serviceThe URL to the media item.No
reviews[].service.media[].thumbnail all, serviceThe URL to the video static thumbnail. Only present for type = video.No
reviews[].service.media[].caption all, serviceThe consumer-provided caption for the media item.No 
reviews[].service.media[].helpful_votes all, serviceThe number of helpful votes the service media item has received.No
reviews[].service.custom[].question_idall, serviceThe unique ID of the custom service question.Yes
reviews[].service.custom[].questionall, serviceThe title of the custom service question. This is only included if the customer provided a response to the question.Yes
reviews[].service.custom[].answerall, serviceThe response to the custom service question. This is only included if the customer provided a response to the question.Yes
reviews[].service.sentiment.features[].text
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The text of any features associated with the service review in order of sentiment score, highest to lowest.
No        
Response parameterModes DescriptionAuthent-ication required
reviews[].service.sentiment.features[].score
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of any features associated with the service review in order of sentiment score, highest to lowest.
No
reviews[].service.sentiment.positive_snippets[].text
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
A list of the positively categorised snippets associated with the service review ordered by sentiment score, highest to lowest.
No
reviews[].service.sentiment.positive_snippets[].score
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of the positively categorised snippets associated with the service review ordered by sentiment score, highest to lowest.
No
reviews[].service.sentiment.negative_snippets[].text
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
A list of the negatively categorised snippets associated with the service review ordered by sentiment score, lowest to highest.
No
reviews[].service.sentiment.negative_snippets[].score
all, service
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of the negatively categorised snippets associated with the service review ordered by sentiment score, lowest to highest.
No
reviews[].service.thread[].created_atall, serviceThe UTC date/time the thread entry was created.No
reviews[].service.thread[].typeall, serviceThe type of thread entry:
  • customer_comment – an additional comment made by the customer.
  • customer_rerate – an adjustment made to the service rating by the customer.
  • customer_retitle - an adjustment made to the service review title by the customer.
  • merchant_comment – a response from the merchant to the customer’s comments.
No
reviews[].service.thread[].authorall, serviceThe display name of the person who created the thread entry.No
reviews[].service.thread[].commentall, serviceThe comment corresponding to the thread entry. This will be absent for customer_rerate.No
reviews[].service.thread[].old_ratingall, serviceThe previous service rating assigned by the consumer, between 1 and 5. Only present for customer_rerate (between 1 and 5).No
Response parameterModes DescriptionAuthent-ication required
reviews[].service.thread[].new_ratingall, serviceThe new service rating assigned by the consumer, between 1 and 5. Only present for customer_rerate (between 1 and 5).No
reviews[].service.thread[].old_titleall, serviceThe old review title. Only present for reviews[].service.thread[].type = customer_retitle.
No
 reviews[].service.thread[].new_titleall, serviceThe new review title. Only present for reviews[].service.thread[].type = customer_retitle.
No
reviews[].products[].product.titleall, productThe title of the product which has been reviewed.No
reviews[].products[].product.parent_skuall, productThe parent SKU assigned to the product. This will only be displayed where a value has been assigned.No
reviews[].products[].product.skuall, productThe SKU assigned to the product.No
reviews[].products[].product.tags[].keyall, productThe key of the product tag associated with the product feedback.Yes
reviews[].products[].product.tags[].values[]all, productThe value of the product tag associated with the product feedback. There may be multiple values associated with the specified key.Yes
reviews[].products[].product.tags[].typeall, productThe type of tag associated with the feedback:
  • product – provided as part of the sale upload, corresponds to the specific order line.
  • feedback – applied via Insight Tags.
Yes
reviews[].products[].product.urlall, productThe URL of the product on the merchant’s website. In order of preference the following URL will be returned:
  • Product URL specified in an uploaded catalogue.
  • Product URL specified in the sales file.
  • URL specified as the product forwarding URL within merchant settings.
  • URL specified as the website forwarding URL within merchant settings.
No
Response parameterModes DescriptionAuthent-ication required
reviews[].products[].product.reviews_urlall, productThe URL for all reviews for the product on Feefo’s website in the form:
  • http://www.feefo.com/locale/reviews/merchant-identifier/products/product-name?sku=product-sku 
Where a parent product SKU has been provided the link will pass through the parent SKU.
No
reviews[].products[].product.image_urlall, productThe URL of the product image stored by Feefo, as uploaded via the product catalogue. Where an image is unavailable this will be omitted.No
reviews[].products[].rating.minall, productThe lowest possible Feefo rating. The default is 1.0.No
reviews[].products[].rating.maxall, productThe highest possible Feefo rating. The default is 5.0.No
reviews[].products[].rating.ratingall, productThe product rating assigned to the feedback, between 1 and 5. Where the customer has re-rated their feedback the most recent rating assigned will be returned.No
reviews[].products[].attributes[].nameall, productThe name of the product attribute which has been rated.No
reviews[].products[].attributes[].minall, productThe minimum rating which could have been assigned to the attribute. The default is 1.0.No 
reviews[].products[].attributes[].max all, productThe maximum rating which could have been assigned to the attribute. The default is 5.0.No 
reviews[].products[].attributes[].ratingall, product The rating which has been assigned to the attribute, between 1 and 5. No 
reviews[].products[].id all, product The feedback id for the product review element. No 
Response parameterModes DescriptionAuthent-ication required
reviews[].products[].created_at all, product  The UTC date/time the product feedback was created.No
reviews[].products[].review all, product  The customer’s original review of the product.No 
reviews[].products[].helpful_votesall, product The number of helpful votes the product feedback has received.No 
reviews[].products[].media[].id all, product The Object ID of the media item.No 
reviews[].products[].media[].type all, product The type of media attached to the product feedback:
  • photo
  • video 
No 
reviews[].products[].media[].url all, product The URL to the media item. No
reviews[].products[].media[].thumbnail all, product The URL to the video static thumbnail. Only present for type = video. No
reviews[].products[].media[].captionall, product The consumer provided caption for the media item.No 
reviews[].products[].media[].helpful_votes all, productThe number of helpful votes the product media item has received.No
reviews[].products[].media[].social.facebookall, productThe URL of the Facebook share link for the review.        No
Response parameterModes DescriptionAuthent-ication required
reviews[].products[].media[].social.twitterall, productThe URL of the Twitter share link for the review.        No
reviews[].products[].media[].social.google_plusall, productThe URL of the Google+ share link for the review.     No
reviews[].products[].custom[].questionall, product The title of the custom product question. This is only included if the customer provided a response to the question.Yes
reviews[].products[].custom[].answer all, product The response to the custom product question. This is only included if the customer provided a response to the question. Yes
reviews[].products[].sentiment.features[].text
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The text of any features associated with the product review in order of sentiment score, highest to lowest.
No        
reviews[].products[].sentiment.features[].score
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of any features associated with the product review in order of sentiment score, highest to lowest.
No
reviews[].products[].sentiment.positive_snippets[].text
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
A list of the positively categorised snippets associated with the product review ordered by sentiment score, highest to lowest.
No
reviews[].products[].sentiment.positive_snippets[].score
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of the positively categorised snippets associated with the product review ordered by sentiment score, highest to lowest.
No
reviews[].products[].sentiment.negative_snippets[].text
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
A list of the negatively categorised snippets associated with the product review ordered by sentiment score, lowest to highest.
No
reviews[].products[].sentiment.negative_snippets[].score
all, product
Only included if the account has Smart Themes enabled and enhanced_insight = include.
The sentiment score between -1 and +1 of the negatively categorised snippets associated with the product review ordered by sentiment score, lowest to highest.
No
Response parameterModes DescriptionAuthent-ication required
reviews[].products[].thread[].created_at all, product The UTC date/time the thread entry was created. No
reviews[].products[].thread[].type all, product The type of thread entry:
  • customer_comment – an additional comment made by the customer.
  • customer_rerate – an adjustment made to the service rating by the customer.
  • customer_attribute_rerate – an adjustment made to a product attribute rating by the customer.
  • merchant_comment – an response from the merchant to the customer’s comments. 
No 
reviews[].products[].thread[].author all, product The display name of the person who created the thread entry. No 
reviews[].products[].thread[].comment all, product The comment corresponding to the thread entry. This will be absent for customer_rerate. No 
reviews[].products[].thread[].old_rating all, product The previous service rating assigned by the consumer, between 1 and 5. Only present for customer_rerate (between 1 and 5). No 
reviews[].products[].thread[].new_rating all, product The new service rating assigned by the consumer, between 1 and 5. Only present for customer_rerate (between 1 and 5). No 
reviews[].products[].thread[].attributes[].nameall, productThe name of the attribute which has been rerated. Only present for reviews[].products[].thread[].type = customer_attribute_rerate.
No
reviews[].products[].thread[].attributes[].old_ratingall, productThe old attribute rating. Only present for reviews[].products[].thread[].type = customer_attribute_rerate (between 1 and 5).No
reviews[].products[].thread[].attributes[].new_ratingall, productThe new attribute rating. Only present for reviews[].products[].thread[].type = customer_attribute_rerate (between 1 and 5).No
reviews[].nps.created_at all, npsThe UTC date/time the NPS feedback was created. Yes
Response parameterModes DescriptionAuthent-ication required
reviews[].nps.rating all, nps The NPS rating the customer has assigned to the feedback, between 0 and 10. This will only be included where a rating has been provided. Yes 
reviews[].nps.reason all, nps  The reason the customer has provided to accompany their NPS rating. This will only be included where a reason has been provided.