Bazaarvoice offers export files that contain product data and user-generated content (UGC). You can use these export files to:

  • Extract data for inclusion in catalogs or email campaigns
  • Analyze consumer sentiment
  • Integrate data with and improve site search or navigation
  • Power content on your website without the use of the Bazaarvoice Ratings & Reviews Collect-Distribute display infrastructure

The following content exports are available:

  • Standard client feed—Facilitates the mapping of reviews and dimensions to the appropriate products and product categories. This feed contains product-specific information, content counts, and UGC details.
  • Ratings-only export feed—Contains product-specific, ratings-related content, including product IDs, number of reviews, average overall ratings, number of reviewers, and maximum rating values.
  • Displayable content export (DCE)—Provides a way to store UGC locally and display the content without calling the Bazaarvoice Ratings & Reviews Collect-Distribute display infrastructure. It is designed to be consumed in bulk periodically, and the UGC is intended for public display on websites and other applications.

Standard client feed

The standard client feed is an XML file that facilitates the mapping of reviews and dimensions to the appropriate products and product categories. This feed contains the following data:

  • Product-specific information, such as names, descriptions, and product IDs
  • Content counts, such as the number of reviews
  • UGC details, such as individual reviews

Data from a standard client feed is useful for completing tasks such as:

  • Extracting customer reviews for inclusion in catalogs and email campaigns
  • Conducting sentiment analysis on content text
  • Integrating data with site search or navigation

In addition to a full client feed, which includes all content, Bazaarvoice can upload an incremental client feed that contains only content changes that have occurred since the last client feed was generated.

Note: If you use standard client feeds to build your data store, you should have the ability to consume a full client feed in addition to incremental feeds. Bazaarvoice recommends this best practice as a way to reset the data stores in the event of unprocessed or lost feed content.
Important: The Standard Content Feed contains ALL of your ratings and reviews content, including those that have been rejected by our Moderation and Authenticity teams. The rejection and moderation codes are included on each review so you will be able to identify fraudulent and other types of rejected content as well as content not intended for syndication. The feed also contains other metadata associated with these reviews, including personally identifiable information (PII) such as consumer email addresses. You are solely responsible for complying with applicable laws regarding the use or sharing of the exported content, including the associated metadata.

Enable and schedule standard client feeds

Tip: Bazaarvoice recommends you wait until Monday at 12 AM Central Time (CST: UTC-6 or CDT: UTC-5) to use the standard client feed. Waiting until Monday improves the chances of complete feed generation.

To receive standard client feeds from Bazaarvoice, you must enable and schedule them, as follows:

  1. Sign in to the Bazaarvoice Portal .
  2. From the upper-right corner, select the settings icon settings icon.
  3. Select Configuration.
  4. Select the instance and Go to Configuration. The Site Manager appears, listing the available deployment zones and implementations.
  5. Edit the Main Implementation that is installed to the Main Site deployment zone.
  6. Select Technical Setup on the left side of the page and then select the Export Feeds tab.
  7. To enable and schedule full client feeds:
    • Select the Enabled toggle switch in the Full Standard Content Feed section of the page.
  8. To enable and schedule incremental feeds:
    • Select the Enabled toggle switch in the Incremental Standard Content Feed section of the page.
  9. Deploy the changes to the implementation.
    Note: Only changes to your Main Site deployment affect export feeds. Deploying changes to other deployment zones do not have any effect on the export feeds.
  10. Download feeds from the /feeds directory of the SFTP server:
    • If your data is hosted in the US, use the following URLs:
      • Staging server—sftp-stg.bazaarvoice.com
      • Production server—sftp.bazaarvoice.com
    • If your data is hosted in Europe, use the following URLs:
      • Staging server—sftp7-stg.bazaarvoice.com
      • Production server—sftp7.bazaarvoice.com

    Be sure to connect to SFTP using port 22. Contact Bazaarvoice Support if you do not know your SFTP credentials or where your data is hosted.

Note: If you need to adjust scheduling or other feed settings, such as appearance of PII, please contact Bazaarvoice Support .

Structure of standard client feeds

This page contains snippets and descriptions of different parts of the standard client feed based on Bazaarvoice code and the feed’s schema .

Note: Some XML elements, such as <Name> or <ExternalId>, and their definitions are part of different complex objects of the feed. Therefore, they will be mentioned in different sections of this topic.

Top-level elements

Refer to the end of this section for an example.

Element Description Type
Feed

A root element of the XML feed file.

Attributes:

  • xmlns—Contains schema version of a given XML file. String (varchar(255))
  • name—Client's name. String (varchar(255))
  • extractDate—Contains the date when the feed was generated. Date (Timestamp)

Complex Object

Product

A complex element that contains information about a certain client's subject, its content, and stats. Refer to the Products and their elements section for more details.

Attributes:

  • id—An identifier (in the same form as provided by a client in their product catalog). String (varchar(255))
  • disabled—Marks subjects that were explicitly marked as disabled by a client (using their product catalog). Boolean
  • removed—Marks subjects that were removed from a client's catalog (absent in the product catalog and marked as Inactive in Bazaarvoice database).

    Note: Removed or disabled subjects and their UGC are not present in the feed by default. However, if the client confirms that this data needs to be present in the daily feed, it can be configured.

Complex Object

Category

Another type of client's subject. Much like a product, it contains information about the category subject, its content, and stats. Refer to the Categories and their elements section for more details.

Attributes:

  • disabled—Marks subjects that were explicitly marked as disabled by a client (using their product catalog). Boolean

Complex Object

UserProfile

Contains information about a certain user (such as a reviewer) and its stats. Refer to the User profiles and their elements section for more details.

Attributes:

  • id—An identifier (in the same form as provided by a client in their product catalog). String (varchar(255))

Complex Object

Example

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/StandardClientFeed/14.8" name="LeCoolRetailer" extractDate="2016-01-01T05:30:00.713-05:00">
  <Product id="Product_1" disabled="false" removed="false"> ... </Product>
  ...
  <Product id="Product_N" disabled="false" removed="false"> ... </Product>
  <Category disabled="false"> ... </Category>
  ... 
  <Category disabled="false"> ... </Category>
  <UserProfile id="User_1"> ... </UserProfile>
  ...
  <UserProfile id="User_N"> ... </UserProfile>
</Feed>

Products and their elements

Refer to the end of this section for an example.

Element Description Type
Source The source of this piece of data in the Bazaarvoice system. Basically, this is a client name. String (varchar(255))
ExternalId An identifier (in the same form as provided by a client in their product catalog). The product id attribute duplicates this value. String (varchar(255))
Names Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog. Complex Object (sequence of Name elements)
Name

Name of a product taken from the client's product catalog. The product can have multiple names specified, each for a separate locale.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (text)

Descriptions Present if a product has multiple product descriptions in different languages. Otherwise, a single Description element is used. This data is found in the product catalog. Complex Object (sequence of Description element)
Description

Description of a product taken from the client's product catalog. The product can have multiple descriptions specified, each for a separate locale.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (text)

ProductPageUrls Present if a product has multiple product page URLs for a set of locales. Otherwise, ProductPageUrl element is used. Complex Object (sequence of ProductPageUrl elements)
ProductPageUrl

URL to a product page on the client's website.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

URL / String (varchar(255))

ReviewsPageTitles Present if a client provided multiple review page titles for each locale. Complex Object (sequence of ReviewsPageTitle elements)
ReviewsPageTitle

A title of the review page for a certain product. The value can be locale-specific.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (varchar(255))

ReviewsPageMetaDescriptions Present if a client provides multiple review page descriptions for each locale. Complex Object (sequence of ReviewsPageMetaDescription elements)
ReviewsPageMetaDescription

A description for a certain review page for a given product. The value can be locale-specific.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (varchar(255))

ImageUrls

Contains multiple image URLs (in case the client provided more than one) for different locales.

Note: If Ratings & Reviews Collect-Distribute is deployed on an HTTPS site, you must provide image URLs at an HTTPS location in your product catalog. If you do not, your customers will see a mixed content warning.
Complex Object (sequence of ImageUrl elements)
ImageUrl

URL to an image of the product (provided by the client using the product catalog). This element can be locale-specific.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

URL / String (varchar(255))

ProductReviewsUrl

URL to the review page of a certain product. It is generated for active products with some reviews. It is formed using the general reviews host name, display code, and product ID:

http://reviews.clientname.com/displayCode/productID/reviews.htm

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ProductQuestionsUrl

URL to the question page of a certain product. It is generated for active products with some questions. It is formed using the general Questions & Answers host name, display code, and product ID:

http://answers.<clientName>.com/answers/<displayCode>/product/<productID>/questions.htm

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ModelNumbers Contains multiple model numbers applicable to a current product. Complex Object (sequence of ModelNumber elements)
ModelNumber A model number of a given product. Provided by a client using the product catalog. String (varchar(255))
ManufacturerPartNumbers Contains multiple manufacturer part numbers applicable to a current product. Complex Object (sequence of ManufacturerPartNumber elements)
ManufacturerPartNumber The manufacturer part number of a given product. Provided by a client using the product catalog. String (varchar(255))
EANs A set of EAN barcodes that are applicable to a product. Provided by a client using the product catalog. Complex Object (sequence of EAN elements)
EAN International article number of a product (one of few supported barcode standards). Supports 8-digit and 13-digit values. Patterns: [0-9]{8} and [0-9]{13} Long (8-byte integer)
UPCs A set of UPC barcodes that are applicable to a product. Provided by a client using the product catalog. Complex Object (sequence of UPC elements)
UPC Universal Product Code of a given product (another barcode standard supported by Bazaarvoice). Supports 6-digit and 12-digit values. Pattern: [0-9]{6} and [0-9]{12} Long (8-byte integer)
ISBNs A set of ISBN barcodes that are applicable to a product, such as paper books or e-books. Provided by a client using the product catalog. Complex Object (sequence of ISBN elements)
ISBN International Standard Book Number of a product (numeric identifier standard used for books). Pattern: [0-9]{8,12}[0-9X] Long (8-byte integer)
NumNativeQuestions Number of native-approved questions for this product (non-syndication). Int (4-byte integer)
NumQuestions Number of approved questions for this product (including syndication). Int (4-byte integer)
NumNativeAnswers Number of native-approved answers for this product (non-syndication). Int (4-byte integer)
NumAnswers Number of approved answers for this product (including syndication). Int (4-byte integer)
NumReviews Number of approved reviews for this product (including syndication). Int (4-byte integer)
ReviewStatistics Contains detailed information about all ratings and reviews of the product (stats including syndication). Refer to the ReviewStatistics, QAStatistics, and CommentStatistics blocks section for more details. Complex Object (description of its fields is provided in the ReviewStatistics, QAStatistics, and CommentStatistics blocks section)
NativeReviewStatistics Contains detailed information about native ratings and reviews of the product (non-syndication stats). Refer to the ReviewStatistics, QAStatistics, and CommentStatistics blocks section for more details. Complex Object (description of its fields is provided in the Products and their elements section)
Brand Contains reference to the brand of a given product. Refer to the Attributes, Brands, and CategoryItems section for more details. Complex Object (description of its fields is provided in the Products and their elements section)
CategoryItems Contains reference to a Categories element, under which a given product resides. Categories are represented as a chain sorted from the child to parent. Refer to the Attributes, Brands, and CategoryItems section for more details. Complex Object (sequence of CategoryItem elements)
Attributes Contains a list of custom and additional attributes of a product. Refer to the Attributes, Brands, and CategoryItems section for more details. Complex Object (sequence of Attribute elements)
Questions Parent element for all questions related to this product. Refer to the Content types section for more details. Complex Object (sequence of Question elements)
Reviews Parent element for all reviews related to this product. Refer to the Content types section for more details. Complex Object (sequence of Review elements)

Example

