Contents

(+ show- hide)

This page provides information about the product summaries data set.

For products with more than 1000 reviews, only reviews from the last two years will be incorporated into summaries.
Products must have a minimum of 10 reviews to have product sentiment insights created.

Recommended UI/UX

While data from the content insight export can be implemented in a number of different ways, the following UI/UX is recommended.

The following summary are highlights of the suggested product sentiment insights UI/UX:

  1. Features should be delineated in "pros" and "cons" sections. Bazaarvoice recommend at least up to 3 pros/cons.
  2. The top Feature ( "feature":) in each list should be in the active state on load.
  3. "Feature" label is bolded. Supporting highlighted quote & author should be displayed adjacent to "feature" label.
  4. Each feature in the list should be clickable.
  5. A view all reviews associated to that "feature" should be available. Those reviews can be sourced within highlightedreviews.
  6. Adjacent to each feature should be either positiveReviewsMentioned or negativeReviewsMentioned based on whether it shows up as a pro or a con.

API Response

The following is a generalized example. Actual data will vary based on configurations. Continue to the Fields section for information on each field, or view the Workflow Walk-Through tutorial to learn how to request this data set..

{
  "id": "productsummary::792850903012",
  "type": "productsummary",
  "lastModificationTime": "2018-05-04T08:55:29.183Z",
  "productExternalId": "792850903012",
  "bestFeatures": [
    {
      "feature": "ease of use",
      "percentPositive": 0.96,
      "totalReviewsMentioned": 26,
      "positiveReviewsMentioned": 22,
      "negativeReviewsMentioned": 1,
      "positiveReviewsAverageRating": 4.73,
      "negativeReviewsAverageRating": 3,
      "representativeQuotes": [
        {
          "quoteId": "b0YmHWXFPQ6ksc3k69zeIvFHz4pdfLid",
          "quote": "It is super easy to use, this camera is phenomenal!",
          "highlightedQuote": "It is super easy to use, this camera is phenomenal!",
          "reviewId": "1d040312-a401-5e9e-b86f-fdeaa023e031",
          "reviewLegacyId": "177885798",
          "reviewDate": "2017-08-19T03:06:24Z",
          "reviewRating": 5,
          "author": "Ruth07",
          "highlights": [
            {
              "highlightType": "feature",
              "startIndex": 12,
              "endIndex": 22
            }
          ]
        }
      ]
    }
  ],
  "worstFeatures": [
    {
      "feature": "price",
      "percentPositive": 0.56,
      "totalReviewsMentioned": 17,
      "positiveReviewsMentioned": 5,
      "negativeReviewsMentioned": 4,
      "positiveReviewsAverageRating": 4.8,
      "negativeReviewsAverageRating": 3,
      "representativeQuotes": [
        {
          "quoteId": "hNxbFfalIaE1QobEGJ6jOqVyGe+IBXzb3dVjOqzfZyM=",
          "quote": "Cons - Price is too steep - Fragile lens.",
          "highlightedQuote": "Cons - Price is too steep - Fragile lens.",
          "reviewId": "e18fa0dd-04d2-53fc-b71d-3481060bf1fd",
          "reviewLegacyId": "175771571",
          "reviewDate": "2017-07-02T12:31:01Z",
          "reviewRating": 2,
          "author": "LarryL3",
          "highlights": [
            {
              "highlightType": "feature",
              "startIndex": 7,
              "endIndex": 11
            }
          ]
        }
      ]
    }
  ]
}

Fields

id

"id": "productsummary::792850903012"

Unique ID of the product summary.


type

"type": "productsummary"

The content type.


lastModificationTime

"lastModificationTime": "2018-05-04T08:55:29.183Z"

The time stamp of the last bulk export of product summary data.


productExternalId

"productExternalId": "792850903012"

The client's unique ID for the product.


bestFeatures

"bestFeatures": [
    {
      "feature": "ease of use",
      "percentPositive": 0.96,
      "totalReviewsMentioned": 26,
      "positiveReviewsMentioned": 22,
      "negativeReviewsMentioned": 1,
      "positiveReviewsAverageRating": 4.73,
      "negativeReviewsAverageRating": 3,
      "representativeQuotes": [
        {
          "quoteId": "b0YmHWXFPQ6ksc3k69zeIvFHz4pdfLid",
          "quote": "It is super easy to use, this camera is phenomenal!",
          "highlightedQuote": "It is super easy to use, this camera is phenomenal!",
          "reviewId": "1d040312-a401-5e9e-b86f-fdeaa023e031",
          "reviewLegacyId": "177885798",
          "reviewDate": "2017-08-19T03:06:24Z",
          "reviewRating": 5,
          "author": "Ruth07",
          "highlights": [
            {
              "highlightType": "feature",
              "startIndex": 12,
              "endIndex": 22
            }
          ]
        }
      ]
    }
  ]

