Review

Example

The following is a generalized example. Actual reviews will vary based on configurations. Continue to the Fields section for information on each field.

{
  "id":"00092788-ca63-57f6-8e84-7862f7a82a40",
  "type":"review",
  "client":"example-client",
  "authorLocation":"Austin, TX",
  "lastModificationTime":"2017-01-21T16:28:58.736Z",
  "helpfulVoteCount":0,
  "notHelpfulVoteCount":0,
  "legacyId":"51332596",
  "submissionId":"qekz0odjlk8utw7y4n4ht8qtm",
  "photos": [
   {
      "caption": "Green Soap",
      "id": 12345,
      "sizes": [
         {
            "size": "thumbnail",
            "url": "https://.../bc7efdb8-49dc-5120-a768-c54fa09fe921" 
         },
         {
            "size": "medium",
            "url": "https://.../bc7efdb8-49dc-5120-a768-c54fa09fs4da" 
         }
      ]
   }
  ],
  "photoUrls":[
    "http://.../bc7efdb8-49dc-5120-a768-c54fa09fe921",
    "http://.../bc7efdb8-49dc-5120-a768-c54fa09fs4da"
  ],
  "submissionTime":"2015-07-08T08:19:31.000Z",
  "title":"Lorem ipsum dolor sit amet",
  "badges":[
    {
       "id":"verifiedPurchaser",
       "contentType":"REVIEW",
       "badgeType":"ContextDataValueBadge"
    }
  ],
  "isRatingsOnly":false,
  "isRecommended":true,
  "userNickname":"cupcake",
  "contextDataValues":{
    "Age":{
       "id":"Age",
       "value":"18to25"
    }
  },
  "contentCodes":[
    "HMP"
  ],
  "authorReference":{
    "id":"1f6ef1dd-7c6b-5a70-a9e2-c03a18a31849",
    "type":"author",
    "client":"example-client"
  },
  "reviewText":"Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Etiam vel pellentesque enim. Quisque rutrum eros ut sapien posuere ornare. Quisque vulputate ac diam eu scelerisque. Integer volutpat felis sed aliquam ornare. ",
  "rating":5,
  "ratingDimenisons":{
    "Buildquality":{
       "id":"Buildquality",
       "value":"5"
    },
    "EaseOfUse":{
       "id":"EaseOfUse",
       "value":"5"
    }
  },
  "syndicationSourceReference":{
   "catalogId":"product::98234hif982hfi",
   "clientId":"syndication-r-us"
  },
  "campaignId":"BV_REVIEW_DISPLAY",
  "pros":"Great product, well made, easy install",
  "cons":"Should be included with the $2000.00 SYSTEM",
  "additionalFields":{
    "children":{
      "id":"children",
      "value":"1"
    },
    "sku":{
      "id":"sku",
      "value":"Cos7j_7"
    }
  },
  "contentLocale":"en_US",
  "isFeatured":false,
  "tagDimensions":{
    "Topic1":{
       "id":"Topic",
       "values":[
          "Vestibulum lobortis, diam a",
          "Morbi a sapien non lectus fringillamole",
       ]
    },
    "Topic2":{
       "id":"Topic2",
       "values":[
          "Praesent non",
          "Don"
       ]
    },
  },
  "videos":[{
    "caption":"see it in action",
    "rawUrlInput":"http://youtu.be/KeIDiddsjR0",
    "videoHost":"www.youtube.com",
    "videoId":"KeIDiddsjR0"
  }]
}

Relationships

Author

A Review will only have a single author. This relationship is maintained on the review using the Author reference field.

The following diagram depicts the relationship between a review and an author:

Syndication source

A review may originate from a non-native source. This relationship is maintained on the review using the syndication source reference field.

The following diagram depicts the relationship between a review and a syndication source:

🚧

You must use both clientId and catalogId to identify the correct syndication source for a given review.

Product

Refer to the Review Parent Keys Reference to learn how to join reviews and products.

Comment

Refer to the Comment Reference to learn how to join reviews and comments.

Client Response

Refer to the Client Response Reference to learn how to join reviews and client responses.

Fields

Additional fields