<Product id="Product154812" removed="false" disabled="false">
  <Source>LeCoolRetailer</Source>
  <ExternalId>Product154812</ExternalId>

  <!-- Product will have either a single Name or Names element -->
  <Name>Imaginary game console 4 500GB Console - Some game: Green Ops III Bundle</Name>
  <Names>
  <Name locale="en_US">Imaginary game console 4 500GB - Some game: Green Ops III Bundle</Name>
  <Name locale="de_DE">Imaginäre Spielkonsole 4 500GB - Einige Spiel: Grün Ops III Bundle</Name>
  ...
  </Names>

  <!-- Product will have a Description or Descriptions element -->
  <Description>This console system opens the door to an incredible journey through immersive new gaming worlds and a deeply connected gaming community. It puts gamers first with an astounding launch lineup and over 100500 games in development. Play amazing top-tier blockbusters and innovative indie hits on our system. </Description>
  <Descriptions>
  <Description locale="en_US">
  This console system opens the door to an incredible journey through immersive new gaming worlds and a deeply connected gaming community. 
  It puts gamers first with an astounding launch lineup and over 100500 games in development. 
  Play amazing top-tier blockbusters and innovative indie hits on our system.
  </Description>
  <Description locale="de_DE"> 
  Diese Konsole System öffnet die Tür zu einer unglaublichen Reise durch fesselnde neue Spielwelten und einer tief verbunden Gaming-Community.
  Es bringt die Spieler zuerst mit einer erstaunlichen Start-Formation und über 100500 Spiele in der Entwicklung.
  Spielen erstaunlich Top-Tier-Blockbustern und innovative Indie-Hits auf unserem System.  
  </Description>
  ...
  </Descriptions>

  <!-- Product will have a single ProductPageUrl or ProductPageUrls element -->
  <ProductPageUrl>http://www.lecoolretailer.com/store/product/imaginary-game-console-4-black-ops/154812</ProductPageUrl>
  <ProductPageUrls>
  <ProductPageUrl locale="en_US">http://www.lecoolretailer.com/store/product/imaginary-game-console-4-black-ops/154812</ProductPageUrl>
  <ProductPageUrl locale="de_DE">http://de.lecoolretailer.com/store/product/imaginare-spiel-konsole-4-black-ops/154812</ProductPageUrl>
  ...
  </ProductPageUrls>

  <!-- Product might have a ReviewsPageTitle or ReviewsPageTitles element -->
  <ReviewsPageTitle>Imaginary game console 4</ReviewsPageTitle>
  <ReviewsPageTitles>
  <ReviewsPageTitle locale="en_US">Imaginary game console 4</ReviewsPageTitle>
  <ReviewsPageTitle locale="de_DE">Imaginäre Spielkonsole 4</ReviewsPageTitle>
  ...
  </ReviewsPageTitles>

  <!-- Product might have a ReviewsPageMetaDescription or ReviewsPageMetaDescriptions element -->
  <ReviewsPageMetaDescription>Product reviews and customer ratings. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescriptions>
  <ReviewsPageMetaDescription locale="en_US">Product reviews and customer ratings for Console of new generation. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescription locale="de_DE"Produktbewertungen und Kundenbewertungen für Konsole der neuen Generation. Lesen und realen Erfahrungen zu vergleichen.</ReviewsPageMetaDescription>
  ...
  </ReviewsPageMetaDescriptions>

  <!-- Product might have one or multiple images in ImageUrl or ImageUrls elements -->
  <ImageUrl>http://s7d9.scene7.com/is/image/lecoolretailer_us/15875517838466p</ImageUrl>
  <ImageUrls>
  <ImageUrl locale="en_US">http://s7d9.scene7.com/is/image/lecoolretailer_us/15875517838466p</ImageUrl>
  <ImageUrl locale="de_DE">http://s7d9.scene7.com/is/image/lecoolretailer_de/12312341235572d</ImageUrl>
  ...
  </ImageUrls>

  <ProductReviewsUrl>http://reviews.lecoolretailer.com/1234/154812/imaginary-game-console-4-black-ops-reviews/reviews.htm</ProductReviewsUrl>
  <ProductQuestionsUrl>http://answers.lecoolretailer.com/answers/1234/product/154812/imaginary-game-console-4-black-ops-questions-answers/questions.htm</ProductQuestionsUrl>  

  <!-- Model, part numbers, EANs, UPCs, ISBNs are all included if client provided us with these product attributes using product catalog. 
  Each of these data types can have multiple values listed in appropriate block. -->
  <ModelNumbers>
  <ModelNumber>0051391</ModelNumber>
  ...
  </ModelNumbers> 
  <ManufacturerPartNumbers>
  <ManufacturerPartNumber>239324</ManufacturerPartNumber>
  ...
  </ManufacturerPartNumbers>
  <EANs>
  <EAN>0711719860037</EAN>
  ...
  </EANs>
  <UPCs>
  <UPC>711719500728</UPC>
  ...
  </UPCs>
  <ISBNs>
  <ISBN>047875846913</ISBN>
  ...
  </ISBNs>

  <NumNativeQuestions>4</NumNativeQuestions>
  <NumQuestions>120</NumQuestions>
  <NumNativeAnswers>1</NumNativeAnswers>
  <NumAnswers>24</NumAnswers>
  <NumReviews>42</NumReviews>

  <!-- Examples and descriptions of the following elements are present in separate sections of this doc. -->

  <ReviewStatistics>
  ...
  </ReviewStatistics>

  <NativeReviewStatistics>
  ...
  </NativeReviewStatistics>

  <Brand disabled="false">
  ...
  </Brand>

  <!-- Category chain -->
  <CategoryItems>
  ...
  </CategoryItems>

  <!-- Product attributes -->
  <Attributes>
  ...
  </Attributes>

  <Questions>
  ...
  </Questions>

  <Reviews>
  ...
  </Reviews>

</Product>

Categories and their elements

Refer to the end of this section for an example.

Note: Category subjects are similar to products from a structure (model) point of view. Categories have different conception and catalog levels.
Element Description Type
ExternalId An identifier (in the same form as provided by a client in their product catalog). Identical to category ID attribute. String (varchar(255))
CategoryPath A category chain (reflects parent categories of a given category, ordered by hierarchy). Each category element (category link) is a reference to an existing category in the Bazaarvoice database, containing ExternalId and single Name elements. Complex Object (sequence of Category objects)
Name

Name of a category taken from the client's product catalog. Products can have multiple names specified, each for a separate locale.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (text)

Names Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog. Complex Object (sequence of Name elements)
CategoryPageUrl

A URL to a category page on the client's website.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

URL / String (varchar(255))

CategoryPageUrls Present if category has multiple product page URLs specified for a set of locales. Otherwise, a single CategoryPageUrl element is used. Complex Object (sequence of CategoryPageUrl elements)
ImageUrl

URL to an image of the category (provided by client using the product catalog). The value can be locale-specific.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

URL / String (varchar(255))

ImageUrls Contains multiple Image Urls (in case client provided more than one) for different locales. Complex Object (sequence of ImageUrl elements)
ReviewsPageTitles Present if client provided multiple review page titles for each locale. Complex Object (sequence of ReviewsPageTitle elements)
ReviewsPageTitle

Can be used to store a title of review pages for all products under this category. The value can be locale-specific as well.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (varchar(255))

ReviewsPageMetaDescriptions Present if client provided multiple review page descriptions for each locale. Complex Object (sequence of ReviewsPageMetaDescription elements)
ReviewsPageMetaDescription

A description for review pages for products under the given category. The value can be locale-specific.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (varchar(255))

NumNativeQuestions Number of native-approved questions for this category (non-syndication). Int (4-byte integer)
NumQuestions Number of approved questions for this category (including syndication). Int (4-byte integer)
NumNativeAnswers Number of native-approved answers for this category (non-syndication). Int (4-byte integer)
NumAnswers Number of approved answers for this category (including syndication). Int (4-byte integer)
Attributes Contains a list of custom and additional attributes of a given category. Refer to the Attributes, Brands, and CategoryItems section for more details. Complex Object (sequence of Attribute elements)
Questions Root for all questions related to this category. Refer to the Question type section for more details. Complex Object (sequence of Question elements)

Example

<Category disabled="false">
  <ExternalId>22906</ExternalId>

  <CategoryPath>
  <Category>
  <ExternalId>22906</ExternalId>
  <Name>Acoustic</Name>
  </Category>
  <Category>
  <ExternalId>22905</ExternalId>
  <Name>Guitars</Name>
  </Category>
  <Category>
  <ExternalId>22904</ExternalId>
  <Name>Instruments</Name>
  </Category>
  </CategoryPath>

  <!-- Category will hold either a single Name or Names element -->
  <Name>Acoustic</Name>
  <Names>
  <Name locale="en_GB">Acoustic</Name>
  <Name locale="de_DE">Akustisch</Name>
  ...
  </Names>

  <!-- Category will hold either a single CategoryPageUrl or CategoryPageUrls element -->
  <CategoryPageUrl>https://www.THE_BEST_GUITAR_STORE_EVER.com/browse/acoustic</CategoryPageUrl>
  <CategoryPageUrls>
  <CategoryPageUrl locale="en_GB">https://www.THE_BEST_GUITAR_STORE_EVER.com/browse/acoustic</CategoryPageUrl>
  <CategoryPageUrl locale="de_DE">https://www.THE_BEST_GUITAR_STORE_EVER.de/browse/acoustic?language=deutsch</CategoryPageUrl>
  ...
  </CategoryPageUrls>

  <!-- Category will hold either a single ImageUrl or ImageUrls element -->
  <ImageUrl>http://www.THE_BEST_GUITAR_STORE_EVER.cimages/category/categoryimages/Acoustic.jpg</ImageUrl>
  <ImageUrls>
  <ImageUrl locale="en_GB">http://www.THE_BEST_GUITAR_STORE_EVER.cimages/category/categoryimages/Acoustic.jpg</ImageUrl>
  <ImageUrl locale="de_DE">http://www.THE_BEST_GUITAR_STORE_EVER.images/category/categoryimages/Acoustic.jpg</ImageUrl>
  ...
  </ImageUrls>

  <!-- Category might have a ReviewsPageTitle or ReviewsPageTitles element -->
  <ReviewsPageTitle>Share your acoustic guitar playing experience.</ReviewsPageTitle>
  <ReviewsPageTitles>
  <ReviewsPageTitle locale="en_US">Share your acoustic guitar playing experience.</ReviewsPageTitle>
  <ReviewsPageTitle locale="de_DE">Teilen Sie Ihre Akustikgitarre Spielerlebnis.</ReviewsPageTitle>
  ...
  </ReviewsPageTitles>

  <!-- Category might have a ReviewsPageMetaDescription or ReviewsPageMetaDescriptions element -->
  <ReviewsPageMetaDescription>Category reviews and customer ratings. Read and compare real experiences.</ReviewsPageMetaDescription>
  <ReviewsPageMetaDescriptions>
  <ReviewsPageMetaDescription locale="en_US">Category contains product with reviews and customer ratings for Acoustic guitars. Read and compare real experiences. </ReviewsPageMetaDescription>
  <ReviewsPageMetaDescription locale="de_DE">Kategorie hält Produkt Testberichte und Kundenbewertungen für Akustikgitarren. Lesen und realen Erfahrungen zu vergleichen.</ReviewsPageMetaDescription>
  ...
  </ReviewsPageMetaDescriptions>

  <NumNativeQuestions>1</NumNativeQuestions>
  <NumNativeAnswers>2</NumNativeAnswers>
  <NumQuestions>65</NumQuestions>
  <NumAnswers>73</NumAnswers>

  <!-- Examples and descriptions of the following elements are present in separate sections of this doc. -->

  <Attributes>
  ...
  </Attributes>

  <Questions>
  ...
  </Questions>

</Category>

Attributes, Brands, and CategoryItems

Refer to the end of this section for an example.

Element Description Type
Brand

Contains reference to the brand of a given product.

Attributes:

  • disabled—Much like products and categories, brands can be disabled using the product catalog import (provided by client). This is a marker of such brands. Boolean

Complex Object

Names Present if a product has multiple names in different languages. Otherwise, a single Name element is used. These names are found in the product catalog. Complex Object (sequence of Name elements)
Name

Name of a product taken from the client's product catalog. Products can have multiple names specified, each for a separate locale.

Attributes:

  • locale—Used in a set of locale-specific fields (elements) of the feed. String (varchar(25))

String (text)

ExternalId An identifier, in the same form as provided by a client in their product catalog, usually identical to the id attribute. String (varchar(255))
CategoryItems This block contains reference to categories, under which a given product resides. Categories are represented as a chain sorted from the child to root. Complex Object (sequence of CategoryItem elements)
CategoryItem

A specific category link of a full category chain (root, intermediate, or leaf element).

Attributes:

  • id—Unique identifier of a given piece of content in the Bazaarvoice Network. String (varchar(255))

Complex Object

CategoryId One of a few identifiers of a category. This one is an actual ID of a record in the Bazaarvoice database. It is unique among all clients. Long (8-byte integer)
CategoryName Name of a given category item. String (varchar(255))
Attributes Contains a list of custom and additional attributes of a product. Complex Object (sequence of Attribute elements)
Attribute

Attribute of a given subject (product, brand, category). Can hold any additional information a client stores in Bazaarvoice databases, such as department, color, or size.

Attributes:

  • id—Unique identifier of a given piece of content in the Bazaarvoice Network. String (varchar(255))

Complex Object (contains a single Value element)

Value Contains a text that describes or explains an attribute. String (text)

Example

