Retrieve Summarised Features

Summarised Features provides the list of all features best and worst along with their quotes , that consumers can use in the product reviews to describe the product.

GET /summarised-features

curl -X 'GET' \
  'https://[stg.]api.bazaarvoice.com/sentiment/v1/summarised-features?productId=1000004682&embed=quotes&language=de ’\
--header ‘Authorization: passKey’ \
  -H 'accept: application/json'

'https://[stg.]api.bazaarvoice.com/sentiment/v1/summarised-features?productId=1000004682&embed=quotes&language=de' \
--header ‘Authorization: passKey’

Header	Description
Authorization	Passkey (API key) provided to client for authentication

Query Parameters

Request Parameter	Description	Required
productId	Unique identifier of the product for which you want to retrieve features	Yes
embed	Use ‘quotes’ to get list of embedded quotes.	No
language	Supported Languages – English (en), French (fr), German (de) and Spanish(es). You cannot pass multiple languages. Locales (ex- en_US, en_CA, fr_CA) are not supported.	Yes

Sample Response

{
  "bestFeatures": [
    {
      "featureId": "string",
      "feature": "string",
      "percentPositive": 0,
      "nativeFeature": "string",
      "reviewsMentioned": {
        "total": 90,
        "positive": 84,
        "negative": 0,
        "incentivized": 0
      },
      "averageRatingReviews": {
        "positive": 5.5,
        "negative": 0,
        "incentivized": 0
      },
      "_embedded": {
        "quotes": [
          {
            "quoteId": "EoA591P2Xi3/khB9osEG5l6cMtD5biVJ+r9FYMLG9KBIh8JmHqlSxRU4yP1ghuH9eXpFovA5uhI=",
            "text": "Lovely fitting look nice and the quality of the leggings is lovely they wash well too!",
            "emotion": "joy",
            "reviewRating": 5,
            "reviewId": "59902a9d-a6d8-5798-aa46-cde93d80e666",
            "reviewedAt": "2021-05-03",
            "translatedText": "Lovely fitting look nice and the quality of the leggings is lovely they wash well too!",
            "nativeLanguage": "en-US",
            "incentivised": false,
            "reviewType": "NATIVE"
          }
        ]
      }
    }
  ],
  "worstFeatures": [
    {
      "featureId": "string",
      "feature": "string",
      "percentPositive": 0,
      "nativeFeature": "string",
      "reviewsMentioned": {
        "total": 90,
        "positive": 84,
        "negative": 0,
        "incentivized": 0
      },
      "averageRatingReviews": {
        "positive": 5.5,
        "negative": 0,
        "incentivized": 0
      },
      "_embedded": {
        "quotes": [
          {
            "quoteId": "EoA591P2Xi3/khB9osEG5l6cMtD5biVJ+r9FYMLG9KBIh8JmHqlSxRU4yP1ghuH9eXpFovA5uhI=",
            "text": "Lovely fitting look nice and the quality of the leggings is lovely they wash well too!",
            "emotion": "joy",
            "reviewRating": 5,
            "reviewId": "59902a9d-a6d8-5798-aa46-cde93d80e666",
            "reviewedAt": "2021-05-03",
            "translatedText": "Lovely fitting look nice and the quality of the leggings is lovely they wash well too!",
            "nativeLanguage": "en-US",
            "incentivised": false,
            "reviewType": "NATIVE"
          }
        ]
      }
    }
  ]
}

Response Parameters

Response Field Name	Data Type	Description
bestFeatures	Array	Array of top 5 best features for a product. Please refer to featuresResponse for attribute type and description of the attributes.
worstFeatures	Array	Array of top 5 worst features for a product. Please refer to featuresResponse for attributes type and description of the attributes.

featuresResponse

Response Field Name	Data Type	Description
featureId	String	Unique identifier of the product
feature	String	Name of the feature
percentPositive	float	Gives the percent positive of a product feature
nativeFeature	String	Gives the feature of product based upon language selected i.e. en,fr,de,es
reviewsMentioned	object	Provides summary of the reviews of product feature. Please refer to reviewsMentioned for attributes type and description of the attributes.
averageRatingReviews	object	Provide average summary for rating review of product feature. Please refer to averageRatingReviews for attributes type and description of the attributes.
_embedded	object	Provides an array of quotes associated to a particular feature. Please refer to embedded for attributes type and description of the attributes.

reviewsMentioned

Response Field Name	Data Type	Description
total	Number	Gives count of total reviews mentioned.
positive	Number	Gives count of positive reviews mentioned.
negative	Number	Gives count of negative reviews mentioned.
incentivized	Number	Gives count of incentivized reviews mentioned.

averageRatingReviews

Response Field Name	Data Type	Description
positive	Number	Gives percent positive average rating for reviews
negative	Number	Gives percent negative average rating for reviews
incentivized	Number	Gives percent incentivized average rating for reviews

embedded

Response Field Name	Data Type	Description
quotes	Array	Contains all the quotes associated to a particular feature. Please refer to quote for attributes type and description of the attributes.

quote

Response Field Name	Data Type	Description
quoteId	String	Unique identifier of the quote
text	String	Gives the text
emotion	String	Gives the emotion of a quote
reviewRating	float	Gives the rating of quote review
reviewId	String	Unique identifier of the review
reviewedAt	Date	Gives the date at which review was done
translatedText	String	Gives the translated quote text based upon language provided i.e. “en, fr, de, es"
nativeLanguage	String	Gives the language selected in BCP47 code
incentivised	Boolean	Tells if quote is incentivised returns true or false
reviewType	Enum	ENUM can be native ,family and syndicated