"additionalFields":{  
  "children":{  
    "id":"children",  
    "value":"1"  
  },  
  "sku":{  
    "id":"sku",  
    "value":"Cos7j_7"  
  }  
}

Additional fields accept arbitrary free text information. Values can come from the author or may be information related to the content (custom IDs, internal tracking numbers, etc.).

📘

Additional configurations are available for this field.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Author location

"authorLocation":"Austin, TX"

Free text field submitted by the author. This value is not guaranteed to be in a standardized format.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Author reference

"authorReference":{  
  "id":"1f6ef1dd-7c6b-5a70-a9e2-c03a18a31849",  
  "type":"author",  
  "client":"example-client"  
}

Information about the content author. Refer to the Relationships section in this document to learn how to join a review with an author.

Badges

"badges" : [  
    {  
    "id":"verifiedPurchaser",  
    "contentType":"REVIEW",  
    "badgeType":"ContextDataValueBadge"  
    },  
    {  
    "badgeType" : "FeaturedBadge",  
    "contentType" : "REVIEW",  
    "id" : "featured"  
    },  
    {  
    "badgeType" : "AffiliationBadge",  
    "contentType" : "REVIEW",  
    "id" : "staff"  
    }  
  ],

Badges are distinctive attributes emblematic of inclusion in a group, skill level or other characteristic. Possible badge types include:

📘

Staff Badging feature is turned off by default for all DCE clients.

Bazaarvoice will enable Staff badging feature for a particular DCE client, once we receive a confirmation from the client.

• Client will reach out to [email protected] to have this feature enabled.

• AffiliationBadge
• ContextDataValueBadge
• FeaturedBadge

For more information about badges, including recommended UI treatments, refer to Badges in the Conversations API documentation.

Campaign ID

"campaignId":"BV_REVIEW_DISPLAY",

Campaign ID is a text string identifying the action that originated the content.

Client

"client":"example-client"

The client from where this content originates. The source client.

📘

If this value is not your client name, then this content has been syndicated to you from the client identified.

Cons

"cons":"Should be included with the $2000.00 SYSTEM"

Cons are an early implementation of tagging. They allowed users to submit words or short strings of text that can be characterized as expressing negative sentiment. This field is no longer available, and is included for older clients who still have data in this format.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Content codes

"contentCodes":[  
    "HMP"  
  ]

Codes assigned by Bazaarvoice moderators. For a list of possible codes refer to Moderator codes for content in the Conversations API documentation.

Content locale

"contentLocale":"en_US",

The locale code associated with this content.

Context data values

"contextDataValues":{  
  "Age":{  
    "id":"Age",  
    "value":"18to25"  
  }  
}

Context data values (CDV) are the answers to multi-select questions about the author. For example, the author's age when the content was written.

📘

Additional configurations are available for this field.

Helpful vote count

"helpfulVoteCount":0,

The count of users who indicated the content was helpful.

ID

"id":"00092788-ca63-57f6-8e84-7862f7a82a40"

Universally unique value identifying item. This ID is generated by Bazaarvoice.

Is featured

"isFeatured":false

Indicates the content should highlighted to consumers, typically by sorting the featured content to the top and applying a badge or other graphic indicator.

Is ratings only

"isRatingsOnly":false

Indicates if this review is "ratings only", meaning the author has not provided review text.

Is recommended

"isRecommended":true

Indicates author's willingness to recommend the product they are reviewing to a friend.

Last modification time

"lastModificationTime":"2017-01-21T16:28:58.736Z"

When this content was most recently modified.

Legacy ID

"legacyId":"51332596"

This identifier is used in the Bazaarvoice portal (AKA: Workbench) and standard export feeds. It is not guaranteed to be unique across clients.

Not helpful vote count

"notNelpfulVoteCount":0

The count of users who indicated the content was not helpful.

Photos

"photos": [  
   {  
      "caption": "Green Soap",  
      "id": 12345,  
      "sizes": [  
         {  
            "size": "thumbnail",  
            "url": "https://.../bc7efdb8-49dc-5120-a768-c54fa09fe921"  
         },  
         {  
            "size": "medium",  
            "url": "https://.../bc7efdb8-49dc-5120-a768-c54fa09fs4da"  
         }  
      ]  
   },  
],