<Product id="Product-X-123890">
  ...

  <Brand disabled="false">
  <!-- Brand can have either a Name or Names element -->
  <Name>Fender</Name>
  <Names>
  <Name locale="en_GB">Fender Brand</Name>
  <Name locale="de_DE">Fender Marke</Name>
  ...
  </Names>

  <ExternalId>810</ExternalId>
  <Attributes>
  <Attribute id="Country">
  <Value>United States</Value>
  </Attribute>
  ...
  </Attributes>
  </Brand>

  <CategoryItems>
  <CategoryItem id="22906">
  <ExternalId>22906</ExternalId>
  <CategoryId>996222</CategoryId>
  <CategoryName>Acoustic</CategoryName>
  </CategoryItem>
  <CategoryItem id="22905">
  <ExternalId>22905</ExternalId>
  <CategoryId>996221</CategoryId>
  <CategoryName>Guitars</CategoryName>
  </CategoryItem>
  <CategoryItem id="22904">
  <ExternalId>22904</ExternalId>
  <CategoryId>996220</CategoryId>
  <CategoryName>Instruments</CategoryName>
  </CategoryItem>
  </CategoryItems>

  <Attributes>
  <Attribute id="Department">
  <Value>Austin Guitar House</Value>
  </Attribute>
  <Attribute id="ColorIdentifier">
  <Value>Sunburst</Value>
  </Attribute>
  </Attributes>

  ... 
</Product>

ReviewStatistics, QAStatistics, and CommentStatistics blocks

Review Statistics and Native Review Statistics blocks have the same structure. The only difference is that Review Statistics take into account syndicated content.

Refer to the end of this section for an example.

Element Description Type
AverageOverallRating Average rating calculated from all approved reviews of a given product. Float (4-bytes)
OverallRatingRange The maximum value of a rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their Ratings & Reviews functionality. This value is set during client provisioning. Int (int(11))
TotalReviewCount Total number of reviews that were approved (and thus should be displayed) for a given product. Int (4-byte Integer)
RatingsOnlyReviewCount Total number of rating-only reviews that were approved for a given product. Rating-only reviews have no text but are counted when calculating stats. Int (4-byte Integer)
RecommendedCount Number of reviews that have a "Recommended" flag on them. This means that during review submission, a user (reviewer) confirmed that they would recommend this product to a friend. Int (4-byte Integer)
AverageRatingValues Contains a set of AverageRatingValue elements. Complex Object (sequence of AverageRatingValue elements)
AverageRatingValue

Contains average stats of a product calculated from (and grouped by) secondary rating values.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of a certain type. String (varchar(255))

Complex Object

RatingDimension

Specifies information about alternative characteristics, such as ease of use, price, material, or comfort.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of a certain type. String (varchar(255))
  • displayType—Specifies the submission option chosen for a given rating dimension (options include SLIDER, RADIO, or NORMAL). This is a display-related property only. Enum
  • selectedValueInDisplayEnabled—A Boolean value that shows whether the selected value of the slider or radio should be shown in the display. This is a display-related property only. Boolean

Complex Object

AverageRating Contains an average value users have chosen for this specific rating dimension (secondary rating). Float (4-bytes)
ExternalId Identifier of a given object (such as content, subject, dimension, or tag) that is unique among other objects of such type. String (varchar(255))
RatingRange Much like the OverallRatingRange element, this element shows the maximum value of a given secondary rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their secondary ratings functionality. This value is configured in a client's display or submission configuration. Int (int(11))
Label / Label1 Text description of a rating or tag dimension taken from a client or the default display configurations (if any description available). String (varchar(255))
RatingDistribution Contains ratings and review counts grouped by rating values. Complex Object (sequence of RatingDistributionItem elements)
RatingDistributionItem Reflects the amount of reviews with a certain rating. Complex Object
RatingValue One of the possible rating value options that is used to rate reviews. Int (4-byte integer)
TagDistribution A stats block that shows which and how many tags have been chosen by reviewers for their reviews. Complex Object
TagDimension

A dimension by which reviews can be tagged, such as pros, cons, or qualities.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of a certain type. String (varchar(255))

Complex Object

TagDistributionItems Contains a set of unique tags that were chosen for this tag dimension (like a list of pros grouped by unique values to calculate counts). Complex Object (sequence of TagDistributionItem elements)
TagDistributionItem Represents the unique tag described by a string label and the number of times it appeared on different reviews for this product (Count element). Complex Object (description of its fields is provided in this table)
LocaleDistribution Contains stats grouped by locale. Basically, this is a map of locales and review statistics. Complex Object (sequence of LocaleDistributionItem elements)
LocaleDistributionItem This is an entry of the locale distribution map that contains a key (DisplayLocale value) and a value (ReviewStatistics block). Complex Object (description of its fields is provided in this table)
DisplayLocale A locale from which a certain number of reviews were submitted for this product. String (varchar(25))
ReviewStatistics Review statistic block that contains numbers and stats of reviews for a certain display locale (the same structure as the one we're describing right now, except that it won't have any stats distributed by locales). There are recursive appearances of this XML element. Complex Object (described in this section)
Count Number of reviews with a certain quality, tag, or rating (depending on the location of a Count XML element). Int (4-byte Integer)
QAStatistics A block that contains stats information about all questions and answers of a user. Complex Object (described in this section)
ReviewCommentStatistics A block that contains stats information about all review comments of a user. Complex Object (described in this section)
TotalQuestionsCount Number of approved questions submitted by a certain user. Int (4-byte Integer)
TotalAnswersCount Number of approved answers submitted by a certain user. Int (4-byte Integer)
QuestionHelpfulVoteCount Number of "Helpful" votes submitted for all user's approved questions. Int (4-byte Integer)
QuestionNotHelpfulVoteCount Number of "Not Helpful" votes submitted for all user's approved questions. Int (4-byte Integer)
AnswerHelpfulVoteCount Number of "Helpful" votes submitted for all user's approved answers. Int (4-byte Integer)
AnswerNotHelpfulVoteCount Number of "Not Helpful" votes submitted for all user's approved answers. Int (4-byte Integer)
HelpfulVoteCount Total number of "Helpful" votes submitted for all user's approved content of a certain type. Int (4-byte Integer)
NotHelpfulVoteCount Total number of "Not Helpful" votes submitted for all user's approved content of a certain type. Int (4-byte Integer)
FeaturedQuestionsCount Number of user's questions that were marked as "Featured" on the client's display. Int (4-byte Integer)
FeaturedAnswersCount Number of user's answers that were marked as "Featured" on the client's display. Int (4-byte Integer)
FeaturedCommentCount Number of user's comments that were marked as "Featured" on the client's display. Int (4-byte Integer)
BestAnswersCount Number of user's answers that were marked as "Best" for a given question. Int (4-byte Integer)
FirstQuestionTime Date and time of the first question submitted by a given user. Date (Timestamp)
LastQuestionTime Date and time of the last question submitted by a given user. Date (Timestamp)
FirstAnswerTime Date and time of the first question submitted by a given user. Date (Timestamp)
LastAnswerTime Date and time of the last question submitted by a given user. Date (Timestamp)
LastQuestionAnswerDate Date and time of the last question or answer submitted by a given user. Date (Timestamp)
FirstSubmissionTime Date and time of the first submission of a certain content type performed by a given user. Date (Timestamp)
LastSubmissionTime Date and time of the last submission of a certain content type performed by a given user. Date (Timestamp)
NumComments Total number of approved comments that were submitted by a given reviewer. Int (4-byte integer)

Example

<Product id="Product1234">
  ...

  <ReviewStatistics>

  <AverageOverallRating>4.5</AverageOverallRating>
  <OverallRatingRange>5</OverallRatingRange>
  <TotalReviewCount>4</TotalReviewCount>
  <RatingsOnlyReviewCount>1</RatingsOnlyReviewCount>
  <RecommendedCount>4</RecommendedCount>

  <AverageRatingValues>
  <AverageRatingValue id="EaseOfUse">
  <AverageRating>3.7</AverageRating>
  <RatingDimension id="EaseOfUse" displayType="NORMAL" selectedValueInDisplayEnabled="true">
  <ExternalId>EaseOfUse</ExternalId>
  <RatingRange>5</RatingRange>
  <Label>Ease of use</Label>
  <Label1>Ease of use</Label1>
  </RatingDimension>
  </AverageRatingValue>
  <AverageRatingValue id="Quality">
  <AverageRating>4.35</AverageRating>
  <RatingDimension id="Quality" displayType="SLIDER">
  <ExternalId>Quality</ExternalId>
  <RatingRange>5</RatingRange>
  <Label>Product Quality</Label>
  </RatingDimension>
  </AverageRatingValue>
  ...
  </AverageRatingValues>

  <RatingDistribution>
  <RatingDistributionItem>
  <RatingValue>5</RatingValue>
  <Count>3</Count>
  </RatingDistributionItem>
  <RatingDistributionItem>
  <RatingValue>3</RatingValue>
  <Count>1</Count>
  </RatingDistributionItem>
  ...
  </RatingDistribution>

  <TagDistribution>
  ...
  <TagDimension id="Pro">
  <ExternalId>Pro</ExternalId>
  <Label>Pros</Label>
  <TagDistributionItems>
  <TagDistributionItem>
  <Label>Nice sound</Label>
  <Count>5</Count>
  </TagDistributionItem>
  <TagDistributionItem>
  <Label>Relaxation</Label>
  <Count>3</Count>
  </TagDistributionItem>
  <TagDistributionItem>
  <Label>Entertaining Guests</Label>
  <Count>2</Count>
  </TagDistributionItem>
  <TagDistributionItem>
  <Label>Great production quality</Label>
  <Count>2</Count>
  </TagDistributionItem>
  <TagDistributionItem>
  <Label>Nothing</Label>
  <Count>1</Count>
  </TagDistributionItem>
  </TagDistributionItems>
  </TagDimension>
  ...
  </TagDistribution>

  <LocaleDistribution>
  <LocaleDistributionItem>
  <DisplayLocale>en_US</DisplayLocale>
  <ReviewStatistics>
  <AverageOverallRating> ... </AverageOverallRating>
  <OverallRatingRange> ... </OverallRatingRange>
  <TotalReviewCount> ... </TotalReviewCount>
  <RatingsOnlyReviewCount> ... </RatingsOnlyReviewCount>
  <RecommendedCount> ... </RecommendedCount>

  <AverageRatingValues>
  ...
  </AverageRatingValues>
  <RatingDistribution>
  ...
  </RatingDistribution>
  </ReviewStatistics>
  </LocaleDistributionItem>

  <LocaleDistributionItem>
  <DisplayLocale>de_DE</DisplayLocale>
  <ReviewStatistics>
  <AverageOverallRating>3.7</AverageOverallRating>
  <OverallRatingRange>5</OverallRatingRange>
  <TotalReviewCount>10</TotalReviewCount>
  <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
  <RecommendedCount>7</RecommendedCount>
  <AverageRatingValues>
  ...
  </AverageRatingValues>
  <RatingDistribution>
  ...
  </RatingDistribution>
  </ReviewStatistics>
  </LocaleDistributionItem>

  ...
  </LocaleDistribution>

  </ReviewStatistics>

  ...
  </Product>

  <UserProfile id="something">
  ...

  <!-- This review statistics block is similar to the one in Product element. Refer to the previous example and description in the Review type table. -->
  <ReviewStatistics>
  <AverageOverallRating>2.0</AverageOverallRating>
  <OverallRatingRange>5</OverallRatingRange>
  <TotalReviewCount>1</TotalReviewCount>
  <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
  <RecommendedCount>0</RecommendedCount>
  <NotRecommendedCount>1</NotRecommendedCount>
  <FeaturedReviewCount>0</FeaturedReviewCount>
  <HelpfulVoteCount>0</HelpfulVoteCount>
  <NotHelpfulVoteCount>1</NotHelpfulVoteCount>
  <FirstSubmissionTime>2010-12-28T17:10:32.000-06:00</FirstSubmissionTime>
  <LastSubmissionTime>2010-12-28T17:10:32.000-06:00</LastSubmissionTime>
  <AverageRatingValues/>
  </ReviewStatistics>

  <QAStatistics>
  <TotalQuestionsCount>3</TotalQuestionsCount>
  <TotalAnswersCount>6</TotalAnswersCount>
  <QuestionHelpfulVoteCount>26</QuestionHelpfulVoteCount>
  <QuestionNotHelpfulVoteCount>5</QuestionNotHelpfulVoteCount>
  <AnswerHelpfulVoteCount>145</AnswerHelpfulVoteCount>
  <AnswerNotHelpfulVoteCount>2</AnswerNotHelpfulVoteCount>
  <HelpfulVoteCount>178</HelpfulVoteCount>
  <FeaturedQuestionsCount>3</FeaturedQuestionsCount>
  <FeaturedAnswersCount>8</FeaturedAnswersCount>
  <BestAnswersCount>23</BestAnswersCount>
  <FirstQuestionTime>2011-11-27T21:00:09.000-06:00</FirstQuestionTime>
  <LastQuestionTime>2011-11-27T21:00:09.000-06:00</LastQuestionTime>
  <FirstAnswerTime>2009-11-18T13:10:38.000-06:00</FirstAnswerTime>
  <LastAnswerTime>2009-11-18T13:10:38.000-06:00</LastAnswerTime>
  <LastQuestionAnswerDate>2011-11-27T21:00:09.000-06:00</LastQuestionAnswerDate>
  </QAStatistics>

  <ReviewCommentStatistics>
  <NumComments>23</NumComments>
  <HelpfulVoteCount>16</HelpfulVoteCount>
  <NotHelpfulVoteCount>10</NotHelpfulVoteCount>
  <FeaturedCommentCount>12</FeaturedCommentCount>
  <FirstSubmissionTime>2011-11-27T21:00:09.000-06:00</FirstSubmissionTime>
  <LastSubmissionTime>2011-11-27T21:00:09.000-06:00</LastSubmissionTime>
  </ReviewCommentStatistics>

  <HelpfulVoteCount>52</HelpfulVoteCount>
  <NotHelpfulVoteCount>12</NotHelpfulVoteCount>
  <FeaturedStoryCount>2</FeaturedStoryCount>
  <FirstSubmissionTime>2011-11-27T21:00:09.000-06:00</FirstSubmissionTime>
  <LastSubmissionTime>2011-11-27T21:00:09.000-06:00</LastSubmissionTime>

  <NumComments>6</NumComments>
  <HelpfulVoteCount>21</HelpfulVoteCount>
  <NotHelpfulVoteCount>0</NotHelpfulVoteCount>
  <FeaturedCommentCount>0</FeaturedCommentCount>
  <FirstSubmissionTime>2011-11-27T21:00:09.000-06:00</FirstSubmissionTime>
  <LastSubmissionTime>2011-11-27T21:00:09.000-06:00</LastSubmissionTime>

  ...
  </UserProfile>