Up to 5 features of the product discussed the most positively by reviewers.


worstFeatures

"worstFeatures": [
    {
      "feature": "price",
      "percentPositive": 0.56,
      "totalReviewsMentioned": 17,
      "positiveReviewsMentioned": 5,
      "negativeReviewsMentioned": 4,
      "positiveReviewsAverageRating": 4.8,
      "negativeReviewsAverageRating": 3,
      "representativeQuotes": [
        {
          "quoteId": "hNxbFfalIaE1QobEGJ6jOqVyGe+IBXzb3dVjOqzfZyM=",
          "quote": "Cons - Price is too steep - Fragile lens.",
          "highlightedQuote": "Cons - Price is too steep - Fragile lens.",
          "reviewId": "e18fa0dd-04d2-53fc-b71d-3481060bf1fd",
          "reviewLegacyId": "175771571",
          "reviewDate": "2017-07-02T12:31:01Z",
          "reviewRating": 2,
          "author": "LarryL3",
          "highlights": [
            {
              "highlightType": "feature",
              "startIndex": 7,
              "endIndex": 11
            }
          ]
        }
      ]
    }
  ]
  

Up to 5 features of the product discussed the most negatively by reviewers.


percentPositive

"percentPositive": 0.96

The percentage of reviewers' opinions about this feature that are positive vs. negative.


totalReviewsMentioned

"totalReviewsMentioned": 26

The number of reviews mentioning this feature for this product.


positiveReviewsMentioned

"positiveReviewsMentioned": 22

The number of reviews that include a positive mention of this feature for this product.


negativeReviewsMentioned

"negativeReviewsAverageRating": 3

The number of reviews that include a negative mention of this feature for this product.


positiveReviewsAverageRating

"positiveReviewsAverageRating": 4.73

The average rating of reviews that contain a positive mention of this feature for this product.


negativeReviewsAverageRating

"negativeReviewsAverageRating": 3

The average rating of reviews that contain a negative mention of this feature for this product.


representativeQuotes

"representativeQuotes": [
  {
    "quoteId": "hNxbFfalIaE1QobEGJ6jOqVyGe+IBXzb3dVjOqzfZyM=",
    "quote": "Cons - Price is too steep - Fragile lens.",
    "highlightedQuote": "Cons - Price is too steep - Fragile lens.",
    "reviewId": "e18fa0dd-04d2-53fc-b71d-3481060bf1fd",
    "reviewLegacyId": "175771571",
    "reviewDate": "2017-07-02T12:31:01Z",
    "reviewRating": 2,
    "author": "LarryL3",
    "highlights": [
      {
        "highlightType": "feature",
        "startIndex": 7,
        "endIndex": 11
      }
    ]
  }
]

Up to 5 quotes drawn from user reviews that characterize the positive or negative sentiment about this feature for this product.


quoteId

"quoteId": "hNxbFfalIaE1QobEGJ6jOqVyGe+IBXzb3dVjOqzfZyM"

A unique identifier for the feature quote.


quote

"quote": "Cons - Price is too steep - Fragile lens."

The original text of the quote about the feature.


highlightedQuote

"highlightedQuote": "Cons - Price is too steep - Fragile lens."

The text of the feature quote with markup to emphasize the mention(s) of the feature.


reviewId

"reviewId": "1d040312-a401-5e9e-b86f-fdeaa023e031"

The Bazaarvoice review GUID.


reviewLegacyId

"reviewLegacyId": "177885798"

The Bazaarvoice review integer ID.


reviewDate

"reviewDate": "2017-08-19T03:06:24Z"

The submission date of the review.


reviewRating

"reviewRating": 5

The star rating of the review. Positive and negative opinions are discovered independently of the review rating. For example, a review might have 5 stars but still contain a minor complaint that is extracted as a negative opinion.


author

"author": "LarryL3"
 

The username of the review author.


highlights

"highlights": [
  {
    "highlightType": "feature",
    "startIndex": 7,
    "endIndex": 11
  }
]

Start and end indices of mentions of the feature within the quote. The startIndex is the 0-based index of the first character of the feature mention. The endIndex is the 0-based index of the last character of the feature mention.