A list of author-submitted photos to be displayed with the content. Each photo includes a unique identifier and a sizes array. The photos might include a caption describing the image if one was specified during submission. The sizes array contains objects with the URLs to the available images, separated by size. Refer to the Photo Upload topic in the Conversations API documentation for information about photo sizes.

Photo URLs

"photoUrls":[  
  "http://.../bc7efdb8-49dc-5120-a768-c54fa09fe921",  
  "http://.../bc7efdb8-49dc-5120-a768-c54fa09fs4da"  
],

This field has been deprecated in favor of the [photos](#photos) field. While photoUrls is still included in the dataset to support existing dependencies, Bazaarvoice recommends using the photos field.

Pros

"pros":"Great product, well made, easy install",

Pros are an early implementation of tagging. They allowed users to submit words or short strings of text that can be characterized as expressing positive sentiment. This field is no longer available, and is included for older clients who still have data in this format.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Rating

"rating":5

The author submitted overall rating for the subject of the review. Range will always be an integer between 1-5.

Rating dimensions

"ratingDimenisons":{  
  "Buildquality":{  
    "id":"Buildquality",  
    "value":"5"  
  }  
}

Content authors can rate different aspects or dimensions of a product. Typically range will be an integer between 1-5, but may be 1-3 or 1-7. Please contact us if you need to know the range.

🚧

Additional configurations are available for this field.

Review text

"reviewText":"Class aptent taciti sociosqu ad litora torquent per conubia nostra..."

The main text content of the submission.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Submission ID

"submissionId":"qekz0odjlk8utw7y4n4ht8qtm"

The unique identifier assigned to content (for example, to a review) when it was submitted. This ID exists only on native content generated on your site. It does not exist on syndicated content or on native content generated through a manual import.

Submission time

"submissionTime":"2015-07-08T08:19:31.000Z"

When the content was submitted.

syndication source reference

 "syndicationSourceReference": {  
    "catalogId": "product::98234hif982hfi",  
    "clientId": "syndication-r-us"  
  }

Information about the source of the content. Refer to the Relationships section in this document to learn how to join a review with its syndication source.

Tag dimensions

"tagDimensions":{  
  "Topic1":{  
     "id":"Topic",  
     "values":[  
        "Vestibulum lobortis, diam a",  
        "Morbi a sapien non lectus fringillamole",  
     ]  
  }  
}

Tag dimensions identify the different attributes of a product. Depending on configuration, authors can express sentiment by selecting from predefined tags or by creating their own tags at submission time.

📘

Additional configurations are available for this field.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Title

"title":"Lorem ipsum dolor sit amet"

The title of the review.

🚧

This is a free text field submitted by the author. Always escape it appropriately for the intended environment before displaying it.

Type

"type":"review"

The content type.

User nickname

"userNickname":"cupcake"

Public display name chosen by the author. If this value is absent, you should look for the displayName field on the associated author record.

Videos

Information about videos associated with the content. Bazaarvoice supports the following video styles:

Third party video linking

With this style, consumers can link to videos hosted on other platforms. Currently only YouTube is supported.

"videos":[{  
  "caption":"see it in action",  
  "rawUrlInput":"http://youtu.be/KeIDiddsjR0",  
  "videoHost":"[www.youtube.com"](http://www.youtube.com"),  
  "videoId":"KeIDiddsjR0"  
}]

See YouTube's developer documentation for more information on YouTube's current methods for displaying YouTube hosted video.

Bazaarvoice hosted video

With this style, consumers can upload video files directly to Bazaarvoice when submitting content. Videos will be hosted and served by Bazaarvoice.

"videos":[{  
  "VideoId": "9d637b22-fff8-aad7-4841-356422b9fb41",  
  "VideoHost": "BAZAARVOICE",  
  "VideoThumbnailUrl": "https://d32knfnyyqt5ha.cloudfront.net/9d637b22-fff8-aad7-4841-356422b9fb41/thumbnail/image-00001.png",  
  "VideoIframeUrl": null,  
  "Caption": "see it in action",  
  "VideoUrl": "https://d32knfnyyqt5ha.cloudfront.net/9d637b22-fff8-aad7-4841-356422b9fb41/video/movie.mp4"  
}]