Content types

Bazaarvoice provides the following content types:

All of these collectables can be exported to a client in their standard client feed.

Review type

Refer to the end of this section for an example.

Element Description Type
Review

Contains information about reviews submitted for a given product.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

ModerationStatus Contains information about the current status of a given review. Basically, this field can say whether a review is waiting for some action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED. Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this review by its author or any of its comments. The latest timestamp will be listed. Date (Timestamp)
Featured A Boolean marker. Value is "true" if this content is especially interesting and well written. Assigned during moderation. Boolean
UserProfileReference / Reviewer / User

Contains information about a user's profile (refer to the example snippet for all possible fields of this block). Depending on the scheme version, the block name might differ (either Reviewer or User / UserProfileReference). Refer to the User profiles and their elements section for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this doc)

RatingsOnly A Boolean marker. Value is "true" if review was successfully submitted but has no texts or was marked as RatingsOnly by CMS (if a number of characters was too small to pass the threshold, which is configurable on a per-client level) Boolean
Title Contains a review title in a form specified by its author. String (varchar(255))
ReviewText Contains the full text of a review in a form specified by its author. String (text)
DisplayLocale Contains the locale from which the review was submitted. String (varchar(25))
ReviewerNickname A nickname chosen by a review author. String (varchar(255))
ReviewerLocation A location of a review author. String (varchar(255))
Tags Contains a list of tag dimensions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of TagDimension elements)
AdditionalFields Contains a list of additional (non-default) fields the review might have. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of AdditionalField elements)
Comments Contains a list of comments that were submitted for a given review. Refer to the Comment type section for more details. Complex Object (sequence of Comment elements)
Rating A rating value chosen by the author of a review (usually this is a reflection of the number of "stars"). Int (int(11))
RatingRange The maximum value of a rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their Ratings & Reviews functionality. This value is set during client provisioning. Int (int(11))
Recommended Marks whether review has a "Recommended" flag on it. This means that during review submission, a user (reviewer) confirmed that they will recommend this product to a friend. Boolean
NumFeedbacks Number of feedback entries on a given review (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given review. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given review. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported that this review has inappropriate or irrelevant content. Int (4-byte integer)
NetPromoterScore The value is a positive integer between 1 and 10 representing a numerical rating in response to a question, such as, “How would you rate this company?” or “How would you rate this product?” Int (int(11))
NetPromoterComment A comment that goes along with a NetPromoterScore and explains the score. String (text)
UserEmailAddress If client prefers to get PII data in the feed, this field must be included. This is the user's (reviewer's) email address. String (varchar(255))
SendEmailAlertWhenPublished A Boolean value that shows whether the user decided to receive email when their review gets published or not. Boolean
SendEmailAlertWhenCommented A Boolean value that shows whether the user decided to receive email when their review gets commented on by others or not. Boolean
SendEmailAlertWhenCommentedOptOutURL

Contains OptOut URL that can be sent out to a user with an email and allows them to unsubscribe from further emails.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ProductReviewsUrl

URL that leads to a product reviews page and highlights a given review.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ProductReviewsDeepLinkedUrl

URL that leads directly to a given review.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ContextDataValues Contains multiple context data values chosen by a reviewer (like information about age, habits, or experience). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ContextDataValue elements)
RatingValues Contains a list of secondary rating stats (ratings chosen by the author for different dimensions or product qualities). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of RatingValue elements)
Photos A set of photo references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Video elements)
ClientComments Contains a list of comments that were submitted for a given review by the client's personnel. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ClientComment elements)
NumComments Number of comments that were approved for a given review. Int (4-byte integer)
SubmissionTime Time a given review was submitted by its author (before moderation process). Date (Timestamp)
CampaignId String value that specifies the source of a review, such as the platform or origins. Refer to this list of campaign IDs for more details. String (varchar(255))
AuthenticationType Type of authentication of a given user (review author). Can be SITE, FACEBOOK, or EMAIL. Enum
ProductReferences Contains a list of references of products linked to a review. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given review or its author. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Badge elements)
IpAddress Contains IP address of reviewer. This field is a PII which can be turned on or off. String (varchar(255))
OriginatingDisplayCode Identifies the client's display configurations that were used for submission of a given review. String (varchar(25))
ContentCodes Contains a string with content codes that are separated with spaces. Each content code is assigned during moderation and carries some information about content, such as whether there is reference to some other store or a reason why the review was approved or rejected. String (text)
ClientResponses Contains a list of client responses to this review. These are usually submitted using Workbench. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ClientResponse elements)
FirstPublishTime Date and time of the first time this review was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this review was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
Example
<Reviews>
    ...

    <Review id="46605115">
    <ModerationStatus>APPROVED</ModerationStatus>
    <SubmissionTime>2013-02-14T23:23:06.000-06:00</SubmissionTime>
    <LastModificationTime>2013-02-16T19:30:06.000-06:00</LastModificationTime>
    <UserProfileReference id="z2qs1pvkj7x282z0rg0zvfx2fp">
    <ExternalId>z2qs1pvkj7x282z0rg0zvfx2fp</ExternalId>
    <DisplayName>IAmMusician</DisplayName>
    <Anonymous>false</Anonymous>
    <HyperlinkingEnabled>false</HyperlinkingEnabled>
    </UserProfileReference>

    <Featured>false</Featured>
    <DisplayLocale>en_US</DisplayLocale>
    <RatingsOnly>false</RatingsOnly>
    <Title>Great guitar! Worth every penny!</Title>
    <ReviewText>Bought this great 12-strings acoustic guitar in the NAT color. Got half price off as it'd been in store for few years. Condition is excellent and it sounds great.</ReviewText>
    <ReviewerNickname>PowerMan332</ReviewerNickname>
    <ReviewerLocation>Overland Park, KS</ReviewerLocation>
    <Rating>5</Rating>
    <RatingRange>5</RatingRange>
    <Recommended>true</Recommended>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>2</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>1</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>1</NumInappropriateFeedbacks>
    <NetPromoterScore>10</NetPromoterScore>
    <NetPromoterComment>High quality. Know that this guitar will serve me well.</NetPromoterComment>
    <UserEmailAddress>PowerMan332@gmail.com</UserEmailAddress>
    <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
    <SendEmailAlertWhenCommented>true</SendEmailAlertWhenCommented>
    <SendEmailAlertWhenCommentedOptOutURL>http://reviews.GUITARSTORECLIENT.com/displayCode/productId/review/46605115/startunsubscribecommentedreview.htm?signature=16982abb3fdf31d2500aaa237560d3073234373939333037</SendEmailAlertWhenCommentedOptOutURL>
    <ProductReviewsUrl>http://rCampaignIdeviews.GUITARSTORECLIENT.com/<displayCode>/<ProductID>/reviews.htm?reviewID=46605115</ProductReviewsUrl>
    <ProductReviewsDeepLinkedUrl>http://reviews.GUITARSTORECLIENT.com/<displayCode>/<ProductID>/review/46605115/redirect.htm</ProductReviewsDeepLinkedUrl>
    <NumComments>0</NumComments>
    <CampaignId>BV_REVIEW_DISPLAY</CampaignId>
    <AuthenticationType>SITE</AuthenticationType>
    <IpAddress>172.0.0.1</IpAddress>
    <OriginatingDisplayCode>1234-en_us</OriginatingDisplayCode>
    <ContentCodes>IU ABC</ContentCodes>
    <FirstPublishTime>2013-02-16T19:30:06.000-06:00</FirstPublishTime>
    <LastPublishTime>2013-02-16T19:30:06.000-06:00</LastPublishTime>

    <!-- Following elements are described in other sections of this doc.

    <ClientResponses>
    <ClientResponse>
    ...
    </ClientResponse>
    ...
    </ClientResponses>

    <ContextDataValues>
    <ContextDataValue id="25to34">
    ...
    </ContextDataValue>
    ...
    </ContextDataValues>

    <RatingValues>
    <RatingValue>
    ...
    </RatingValue>
    ...
    </RatingValues>

    <Photos>
    <Photo id="104358">
    ...
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    ...
    </Video>
    ...
    </Videos>

    <ClientComments>
    <ClientComment>
    ...
    </ClientComment>
    ...
    </ClientComments>

    <Tags>
    <TagDimension id="Pros">
    ...
    </TagDimension>
    ...
    </Tags>

    <AdditionalFields>
    <AdditionalField id="SpringDealer">
    ...
    </AdditionalField>
    ...
    </AdditionalFields>

    <Comments>
    <Comment id="26859">
    ...
    </Comment>
    ...
    </Comments>

    <ProductReferences>
    <ProductReference>
    ...
    </ProductReference>
    ...
    </ProductReferences>

    <Badges>
    <Badge>
    ...
    </Badge>
    ...
    </Badges>

    </Review>

    ...
</Reviews>

Question type

Refer to the end of this section for an example.

Element Description Type
Question

Contains information about one of the questions submitted for a given product.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

ModerationStatus Contains information about the current status of a given question. Basically, this field indicates whether a question is awaiting action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED. Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this question by its author or any of their answers. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given question was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given question (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given question. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given question. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported this question for inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of a question. String (varchar(255))
UserLocation The location of the author of a question. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
QuestionSummary The summary line of a given question. String (varchar(255))
QuestionDetails The body of a question. String (text)
NumAnswers Number of answers that were submitted and approved for this question. Int (4-byte integer)
AuthenticationType Specifies the type of authentication used by a given user (question author). This can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished A Boolean value that shows whether the user decides to receive an email when their question gets published or not. Boolean
SendEmailAlertWhenAnswered A Boolean value that shows whether the user decides to receive an email when their question gets commented on by others or not. Boolean
SendEmailAlertWhenAnsweredOptOutURL

Contains the OptOut URL that can be sent out to a user with an email and allows them to unsubscribe from further emails.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
SubjectQuestionsUrl

URL that leads to a product question page and highlights a given question.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
SubjectQuestionsDeepLinkedUrl

URL that leads directly to a question.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
IpAddress Contains the IP address of a reviewer. Field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Contains the locale from where the question was submitted. String (varchar(25))
ContentCodes Contains a string with content codes that are separated with spaces. Each content code is assigned during moderation and carries some information about content, such as whether there is reference to some other store or reason why the question was approved or rejected. String (text)
CampaignId Specifies the source of the question, such as the platform or origins. Refer to this list of campaign IDs that are provided with Ratings & Reviews Collect-Distribute . String (varchar(255))
OriginatingDisplayCode Identifies the client's display configurations that were used for submission of a given question. String (varchar(25))
FirstPublishTime Date and time of the first time this question was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this question was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference/ Reviewer/ User

Contains information about a user profile (refer to the example snippet for all possible fields of this block). Depending on the scheme version, the block name might differ (Reviewer, User, or UserProfileReference). Refer to the User profiles and their elements section for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this doc)

