Contents

(+ show- hide)

This page provides information about the highlighted review data set. This data set allows you to locate each feature expression within opinion text so that the feature can be bolded, italicized, or subjected to any font changes you see fit. This data set is designed to be used as part of a Review Highlights display implementation.

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

The following UI/UX is an example of how to implement a highlighted review experience as part of a Review Highlights display.

Example

The following is a generalized example. 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": "highlightedreview::2d040312-a401-5e9e-b86f-fdeaa023e032-73827-1",
  "type": "highlightedreview",
  "lastModificationTime": "2018-05-04T08:55:29.183Z",
  "productExternalId": "792850903012",
  "feature": "picture quality",
  "sentiment": 1,
  "reviewId": "2d040312-a401-5e9e-b86f-fdeaa023e032",
  "reviewLegacyId": "3489734898",
  "reviewDate": "2017-08-19T03:06:24Z",
  "reviewRating": 5,
  "author": "PhotoNut7",
  "title": "Sharp Lens & Fast Focus",
  "text": "I'm really impressed with how well this lens works in low light, since I photograph baseball. Works well with my 7D, clarity is nice, and focuses very fast. The lens optical elements are amazing with how well the pictures come out. It will be a great asset when I photograph basketball late this year",
  "highlightedTitle": "Sharp Lens & Fast Focus",
  "highlightedText": "I'm really impressed with how well this lens works in low light, since I photograph baseball. Works well with my 7D, clarity is nice, and focuses very fast. The lens optical elements are amazing with how well the pictures come out. It will be a great asset when I photograph basketball late this year",
  "titleHighlights": [
    {
      "highlightType": "opinion",
      "startIndex": 0,
      "endIndex": 22
    },
    {
      "highlightType": "feature",
      "startIndex": 0,
      "endIndex": 4
    }
  ],
  "textHighlights": [
    {
      "highlightType": "opinion",
      "startIndex": 0,
      "endIndex": 92
    },
    {
      "highlightType": "feature",
      "startIndex": 73,
      "endIndex": 82
    },
    {
      "highlightType": "opinion",
      "startIndex": 94,
      "endIndex": 155
    },
    {
      "highlightType": "feature",
      "startIndex": 117,
      "endIndex": 123
    },
    {
      "highlightType": "opinion",
      "startIndex": 157,
      "endIndex": 230
    },
    {
      "highlightType": "feature",
      "startIndex": 213,
      "endIndex": 220
    },
    {
      "highlightType": "opinion",
      "startIndex": 232,
      "endIndex": 299
    },
    {
      "highlightType": "feature",
      "startIndex": 264,
      "endIndex": 273
    }
  ]
}

Fields

id

"id": "highlightedreview::2d040312-a401-5e9e-b86f-fdeaa023e032-73827-1"

Unique ID of the highlighted review.


type

"type": "highlightedreview"

The content type.


lastModificationTime

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

The time stamp of the last bulk export of highlighted review data.


productExternalId

"productExternalId": "792850903012"

The client's unique ID for the product.


feature

"feature": "picture quality"

The aspect of a product that is mentioned within the opinion text. Bazaarvoice uses natural language processing to automatically identify features from review text. There is no fixed feature dictionary and features may differ between categories (for example, “picture quality” is a feature of televisions but not of socks).


sentiment

"sentiment": 1

The sentiment of the feature discussion: 1 for positive, -1 for negative.


reviewId

"reviewId": "2d040312-a401-5e9e-b86f-fdeaa023e032"

The Bazaarvoice review GUID.


reviewLegacyId

"reviewLegacyId": "3489734898"

The Bazaarvoice review integer ID.


reviewDate

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

The submission date of the review.


reviewRating

"reviewRating": 5

The overall 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": "PhotoNut7

The username of the review author.


title

"title": "Sharp Lens & Fast Focus"

The original review title.


text

"text": "I'm really impressed with how well this lens works in low light, since I photograph baseball. Works well with my 7D, clarity is nice, and focuses very fast. The lens optical elements are amazing with how well the pictures come out. It will be a great asset when I photograph basketball late this year"

The original review text.


highlightedTitle

"highlightedTitle": "Sharp Lens & Fast Focus"

The review title with mentions of the feature emphasized with markup.


highlightedText

"highlightedText": "I'm really impressed with how well this lens works in low light, since I photograph baseball. Works well with my 7D, clarity is nice, and focuses very fast. The lens optical elements are amazing with how well the pictures come out. It will be a great asset when I photograph basketball late this year"

The review text with mentions of the feature emphasized with markup.


titleHighlights

"titleHighlights": [
  {
    "highlightType": "opinion",
    "startIndex": 0,
    "endIndex": 22
  },
  {
    "highlightType": "feature",
    "startIndex": 0,
    "endIndex": 4
  }
]

Start and end indices of quotes and mentions of the feature within the review title. Highlights of type "opinion" are for identifying entire sentences that mention the feature. Highlights of type "feature" are for identifying individual mentions of the feature within sentences. The startIndex is the 0-based index of the first character of the sentence or feature mention. The endIndex is the 0-based index of the last character of the sentence or feature mention.


textHighlights

"textHighlights": [
  {
    "highlightType": "opinion",
    "startIndex": 0,
    "endIndex": 92
  },
  {
    "highlightType": "feature",
    "startIndex": 73,
    "endIndex": 82
  },
  {
    "highlightType": "opinion",
    "startIndex": 94,
    "endIndex": 155
  },
  {
    "highlightType": "feature",
    "startIndex": 117,
    "endIndex": 123
  },
  {
    "highlightType": "opinion",
    "startIndex": 157,
    "endIndex": 230
  },
  {
    "highlightType": "feature",
    "startIndex": 213,
    "endIndex": 220
  },
  {
    "highlightType": "opinion",
    "startIndex": 232,
    "endIndex": 299
  },
  {
    "highlightType": "feature",
    "startIndex": 264,
    "endIndex": 273
  }
]

Start and end indices of quotes and mentions of the feature within the review text. Highlights of type "opinion" are for identifying entire sentences that mention the feature. Highlights of type "feature" are for identifying individual mentions of the feature within sentences. The startIndex is the 0-based index of the first character of the sentence or feature mention. The endIndex is the 0-based index of the last character of the sentence or feature mention.