Answers Contains answers to a question. Refer to the Answer type section for more details. Complex Object (sequence of Answer elements)
ContextDataValues Contains multiple context data values chosen by a reviewer (such as information about age, habits, or experience). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ContextDataValue elements)
Photos A set of photo references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Video elements)
Tags Contains a list of tag dimensions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of TagDimension elements)
AdditionalFields Contains a list of additional (non-default) fields the question might have. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of AdditionalField elements)
ProductReferences Contains a list of references to products linked to a question. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given question or its author. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Badge elements)
Example
<Question id="313672">
    <ModerationStatus>APPROVED</ModerationStatus>
    <LastModificationTime>2015-10-11T02:18:18.000-05:00</LastModificationTime>
    <SubmissionTime>2011-09-30T11:35:41.000-05:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>2</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>1</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>CertainSomeone</UserNickname>
    <UserLocation>Southern California</UserLocation>
    <UserEmailAddress>email@emailprovider.com</UserEmailAddress>
    <QuestionSummary>Would someone compare this model to previous years ones? I'm trying to figure out which one makes the most sense for business</QuestionSummary>
    <QuestionDetails>from a comfort or classy look point of view.</QuestionDetails>
    <NumAnswers>3</NumAnswers>
    <AuthenticationType>SITE</AuthenticationType>
    <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished>
    <SendEmailAlertWhenAnswered>true</SendEmailAlertWhenAnswered>
    <SendEmailAlertWhenAnsweredOptOutURL>
    http://answers.<clientName>.com/answers/<displayCode>/product/<productId>/question/<questionId>/startunsubscribeansweredquestion.htm?signature=<encryptedId>
    </SendEmailAlertWhenAnsweredOptOutURL>
    <SubjectQuestionsUrl>http://answers.<clientName>.com/answers/<displayCode>/product/>productId>/questions.htm</SubjectQuestionsUrl>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <CampaignId>BV_QA_BROWSE</CampaignId>
    <ContentCodes>ABC DEF GHI</ContentCodes>
    <OriginatingDisplayCode>1234-displayCode</OriginatingDisplayCode>
    <FirstPublishTime>2011-09-30T15:45:09.000-05:00</FirstPublishTime>
    <LastPublishTime>2011-09-30T15:45:09.000-05:00</LastPublishTime>

    <!-- Following elements are described in other sections of this doc. Refer to the Answer type section for more details. -->

    <UserProfileReference id="z3hwgfu60z8tg9qwybfhv9qg1g">
    ...
    </UserProfileReference>

    <Answers>
    <Answer id="466688">
    ...
    </Answer>
    </Answers>

    <ContextDataValues>
    <ContextDataValue id="25to34">
    ...
    </ContextDataValue>
    ...
    </ContextDataValues>

    <Photos>
    <Photo id="104358">
    ...
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    ...
    </Video>
    ...
    </Videos>

    <Tags>
    <TagDimension id="Pros">
    ...
    </TagDimension>
    ...
    </Tags>

    <AdditionalFields>
    <AdditionalField id="SpringDealer">
    ...
    </AdditionalField>
    ...
    </AdditionalFields>

    <ProductReferences>
    <ProductReference>
    ...
    </ProductReference>
    ...
    </ProductReferences>

    <Badges>
    <Badge>
    ...
    </Badge>
    ...
    </Badges>

</Question>

Answer type

Refer to the end of this section for an example.

Element Description Type
Answer

Contains information about one of the answers submitted for a question.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

ModerationStatus Contains information about the current status of a given answer. Basically, this field can say whether the answer is waiting for some action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED. Enum
LastModificationTime This element contains the timestamp of the last modification that was performed on this comment by its author. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given answer was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given answer (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given answer. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given answer. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported that this answer has inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of an answer. String (varchar(255))
UserLocation A location of the author of an answer. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
AnswerText An answer text to a certain question. String (text)
AuthenticationType Specifies the type of authentication of a given user (answer author). Can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished Shows whether the user decided to receive an email when their answer gets published or not. Boolean
SubjectAnswersDeepLinkedUrl

URL that leads directly to given answers.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
IpAddress Contains the IP address of a reviewer. This field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Contains the locale from which an answer was submitted. String (varchar(25))
ContentCodes Contains a string with content codes that are separated with spaces. Each content code is assigned during moderation and carries some information about the content, such as whether there is reference to some other store or reason why the question was approved or rejected. String (text)
CampaignId Specifies the source of an answer, such as the platform or origins. Refer to this list of campaign IDs for more details. String (varchar(255))
OriginatingDisplayCode Identifies a client's display configurations that were used for the submission of a given answer. String (varchar(25))
FirstPublishTime Date and time of the first time this answer was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this answer was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference / Reviewer / User

Contains information about a certain user profile (refer to the example snippet for all possible fields of this block). Depending on the scheme version, the block name might differ (either Reviewer or User / UserProfileReference). Refer to the User profiles and their elements section for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this doc)

ContextDataValues Contains multiple context data values chosen by a reviewer (like information about age, habits, or experience). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ContextDataValue elements)
Photos A set of photo references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Video elements)
AdditionalFields Contains a list of additional (non-default) fields the answer might have. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of AdditionalField elements)
ProductReferences Contains a list of references to products linked to an answer. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given answer or its author. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Badge elements)
Example
<Answer id="466688">
    <ModerationStatus>APPROVED</ModerationStatus>
    <LastModificationTime>2015-10-11T02:18:18.000-05:00</LastModificationTime>
    <SubmissionTime>2011-09-30T11:35:41.000-05:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>2</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>1</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>CertainSomeone</UserNickname>
    <UserLocation>Southern California</UserLocation>
    <UserEmailAddress>email@emailprovider.com</UserEmailAddress>
    <AnswerText>
    A huge answer for a given question goes here. Yadda yadda yadda.
    </AnswerText>
    <AuthenticationType>SITE</AuthenticationType>
    <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <CampaignId>BV_QA_BROWSE</CampaignId>
    <ContentCodes>ABC DEF GHI</ContentCodes>
    <OriginatingDisplayCode>1234-displayCode</OriginatingDisplayCode>
    <FirstPublishTime>2011-09-30T15:45:09.000-05:00</FirstPublishTime>
    <LastPublishTime>2011-09-30T15:45:09.000-05:00</LastPublishTime>

    <!-- Following elements are described in other sections of this doc. Refer to the Comment type section for more details. -->

    <UserProfileReference id="z3hwgfu60z8tg9qwybfhv9qg1g">
    ...
    </UserProfileReference>

    <ContextDataValues>
    <ContextDataValue id="25to34">
    ...
    </ContextDataValue>
    ...
    </ContextDataValues>

    <Photos>
    <Photo id="104358">
    ...
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    ...
    </Video>
    ...
    </Videos>

    <AdditionalFields>
    <AdditionalField id="SpringDealer">
    ...
    </AdditionalField>
    ...
    </AdditionalFields>

    <ProductReferences>
    <ProductReference>
    ...
    </ProductReference>
    ...
    </ProductReferences>

    <Badges>
    <Badge>
    ...
    </Badge>
    ...
    </Badges>

</Answer>

Comment type

Refer to the end of this section for an example.

Element Description Type
Comment

Contains information about a comment submitted for a review.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

ModerationStatus Contains information about the current status of a given comment. Basically, this field can say whether a comment is waiting for some action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED. Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this comment by its author. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given comment was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given comment (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given comment. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given comment. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported a comment for inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of a comment. String (varchar(255))
UserLocation A location of the author of a comment. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
Title The title of a comment. String (varchar(255))
CommentText The text in a comment body. String (text)
AuthenticationType Specifies type of authentication of a given user (comment author). Can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished Shows whether user decided to receive email when their comment is published or not. Boolean
SubjectCommentsDeepLinkedUrl

URL that leads directly to a given comment.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
IpAddress Contains the IP address of a reviewer. This field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Contains the locale from which the comment was submitted. String (varchar(25))
ContentCodes Contains a string with content codes that are separated with spaces. Each content code is assigned during moderation and carries some information about the content, such as whether there is reference to some other store or reason why the comment was approved or rejected. String (text)
CampaignId Specifies the source of a comment, such as the platform or origins. Refer to this list of campaign IDs for more details. String (varchar(255))
OriginatingDisplayCode Identifies the client's display configurations that were used for the submission of a given comment. String (varchar(25))
FirstPublishTime Date and time of the first time this comment was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this comment was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference / Reviewer / User

Contains information about a user profile (refer to example snippets for all possible fields of this block). Depending on the scheme version, the block name might differ (Reviewer or User or UserProfileReference). Refer to the User profiles and their elements section for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this doc)

Photos A set of photo references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Video elements)
ProductReferences Contains a list of references to products linked to a comment. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given comment or its author. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Badge elements)
Example
<Comment id="57">
    <ModerationStatus>REMOVEDBYCLIENT</ModerationStatus>
    <LastModificationTime>2010-03-11T10:15:04.000-06:00</LastModificationTime>
    <SubmissionTime>2009-11-06T09:09:07.000-06:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>3</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>wife4life</UserNickname>
    <UserLocation>North Carolina</UserLocation>
    <UserEmailAddress>some@email.com</UserEmailAddress>
    <Title>Nice stuff</Title>
    <CommentText>Why do men do this? My husband is the same way. Yadda yadda yadda.</CommentText>
    <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <OriginatingDisplayCode>1234-code</OriginatingDisplayCode>
    <FirstPublishTime>2010-03-11T10:15:04.000-06:00</FirstPublishTime>
    <LastPublishTime>2010-03-11T10:15:04.000-06:00</LastPublishTime>

    <!-- Following elements are described in other sections of this doc. Refer to the Complex contextual objects (content types parts) section for more details. -->

    <UserProfileReference id="z3hwgfu60z8tg9qwybfhv9qg1g">
    ...
    </UserProfileReference>

    <Photos>
    <Photo id="104358">
    ...
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    ...
    </Video>
    ...
    </Videos>

    <ProductReferences>
    <ProductReference>
    ...
    </ProductReference>
    ...
    </ProductReferences>

    <Badges>
    <Badge>
    ...
    </Badge>
    ...
    </Badges>

</Comment>

Complex contextual objects (content types parts)

This block includes information about the following:

  • Tags
  • Badges
  • Additional fields
  • Context data values
  • Rating values
  • Client responses
  • Client comments
  • Photos
  • Videos
  • Avatar
  • Product references

Refer to the end of this section for an example.

Element Description Type
Tags Contains a list of tag dimensions or tags (depending on the position). Complex Object (sequence of Tag or TagDimension elements)
TagDimension

A dimension by which a review can be tagged, such as pros, cons, or qualities.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object

ExternalId Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
Label / Label1 Explains a specific rating, tag, or dimension. The value is taken from a client or default display configurations (if any description available). String (varchar(255))
Tag Contains a label or tag that was attached to content by the author during submission. Complex Object (wraps a Label element)
Badges Contains a list of badges applied to content or its author. Complex Object (sequence of Badge elements)
Badge A badge assigned to content either by the client or by CMS. Complex Object
Name Name of the badge. The badge can be displayed with an image on the client's site using this value. String (varchar(255))
ContentType The type of content to which the badge belongs. Possible values: REVIEW, REVIEWER, QUESTION, ANSWER, COMMENT. Enum
BadgeType Type of badge (there are classifications of badges). Possible values: AffiliationBadge, RankBadge, BestAnswerBadge, FeaturedBadge, TopContributorBadge, ReviewerBadge. String (varchar(255))
AdditionalFields Contains a list of custom (non-default) fields configured on the submission page of the review. Complex Object (sequence of AdditionalField elements)
AdditionalField Contains information about an additional field and the value chosen by a reviewer (user or author). Complex Object (description of its fields is provided below in this table)
DisplayLabel Contains a label that describes the meaning of an additional field. String (varchar(255))
Value The value chosen by a user (reviewer) for an additional field. String (varchar(255))
ContextDataValues Contains multiple context data values. Complex Object (sequence of ContextDataValue elements)
ContextDataValue

A single context data value chosen by a reviewer (such as information about age, habits, or experience). This block contains dimension of evaluation and a value chosen by a user.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

ContextDataDimension A dimension of a given context data value. Basically, it is a description of what was evaluated. Contains an external id and a label. Complex Object (description of its fields is provided in this table)
RatingValues Contains a list of secondary ratings stats (ratings chosen by the author for different dimensions or product qualities). Complex Object (sequence of RatingValue elements)
RatingValue Contains stats of a product's rating dimension (some quality by which the product can be evaluated). Complex Object (description of its fields is provided in this table)
Rating A score chosen by the user for a specific dimension (for example, the product quality). Int (int(11))
RatingDimension

Specifies information about alternative characteristics, such as the ease of use, price, material, or comfort.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • displayType—Specifies the submission option chosen for a given rating dimension (options are SLIDER, RADIO, or NORMAL). This is a display-related property only. Enum
  • selectedValueInDisplayEnabled—A Boolean value that shows whether the selected value of the slider or radio should be shown in display. This is a display-related property only. Boolean

Complex Object (description of its fields is provided in this table)

RatingRange Much like the OverallRatingRange element, this elements shows the maximum value of a given secondary rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their secondary ratings functionality. This value is configured in the client's display or submission configuration. Int (int(11))
ClientResponses Contains a list of client responses to this content. These are usually submitted using the Workbench. Complex Object (sequence of ClientResponse elements)
ClientResponse Contains data about the response a client left for a reviewer. Complex Object (description of its fields is provided in this table)
Department Identification or location of a physical or web store from which you receive the response. String (varchar(255))
Response Response text. String (text)
ResponseMarkup Wraps possible markup options. Complex Object (description of its fields is provided in this table)
PlainText A plain text version of a response. String (text)
LinkText A link version of a response. String (text)
HighlightText A highlighted version of a response. String (text)
ResponseSource Source from which a response was submitted (such as the Workbench). String (varchar(255))
Date The submission date. Responses and client comments are not moderated. Date (Timestamp)
ClientComments Contains a list of comments that were submitted for a review by a client's personnel. Complex Object (sequence of ClientComment elements)
ClientComment Wraps a comment from a client's personnel for a review. Complex Object (description of its fields is provided in this table)
Name The name of the person who left a comment from the client side. String (varchar(255))
Comment Comment text. String (text)
Photos A set of photo references with captions left by the reviewer (author of any content). Complex Object (sequence of Photo elements)
Photo

Photo references with captions.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))

Complex Object (description of its fields is provided in this table)

Caption A description for a certain piece of media (such as photos or videos) left by a reviewer. String (text)
Sizes A list of images in different sizes (if available). Complex Object (sequence of Size elements)
Size

Contains a URL to an image of a certain size identified by its id attribute.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • url—URL to a certain image of a specific size. URL / String (varchar(255))

    Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).

Empty Object (data in xml attributes)

Avatar

Contains the user avatar, including URLs and sizes.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • photo—Attribute of an Avatar element that specifies whether the provided URL is a photo or not. Boolean

Complex Object (description of its fields is provided in this table)

Videos A set of video references with captions. Complex Object (sequence of Video elements)
Video Contains the URL, ID, and caption of a video left by a reviewer. Complex Object (description of its fields is provided in this table)
VideoHost

The Video Hosting service (such as YouTube).

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
VideoId Identifies a video from a certain video hosting service (such as YouTube). String (varchar(255))
RawUrlInput

URL to a video hosted on a certain video hosting service (such asYouTube).

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([ ]).
URL / String (varchar(255))
ProductReferences Contains a list of references of products linked to a review. Complex Object (sequence of ProductReference elements)
ProductReference Contains a product element with a few fields (refer to the previous example) and a caption left by the content author (reviewer). Complex Object (description of its fields is provided in this table)
Product

A product referenced in the content body (by its author). Refer to the Products and their elements section for more details.

Attributes:

  • id—Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
  • disabled—Marks subjects that were explicitly marked as disabled by the client (using their product catalog). Boolean
  • removed—Marks subjects that were removed from the client's catalog (absent in the product catalog and marked as Inactive in the Bazaarvoice database). Boolean

Complex Object (description of this object is provided in Products and their elements section)

Example

<Review id="123456">
    ...
    <Tags>
    <TagDimension id="Pro">
    <ExternalId>Pro</ExternalId>
    <Label>Pros</Label>
    <Tags>
    <Tag>
    <Label>Entertaining Friends</Label>
    </Tag>
    <Tag>
    <Label>Daily practicing</Label>
    </Tag>
    <Tag>
    <Label>Nice sound</Label>
    </Tag>
    </Tags>
    </TagDimension>
    </Tags>

    <Badges>
    <Badge>
    <Name>top25Contributor</Name>
    <ContentType>REVIEW</ContentType>
    <BadgeType>TopContributorBadge</BadgeType>
    </Badge>
    ...
    </Badges>

    <AdditionalFields>
    <AdditionalField id="HomeDecor">
    <DisplayLabel>My home décor is:</DisplayLabel>
    <Value>Modern</Value>
    </AdditionalField>
    ...
    </AdditionalFields>

    <ContextDataValues>
    <ContextDataValue id="25to34">
    <ExternalId>25to34</ExternalId>
    <Label>25-34</Label>
    <ContextDataDimension id="Age">
    <ExternalId>Age</ExternalId>
    <Label>Age</Label>
    </ContextDataDimension>
    </ContextDataValue>
    <ContextDataValue id="Monthly">
    <ExternalId>Monthly</ExternalId>
    <Label>Monthly</Label>
    <ContextDataDimension id="Frequency">
    <ExternalId>Frequency</ExternalId>
    <Label>Frequency</Label>
    </ContextDataDimension>
    </ContextDataValue>
    ...
    </ContextDataValues>

    <RatingValues>
    <RatingValue>
    <Rating>5</Rating>
    <RatingDimension id="Quality" displayType="NORMAL" selectedValueInDisplayEnabled="false">
    <ExternalId>Quality</ExternalId>
    <RatingRange>5</RatingRange>
    <Label>Quality</Label>
    <Label1>Quality</Label1>
    </RatingDimension>
    </RatingValue>
    <RatingValue>
    <Rating>5</Rating>
    <RatingDimension id="Comfort" displayType="NORMAL" selectedValueInDisplayEnabled="false">
    <ExternalId>Comfort</ExternalId>
    <RatingRange>5</RatingRange>
    <Label>Comfort</Label>
    <Label1>Comfort</Label1>
    </RatingDimension>
    </RatingValue>
    ...
    </RatingValues>

    <ClientResponses>
    <ClientResponse>
    <Department>Something Something Guitar Corp</Department>
    <Response>Our number one priority is to deliver exceptional value to our customers every day. We will contact you directly to check how we can improve the outcome for you.</Response>
    <ResponseMarkup>
    <PlainText>Our number one priority is to deliver exceptional value to our customers every day. We will contact you directly to check how we can improve the outcome for you.</PlainText>
    </ResponseMarkup>
    <ResponseSource>Workbench</ResponseSource>
    <Date>2013-04-12T13:21:43.000-06:00</Date>
    </ClientResponse>
    ...
    </ClientResponses>

    <ClientComments>
    <ClientComment>
    <Date>2013-07-11T12:26:51.000-05:00</Date>
    <Name>client_dude</Name>
    <Comment>Approved by client.</Comment>
    </ClientComment>
    ...
    </ClientComments> 

    <Photos>
    <Photo id="104358">
    <Caption>Me and my new guitar</Caption>
    </Photo>
    ...
    </Photos>

    <Videos>
    <Video>
    <Caption>My soundcheck video</Caption>
    <VideoHost>www.youtube.com</VideoHost>
    <VideoId>abcd123</VideoId>
    <RawUrlInput>http://www.youtube.com/watch?v=abcd123</RawUrlInput>
    </Video>
    ...
    </Videos>

    <Avatar id="466578" photo="true">
    <Sizes>
    <Size id="thumbnail" url="https://reviews.clientName.com/profiles/displayCode/466578/photoThumb.jpg"/>
    <Size id="normal" url="https://reviews.clientName.com/profiles/displayCode/466578/photo.jpg"/>
    ...
    </Sizes>
    </Avatar>

    <ProductReferences>
    <ProductReference>
    <Product id="SF6105" disabled="false" removed="true">
    ...
    </Product>
    <Caption> ... </Caption>
    </ProductReference>
    ...
    </ProductReferences>
    ...
</Review>

User profiles and their elements

Refer to the end of this section for an example.

Element Description Type
ExternalId Identifier of a given object, such as content, subject, dimension, or tag, which is unique among other objects of such type. String (varchar(255))
DisplayName Name of the reviewer displayed with their content. String (varchar(255))
Anonymous A Boolean value that shows whether a given reviewer decided to stay anonymous. If true, most of the information and fields are not displayed. Boolean
HyperlinkingEnabled Indicates if a reviewer's answers will automatically be parsed for hyperlinks. Boolean
ContributorRank The contributor rank assigned to a reviewer. Possible values: TOP_1, TOP_10, TOP_25, TOP_50, TOP_100, TOP_250, TOP_500, TOP_1000, NONE. Enum
SubmissionTime The time that a review was submitted into the Bazaarvoice CMS. Date (Timestamp)
DisplayLocale Contains the locale from which a review was submitted. String (varchar(25))
ModerationStatus Contains information about the current status of a reviewer. Basically, this field can say whether a reviewer is waiting for some action from moderators, CMS, or is approved or rejected. Possible values: NONE, SUBMITTED, APPROVED, HOLD, PENDING, REJECTED, REMOVEDBYCLIENT, REMOVEDTEST, AUTOMATEDHOLD, EXPIRED. Enum
Location Contains information about the location of a user. String (varchar(255))
LastPublishTime The time that a review was moderated and published using the CMS. Date (Timestamp)
Avatar Reference to a user's avatars in different sizes. Refer to the Complex contextual objects section for more details. Complex Object (sequence of Photo elements)
ReviewStatistics Contains stats information about all ratings and reviews of a user. Refer to the ReviewStatistics, QAStatistics, and CommentStatistics blocks section for more details. Complex Object (description of its fields is provided in this doc)
QAStatistics Contains stats information about all questions and answers of a user. Refer to the ReviewStatistics, QAStatistics, and CommentStatistics blocks section for more details. Complex Object (description of its fields is provided in this doc)
ReviewCommentStatistics Contains stats information about all review comments of a user. Refer to the ReviewStatistics, QAStatistics, and CommentStatistics blocks section for more details. Complex Object (description of its fields is provided in this doc)
Badges Contains a list of badges applied to a reviewer. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Badge elements)
AdditionalFields Contains a list of additional (non-default) fields a reviewer record might have. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of AdditionalField elements)
ContextDataValues Contains multiple context data values chosen by a reviewer (such as information about age, habits, or experience). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of ContextDataValue elements)
RatingValues Contains a list of secondary rating stats (ratings chosen by the author for different dimensions or qualities). Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of RatingValue elements)
Photos A set of photo references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. Refer to the Complex contextual objects (content types parts) section for more details. Complex Object (sequence of Video elements)

Example

<UserProfile id="5dd667303d40625232cb5d5aaa409247">
  <ExternalId>5dd667303d40625232cb5d5aaa409247</ExternalId>
  <DisplayName>Doc Brown</DisplayName>
  <Anonymous>false</Anonymous>
  <HyperlinkingEnabled>false</HyperlinkingEnabled>
  <ContributorRank>TOP_25</ContributorRank>
  <SubmissionTime>2016-01-25T16:55:31.000-06:00</SubmissionTime>
  <DisplayLocale>en_US</DisplayLocale>
  <ModerationStatus>APPROVED</ModerationStatus>
  <Location>East Coast</Location>
  <LastPublishTime>2016-01-25T19:30:38.000-06:00</LastPublishTime>

  <!-- Following elements are described in other sections of this doc. Refer to the Example standard client feed table. -->

  <Avatar id="466578" photo="true">
  ...
  </Avatar>

  <ReviewStatistics>
  ...
  </ReviewStatistics>

  <QAStatistics>
  ...
  </QAStatistics>  

  <ReviewCommentStatistics>
  ...
  </ReviewCommentStatistics>

  <Badges>
  ...
  </Badges>

  <RatingValues>
  ...
  </RatingValues>

  <ContextDataValues>
  ...
  </ContextDataValues>

  <AdditionalFields>
  ...
  </AdditionalFields>

  <Photos>
  ...
  </Photos>

  <Videos>
  ...
  </Videos>

</UserProfile>

Example standard client feed

The following example is a simple standard client feed that includes reviews for two products:

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/StandardClientFeed/14.8" name="client_name" extractDate="2016-10-29T00:00:00.000Z">
   <Product disabled="false" removed="true" id="01">
      <Reviews>
         <Review id="10505050">
            <UserProfileReference id="1000">
               <Anonymous>false</Anonymous>
               <DisplayName>CertainSomeone</DisplayName>
               <ExternalId>6000</ExternalId>
               <HyperlinkingEnabled>false</HyperlinkingEnabled>
            </UserProfileReference>
            <ContentCodes>IMP STP</ContentCodes>
            <DisplayLocale>de_DE</DisplayLocale>
            <Featured>false</Featured>
            <FirstPublishTime>2019-04-04T17:26:57.000-06:00</FirstPublishTime>
            <LastModificationTime>2020-10-20T14:15:43.375-05:00</LastModificationTime>
            <LastPublishTime>2021-05-03T16:30:16.000-06:00</LastPublishTime>
            <ModerationStatus>APPROVED</ModerationStatus>
            <NumComments>0</NumComments>
            <NumFeedbacks>0</NumFeedbacks>
            <NumNegativeFeedbacks>0</NumNegativeFeedbacks>
            <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
            <ProductReviewsDeepLinkedUrl>http://c1.ugc.bazaarvoice.com/10000/02/review/10505050/redirect.htm</ProductReviewsDeepLinkedUrl>
            <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/10000/02/reviews.htm?reviewID=20505050</ProductReviewsUrl>
            <Rating>5</Rating>
            <RatingRange>5</RatingRange>
            <RatingsOnly>false</RatingsOnly>
            <ReviewText>Generic Review Text. Love the product, can't speak highly enough of it.</ReviewText>
            <ReviewerNickname>CertainSomeone</ReviewerNickname>
            <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
            <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
            <Source>
               <Name>generic</Name>
               <ExternalContentId>40000</ExternalContentId>
            </Source>
            <SubmissionTime>2019-05-03T15:40:57.000-06:00</SubmissionTime>
            <Title>good</Title>
            <Videos/>
         </Review>
         <Review id="59837721">
            <UserProfileReference id="202752">
               <Anonymous>false</Anonymous>
               <DisplayName>CertainSomeone</DisplayName>
               <ExternalId>2101992</ExternalId>
               <HyperlinkingEnabled>false</HyperlinkingEnabled>
            </UserProfileReference>
            <ContentCodes>GEN PRO</ContentCodes>
            <DisplayLocale>fr_FR</DisplayLocale>
            <Featured>false</Featured>
            <FirstPublishTime>2015-02-09T16:26:57.000-06:00</FirstPublishTime>
            <LastModificationTime>2019-10-20T12:10:47.584-05:00</LastModificationTime>
            <LastPublishTime>2020-04-02T10:40:57.000-08:00</LastPublishTime>
            <ModerationStatus>APPROVED</ModerationStatus>
            <NumComments>0</NumComments>
            <NumFeedbacks>0</NumFeedbacks>
            <NumNegativeFeedbacks>0</NumNegativeFeedbacks>
            <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
            <ProductReviewsDeepLinkedUrl>http://c1.ugc.bazaarvoice.com/5000/02/review/10505050/redirect.htm</ProductReviewsDeepLinkedUrl>
            <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/50590/02/reviews.htm?reviewID=10505050</ProductReviewsUrl>
            <Rating>5</Rating>
            <RatingRange>5</RatingRange>
            <RatingsOnly>false</RatingsOnly>
            <ReviewText>Superb product that does the job required. Thank you so much!
            </ReviewText>
            <ReviewerNickname>CertainSomeone</ReviewerNickname>
            <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
            <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
            <Source>
               <Name>snapav</Name>
               <ExternalContentId>500000</ExternalContentId>
            </Source>
            <SubmissionTime>2019-03-02T16:26:57.000-06:00</SubmissionTime>
            <Title>fantastic product</Title>
            <Videos/>
         </Review>
      </Reviews>
      <ExternalId>01</ExternalId>
      <Source>genericshop</Source>
      <NativeReviewStatistics>
         <AverageOverallRating>5.0</AverageOverallRating>
         <NotRecommendedCount>0</NotRecommendedCount>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
         <RecommendedCount>0</RecommendedCount>
         <TotalReviewCount>2</TotalReviewCount>
         <AverageRatingValues/>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>2</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </NativeReviewStatistics>
      <NumAnswers>0</NumAnswers>
      <NumNativeAnswers>0</NumNativeAnswers>
      <NumNativeQuestions>0</NumNativeQuestions>
      <NumQuestions>0</NumQuestions>
      <NumReviews>2</NumReviews>
      <ReviewStatistics>
         <AverageOverallRating>5.0</AverageOverallRating>
         <NotRecommendedCount>0</NotRecommendedCount>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
         <RecommendedCount>0</RecommendedCount>
         <TotalReviewCount>2</TotalReviewCount>
         <AverageRatingValues/>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>2</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </ReviewStatistics>
      <CategoryItems>
         <CategoryItem id="BV_MISCELLANEOUS_CATEGORY">
            <ExternalId>BV_MISCELLANEOUS_CATEGORY</ExternalId>
            <CategoryName>Miscellaneous</CategoryName>
            <CategoryId>900000000</CategoryId>
         </CategoryItem>
      </CategoryItems>
      <UPCs>
         <UPC>5749575749</UPC>
      </UPCs>
      <EANs>
         <EAN>1234567890123</EAN>
      </EANs>   
   </Product>
   <Product disabled="false" removed="false" id="1529-A">
      <Reviews>
         <Review id="75874633">
            <UserProfileReference id="506978">
               <Anonymous>false</Anonymous>
               <DisplayName>CertainSomeone</DisplayName>
               <ExternalId>506978</ExternalId>
               <HyperlinkingEnabled>false</HyperlinkingEnabled>
            </UserProfileReference>
            <ContentCodes>GEN STU SHO</ContentCodes>
            <DisplayLocale>en_US</DisplayLocale>
            <Featured>false</Featured>
            <FirstPublishTime>2020-11-26T17:19:09.000-05:00</FirstPublishTime>
            <LastModificationTime>2015-05-21T20:10:07.236-05:00</LastModificationTime>
            <LastPublishTime>2019-10-16T10:20:04.000-05:00</LastPublishTime>
            <ModerationStatus>APPROVED</ModerationStatus>
            <NumComments>0</NumComments>
            <NumFeedbacks>0</NumFeedbacks>
            <NumNegativeFeedbacks>0</NumNegativeFeedbacks>
            <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
            <ProductReviewsDeepLinkedUrl>http://c1.ugc.bazaarvoice.com/50000/7777-A/review/19586790/redirect.htm</ProductReviewsDeepLinkedUrl>
            <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/60000/6666-A/reviews.htm?reviewID=12345678</ProductReviewsUrl>
            <Rating>4</Rating>
            <RatingRange>5</RatingRange>
            <RatingsOnly>false</RatingsOnly>
            <ReviewText>Generic Review of a good product</ReviewText>
            <ReviewerNickname>CertainSomeone</ReviewerNickname>
            <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
            <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
            <Source>
               <Name>generic</Name>
               <ExternalContentId>500000</ExternalContentId>
            </Source>
            <SubmissionTime>2019-01-15T20:10:16.000-05:00</SubmissionTime>
            <Title>Bag</Title>
            <Videos/>
         </Review>
      </Reviews>
      <ImageUrl>http://www.genericstore.com/shop/images/genericitem.jpg</ImageUrl>
      <Name>CLC ToolWorks Center Tray Tool Bag</Name>
      <ExternalId>1529-A</ExternalId>
      <Description>CLC ToolWorks Center Tray Tool Bag</Description>
      <Source>snapav</Source>
      <ProductPageUrl>http://www.genericstore.com/shop/de/item</ProductPageUrl>
      <NativeReviewStatistics>
         <AverageOverallRating>4.0</AverageOverallRating>
         <NotRecommendedCount>0</NotRecommendedCount>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
         <RecommendedCount>0</RecommendedCount>
         <TotalReviewCount>1</TotalReviewCount>
         <AverageRatingValues/>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </NativeReviewStatistics>
      <NumAnswers>0</NumAnswers>
      <NumNativeAnswers>0</NumNativeAnswers>
      <NumNativeQuestions>0</NumNativeQuestions>
      <NumQuestions>0</NumQuestions>
      <NumReviews>1</NumReviews>
      <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/99999/2000-A/reviews.htm</ProductReviewsUrl>
      <ReviewStatistics>
         <AverageOverallRating>4.0</AverageOverallRating>
         <NotRecommendedCount>0</NotRecommendedCount>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
         <RecommendedCount>0</RecommendedCount>
         <TotalReviewCount>1</TotalReviewCount>
         <AverageRatingValues/>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </ReviewStatistics>
      <CategoryItems>
         <CategoryItem id="Purchased_Item">
            <ExternalId>Purchased Item</ExternalId>
            <CategoryName>Stuff</CategoryName>
            <CategoryId>73596056</CategoryId>
         </CategoryItem>
         <CategoryItem id="Purchased_Item_2">
            <ExternalId>Purchased Item 2</ExternalId>
            <CategoryName>Stuff 2</CategoryName>
            <CategoryId>65657687</CategoryId>
         </CategoryItem>
      </CategoryItems>
      <UPCs>
         <UPC>11223344556</UPC>
      </UPCs>
      <EANs>
         <EAN>09876543210</EAN>
      </EANs>
      <ManufacturerPartNumbers>
         <ManufacturerPartNumber>6565-B</ManufacturerPartNumber>
      </ManufacturerPartNumbers>
   </Product>
</Feed>

Ratings-only export feed

A ratings-only export feed is a daily, XML-based file that is exported from Bazaarvoice and contains product-specific, ratings-related content including values such as:

  • Product IDs
  • Number of reviews
    • Total number of reviews
    • Number of reviews that feature only ratings
  • Number of reviewers who would recommend the product
  • Average overall ratings
  • Maximum rating values

Data from a ratings-only export feed is useful for completing the following tasks:

  • Enabling star ratings on category pages of your website
  • Improving site search and navigation
  • Providing snapshots, averages, and other values that assist with sorting
Note: Your critical processes and product detail pages (PDP) should not rely on export feeds. While Bazaarvoice tries to consistently generate these feeds, server loads and other variables can delay the export. Only use export feeds for non-critical processes so that a delayed feed update does not critically impact any of your systems, processes, PDPs, or services. In addition, do not use export feeds for display purposes.

The following values represent the default configuration for a ratings-only feed:

  • Frequency – Daily
  • History – Full
  • Format – XML
  • Compression – GZIP
  • Delivery location – Bazaarvoice SFTP Server
  • Content type - Reviews or Questions/Answers
  • Moderation Status – Approved
  • Inactive / Disabled – Does not include inactive products

Retrieve a ratings-only export feed

Retrieve your ratings-only export feeds on a recurring basis from the SFTP location where they are stored after Bazaarvoice generates them. Download and process this feed on a daily basis to update the areas of your website that use the information. Supply a public SSH key if you want to automate this process by using SSH entry without a password.

Download the feed file from the /feeds directory on the Bazaarvoice SFTP location:

  • If your data is hosted in the US, use the following URLs:
    • Staging server—sftp-stg.bazaarvoice.com
    • Production server—sftp.bazaarvoice.com
  • If your data is hosted in Europe, use the following URLs:
    • Staging server—sftp7-stg.bazaarvoice.com
    • Production server—sftp7.bazaarvoice.com

Be sure to connect to SFTP using port 22. Contact Bazaarvoice Support if you do not know your SFTP credentials or where your data is hosted.

XML schema

The XML schema for your ratings-only export feed is based on the syndication feed schema, which resides at the following location:

http://www.bazaarvoice.com/xs/PRR/SyndicationFeed/version

where version is the appropriate Bazaarvoice release number. For example, the XML schema for the syndication feed that is associated with version 14.7 resides at the following location:

http://www.bazaarvoice.com/xs/PRR/SyndicationFeed/14.7

Complete the following steps to select the XML schema version you want to use.

  1. Sign in to the Bazaarvoice Portal .
  2. From the upper-right corner, select the settings icon settings icon.
  3. Select Configuration.
  4. Select the Bazaarvoice instance.
  5. Select Go to Configuration. The Site Manager appears, listing the available deployment zones and implementations.
  6. Under Implementations, select Edit beside the implementation whose ratings-only export feed schema you want to change.
  7. Under Getting Started, select Technical Setup.
  8. Select the Export Feeds tab and scroll to the UGC Statistics (Ratings) Feed section.
  9. From the XML Schema Version list, select the version you want to use.
    Note: Select 14.9 (latest) to use the schema that includes statistics about incentivized reviews. Refer to the Example schema version 14.9 section for more information about incentivized review counts in ratings-only feeds.
  10. Deploy your changes.

Example schema version 14.7

The following is a simple example of a ratings-only export feed based on schema version 14.7. For more information about the elements in this schema, refer to the tables in the ReviewStatistics, QAStatistics, and CommentStatistics blocks section.

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/SyndicationFeed/14.7" name="client_name" extractDate="2023-10-05T00:00:00.000Z">
   <Product removed="false" id="Product11">
      <ImageUrl>http://display.ugc.bazaarvoice.com/common/test/images/white_evening_primrose.jpg</ImageUrl>
      <Name>Oenothera speciosa</Name>
      <ExternalId>Product11</ExternalId>
      <Description>Pink evening primrose features fragrant, bowl-shaped, four-petaled, pink flowers (to 2-3" diameter) with yellow anthers that bloom from the upper leaf axils in late spring.</Description>
      <Brand>
         <ExternalId>sampleBrand</ExternalId>
         <Name>Flowers</Name>
         <Attributes>
            <Attribute id="NAME">
               <Value>Flowers</Value>
            </Attribute>
         </Attributes>
      </Brand>
      <Source>testcustomer-bulk-client-1</Source>
      <ProductPageUrl>http://en.wikipedia.org/wiki/Oenothera_speciosa</ProductPageUrl>
      <NativeReviewStatistics>
         <AverageOverallRating>4.8</AverageOverallRating>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
         <RecommendedCount>5</RecommendedCount>
         <TotalReviewCount>5</TotalReviewCount>
         <AverageRatingValues>
            <AverageRatingValue id="Quality">
               <AverageRating>4.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                  <ExternalId>Quality</ExternalId>
                  <Label>Quality of Product</Label>
                  <Label1>How would you rate the quality of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
            <AverageRatingValue id="Value">
               <AverageRating>5.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                  <ExternalId>Value</ExternalId>
                  <Label>Value of Product</Label>
                  <Label1>How would you rate the value of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
         </AverageRatingValues>
         <LocaleDistribution>
            <LocaleDistributionItem>
               <DisplayLocale>en_US</DisplayLocale>
               <ReviewStatistics>
                  <AverageOverallRating>4.8</AverageOverallRating>
                  <OverallRatingRange>5</OverallRatingRange>
                  <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
                  <RecommendedCount>5</RecommendedCount>
                  <TotalReviewCount>5</TotalReviewCount>
                  <AverageRatingValues>
                     <AverageRatingValue id="Quality">
                        <AverageRating>4.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                           <ExternalId>Quality</ExternalId>
                           <Label>Quality of Product</Label>
                           <Label1>How would you rate the quality of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                     <AverageRatingValue id="Value">
                        <AverageRating>5.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                           <ExternalId>Value</ExternalId>
                           <Label>Value of Product</Label>
                           <Label1>How would you rate the value of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                  </AverageRatingValues>
                  <RatingDistribution>
                     <RatingDistributionItem>
                        <RatingValue>4</RatingValue>
                        <Count>1</Count>
                     </RatingDistributionItem>
                     <RatingDistributionItem>
                        <RatingValue>5</RatingValue>
                        <Count>4</Count>
                     </RatingDistributionItem>
                  </RatingDistribution>
               </ReviewStatistics>
            </LocaleDistributionItem>
         </LocaleDistribution>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>4</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </NativeReviewStatistics>
      <NumAnswers>11</NumAnswers>
      <NumNativeAnswers>11</NumNativeAnswers>
      <NumNativeQuestions>5</NumNativeQuestions>
      <NumQuestions>5</NumQuestions>
      <NumReviews>7</NumReviews>
      <ReviewStatistics>
         <AverageOverallRating>4.8571</AverageOverallRating>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
         <RecommendedCount>7</RecommendedCount>
         <TotalReviewCount>7</TotalReviewCount>
         <AverageRatingValues>
            <AverageRatingValue id="Quality">
               <AverageRating>4.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                  <ExternalId>Quality</ExternalId>
                  <Label>Quality of Product</Label>
                  <Label1>How would you rate the quality of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
            <AverageRatingValue id="Value">
               <AverageRating>5.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                  <ExternalId>Value</ExternalId>
                  <Label>Value of Product</Label>
                  <Label1>How would you rate the value of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
         </AverageRatingValues>
         <LocaleDistribution>
            <LocaleDistributionItem>
               <DisplayLocale>en_US</DisplayLocale>
               <ReviewStatistics>
                  <AverageOverallRating>4.8571</AverageOverallRating>
                  <OverallRatingRange>5</OverallRatingRange>
                  <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
                  <RecommendedCount>7</RecommendedCount>
                  <TotalReviewCount>7</TotalReviewCount>
                  <AverageRatingValues>
                     <AverageRatingValue id="Quality">
                        <AverageRating>4.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                           <ExternalId>Quality</ExternalId>
                           <Label>Quality of Product</Label>
                           <Label1>How would you rate the quality of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                     <AverageRatingValue id="Value">
                        <AverageRating>5.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                           <ExternalId>Value</ExternalId>
                           <Label>Value of Product</Label>
                           <Label1>How would you rate the value of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                  </AverageRatingValues>
                  <RatingDistribution>
                     <RatingDistributionItem>
                        <RatingValue>4</RatingValue>
                        <Count>1</Count>
                     </RatingDistributionItem>
                     <RatingDistributionItem>
                        <RatingValue>5</RatingValue>
                        <Count>6</Count>
                     </RatingDistributionItem>
                  </RatingDistribution>
               </ReviewStatistics>
            </LocaleDistributionItem>
         </LocaleDistribution>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>6</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </ReviewStatistics>
      <CategoryItems>
         <CategoryItem id="sampleCategory">
            <ExternalId>sampleCategory</ExternalId>
            <CategoryName>Flowers Category</CategoryName>
            <CategoryId>707703608</CategoryId>
         </CategoryItem>
      </CategoryItems>
   </Product>
</Feed>

Example schema version 14.9

Schema version 14.9 includes statistics about the number of incentivized reviews you have. The element IncentivizedReviewCount is part of the ReviewStatistics block. Review statistics are included at following levels:

  • Product > ReviewStatistics - Statistics about native, family, and syndicated product reviews.
  • Product > NativeReviewStatistics - Statistics about native product reviews.
  • Product > LocaleDistribution > LocaleDistributionItem > ReviewStatistics - Statistics about products for each locale. LocaleDistribution is in both Product > ReviewStatistics and NativeReviewStatistics.

The following example shows the schema 14.9 ReviewStatistics block containing IncentivizedReviewCount.

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/SyndicationFeed/14.9" name="client_name" extractDate="2023-09-29T00:00:00.000Z">
   <Product removed="false" id="Product11">
      <!-- ... Content within the Product element ... -->
      <NativeReviewStatistics>
         <AverageOverallRating>4.8</AverageOverallRating>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
         <RecommendedCount>5</RecommendedCount>
         <IncentivizedReviewCount>1</IncentivizedReviewCount>
         <TotalReviewCount>5</TotalReviewCount>
         <AverageRatingValues>
            <AverageRatingValue id="Quality">
               <AverageRating>4.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                  <ExternalId>Quality</ExternalId>
                  <Label>Quality of Product</Label>
                  <Label1>How would you rate the quality of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
            <AverageRatingValue id="Value">
               <AverageRating>5.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                  <ExternalId>Value</ExternalId>
                  <Label>Value of Product</Label>
                  <Label1>How would you rate the value of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
         </AverageRatingValues>
         <LocaleDistribution>
            <LocaleDistributionItem>
               <DisplayLocale>en_US</DisplayLocale>
               <ReviewStatistics>
                  <AverageOverallRating>4.8</AverageOverallRating>
                  <OverallRatingRange>5</OverallRatingRange>
                  <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
                  <RecommendedCount>5</RecommendedCount>
                  <IncentivizedReviewCount>1</IncentivizedReviewCount>
                  <TotalReviewCount>5</TotalReviewCount>
                  <AverageRatingValues>
                     <AverageRatingValue id="Quality">
                        <AverageRating>4.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                           <ExternalId>Quality</ExternalId>
                           <Label>Quality of Product</Label>
                           <Label1>How would you rate the quality of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                     <AverageRatingValue id="Value">
                        <AverageRating>5.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                           <ExternalId>Value</ExternalId>
                           <Label>Value of Product</Label>
                           <Label1>How would you rate the value of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                  </AverageRatingValues>
                  <RatingDistribution>
                     <RatingDistributionItem>
                        <RatingValue>4</RatingValue>
                        <Count>1</Count>
                     </RatingDistributionItem>
                     <RatingDistributionItem>
                        <RatingValue>5</RatingValue>
                        <Count>4</Count>
                     </RatingDistributionItem>
                  </RatingDistribution>
               </ReviewStatistics>
            </LocaleDistributionItem>
         </LocaleDistribution>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>4</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </NativeReviewStatistics>
      <NumAnswers>11</NumAnswers>
      <NumNativeAnswers>11</NumNativeAnswers>
      <NumNativeQuestions>5</NumNativeQuestions>
      <NumQuestions>5</NumQuestions>
      <NumReviews>7</NumReviews>
      <ReviewStatistics>
         <AverageOverallRating>4.8571</AverageOverallRating>
         <OverallRatingRange>5</OverallRatingRange>
         <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
         <RecommendedCount>7</RecommendedCount>
         <IncentivizedReviewCount>1</IncentivizedReviewCount>
         <TotalReviewCount>7</TotalReviewCount>
         <AverageRatingValues>
            <AverageRatingValue id="Quality">
               <AverageRating>4.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                  <ExternalId>Quality</ExternalId>
                  <Label>Quality of Product</Label>
                  <Label1>How would you rate the quality of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
            <AverageRatingValue id="Value">
               <AverageRating>5.0</AverageRating>
               <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                  <ExternalId>Value</ExternalId>
                  <Label>Value of Product</Label>
                  <Label1>How would you rate the value of this product?</Label1>
                  <RatingRange>5</RatingRange>
               </RatingDimension>
            </AverageRatingValue>
         </AverageRatingValues>
         <LocaleDistribution>
            <LocaleDistributionItem>
               <DisplayLocale>en_US</DisplayLocale>
               <ReviewStatistics>
                  <AverageOverallRating>4.8571</AverageOverallRating>
                  <OverallRatingRange>5</OverallRatingRange>
                  <RatingsOnlyReviewCount>3</RatingsOnlyReviewCount>
                  <RecommendedCount>7</RecommendedCount>
                  <IncentivizedReviewCount>1</IncentivizedReviewCount>
                  <TotalReviewCount>7</TotalReviewCount>
                  <AverageRatingValues>
                     <AverageRatingValue id="Quality">
                        <AverageRating>4.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
                           <ExternalId>Quality</ExternalId>
                           <Label>Quality of Product</Label>
                           <Label1>How would you rate the quality of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                     <AverageRatingValue id="Value">
                        <AverageRating>5.0</AverageRating>
                        <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
                           <ExternalId>Value</ExternalId>
                           <Label>Value of Product</Label>
                           <Label1>How would you rate the value of this product?</Label1>
                           <RatingRange>5</RatingRange>
                        </RatingDimension>
                     </AverageRatingValue>
                  </AverageRatingValues>
                  <RatingDistribution>
                     <RatingDistributionItem>
                        <RatingValue>4</RatingValue>
                        <Count>1</Count>
                     </RatingDistributionItem>
                     <RatingDistributionItem>
                        <RatingValue>5</RatingValue>
                        <Count>6</Count>
                     </RatingDistributionItem>
                  </RatingDistribution>
               </ReviewStatistics>
            </LocaleDistributionItem>
         </LocaleDistribution>
         <RatingDistribution>
            <RatingDistributionItem>
               <RatingValue>4</RatingValue>
               <Count>1</Count>
            </RatingDistributionItem>
            <RatingDistributionItem>
               <RatingValue>5</RatingValue>
               <Count>6</Count>
            </RatingDistributionItem>
         </RatingDistribution>
      </ReviewStatistics>
      <!-- ... More content within the Product element ... -->
   </Product>
</Feed>
Note: IncentivizedReviewCount is available only with the ratings-only export feed, not with the standard client feed or DCE.

Displayable Content Export

For performance, flexibility, or security reasons, your company might need to limit dependencies on third-party services that power your websites. Bazaarvoice Displayable Content Export (DCE) provides a way to store UGC locally and display the content without calling the Bazaarvoice Ratings & Reviews Collect-Distribute display infrastructure.

DCE is designed to be consumed in bulk periodically, and the UGC is intended for public display on websites and other applications. Do not use DCE with internal applications, such as CRM systems or analytics dashboards, because it does not contain all content relevant to those applications. You can obtain DCE through the use of an HTTPS interface by first enabling the request and then transferring the content files.

Note: Bazaarvoice generates full weekly DCE feed on Mondays, but there is no set time when the feed is available to the users.

Benefits of DCE

DCE offers the following benefits:

  • A service optimized for downloading displayable content in bulk
  • A single source of displayable native and syndicated UGC from the Bazaarvoice Network, which does not include personally identifiable information (PII)
  • Independence from the Bazaarvoice real-time display (API and hosted display)
  • Easy identification of configurable elements, such as ratings dimensions
  • Data normalization to facilitate transmission and import into a relational database

DCE comprises normalized content, including native content and syndicated content, configuration data, and product data. DCE does not include the following content:

  • Pending UGC
  • Rejected UGC
  • Approved UGC that was not syndicated due to other reasons (such as content codes)

How to use the DCE

To obtain and import the DCE, you must use the DCE HTTPS interface to securely request and transfer the manifest and content files. DCE provides content in a machine-readable format (JSON), which you will then use in an application that you must build, host, and maintain. Therefore, your team should have the following proficiencies:

  • Web application development
  • Client/server interaction based on the HTTPS protocol
  • The ability to process JSON
  • Data storage, retrieval, and manipulation

Workflow

The following diagram illustrates the contents of DCE and how to import and display the content:

Native and syndicated content is aggregated and normalized to create DCE. A manifest file is also created and provides a map of the data and includes a URL for each file in DCE.

To import and display UGC included in DCE, you must perform these steps:

  1. Request the manifest file.
  2. Request the content files that are listed in the manifest, which contain UGC, configuration data, and product data.
  3. Import the UGC, configuration, and product data into your database.
  4. Assemble the data relevant to the product that is displayed and render the UGC on your website or application.

Refer to the Bazaarvoice Developer site for complete information and instructions about the HTTPS interface.