Bazaarvoice offers export files that contain product data and consumer-generated content (CGC). 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 Conversations 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 CGC 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. This feed is most often used to power the inline ratings display.
  • Displayable content export (DCE)—Provides a way to store CGC locally and display the content without calling the Bazaarvoice Conversations display infrastructure. It is designed to be consumed in bulk periodically, and the CGC 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, questions, answers, and campaign items
  • Consumer-generated content 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 data stores in the event of unprocessed or lost feed content.

Enable and schedule standard client feeds

Note: This is a Bazaarvoice-internal configuration option. Contact Bazaarvoice Client Care to enable and configure these settings.

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. Log in to the Workbench and then click Settings » Manage Applications. The Site Manager page of the Conversations configuration hub is displayed.
  2. Edit the implementation for which you want to receive standard client feeds.
  3. Click Technical Setup on the left side of the page and then click the Export Feeds tab.
  4. To enable and schedule full client feeds:
    • Click the Enabled toggle switch in the Full Standard Content Feed section of the page.
  5. To enable and schedule incremental feeds:
    • Click the Enabled toggle switch in the Incremental Standard Content Feed section of the page.
  6. Deploy the changes to the implementation.
  7. 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. If you do not know your SFTP credentials or where your data is hosted, contact Bazaarvoice Client Care .

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

Click here for an example.

Element Description Type
Feed

A root element of the XML feed file.

Attributes:

  • xmlns—Holds schema version of a given XML file. String (varchar(255))
  • name—Client's name. String (varchar(255))
  • extractDate—Holds 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. More details.

Attributes:

  • id—An identifier (in the same form it was 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 consumer-generated content are not present in the feed by default. However, if the client confirms that this data is needed in a daily feed, it can be configured to be present.

Complex Object

Category

Another type of a client's subject. Much like a Product, it holds information about category subject, its content, and stats. More details.

Attributes:

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

Complex Object

UserProfile

Holds information about a certain user (such as a reviewer) and its stats. More details.

Attributes:

  • id—An identifier (in the same form it was 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.7" 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

Click here for an example.

Element Description Type
Source A source of this piece of data in Bazaarvoice system. Basically, this is a client name. String (varchar(255))
ExternalId An identifier (in the same form it was provided by 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

A name of a product taken from a 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

A description of a product taken from a 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 product has multiple product page URLs for a set of locales. Otherwise, ProductPageUrl element is used. Complex Object (sequence of ProductPageUrl elements)
ProductPageUrl

A URL to a Product Page on 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 ReviewsPage Titles for each locale. Complex Object (sequence of ReviewsPageTitle elements)
ReviewsPageTitle

A Title of 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 client provided multiple ReviewsPage 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

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

Note: If Conversations 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 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))
ProductStoriesUrl

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

http://stories.<clientName>.com/stories/<displayCode>/product/<productID>/stories.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 Holds 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 Holds multiple manufacturer part numbers applicable to a current product. Complex Object (sequence of ManufacturerPartNumber elements)
ManufacturerPartNumber A 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)
NumStories Number of approved stories for this product (including syndication). Int (4-byte integer)
ReviewStatistics Holds detailed information about all ratings and reviews of the product (stats including syndication). More details. Complex Object (description of its fields is provided below in this doc)
NativeReviewStatistics Holds detailed information about native ratings and reviews of the product (non-syndication stats). More details. Complex Object (description of its fields is provided below in this doc)
Brand Holds reference to a Brand of a given Product. More details. Complex Object (description of its fields is provided below in this doc)
CategoryItems Holds reference to a Categories element, under which a given Product resides. Categories are represented as a chain sorted from the child to root. More details. Complex Object (sequence of CategoryItem elements)
Attributes Holds a list of any custom and additional attributes of a Product. More details. Complex Object (sequence of Attribute elements)
Questions Root for all questions related to this product. More details. Complex Object (sequence of Question elements)
Reviews Root for all reviews related to this product. More details. Complex Object (sequence of Review elements)
Stories Root for all stories related to this product. More details. Complex Object (sequence of Story 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>  
  <ProductStoriesUrl>http://stories.lecoolretailer.com/stories/1234/product/154812/stories.htm</ProductStoriesUrl>

  <!-- 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>
  <NumStories>11</NumStories>
  <NumReviews>42</NumReviews>

  <!-- Examples and descriptions of below 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>

  <Stories>
  ...
  </Stories>
</Product>

Categories and their elements

Click here 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 it was 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 an ExternalId and a single Name elements. Complex Object (sequence of Category objects)
Name

Name of a category taken from a client's product catalog. 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)

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

A URL to a Category Page on 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 Holds 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 ReviewsPage Titles for each locale. Complex Object (sequence ofReviewsPageTitle 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 ReviewsPage 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)
NumStories Number of approved stories for this category (including syndication). Int (4-byte integer)
Attributes Holds a list of any custom and additional attributes of a given category. More details. Complex Object (sequence of Attribute elements)
Questions Root for all questions related to this category. More details. Complex Object (sequence of Question elements)
Stories Root for all stories related to this category. More details. Complex Object (sequence of Story 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 holds 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>
  <NumStories>5</NumStories>

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

  <Attributes>
  ...
  </Attributes>

  <Questions>
  ...
  </Questions>

  <Stories>
  ...
  </Stories>
</Category>

Attributes, Brands, and CategoryItems

Click here for an example.

Element Description Type
Brand

Holds reference to a 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

A name of a product taken from client's product catalog. 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)

ExternalId An identifier in the same form it was provided by client in their product catalog, usually identical to the id attribute. String (varchar(255))
CategoryItems This block holds 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 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 A name of a given category item. String (varchar(255))
Attributes Holds a list of any 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 Bazaarvoice network. String (varchar(255))

Complex Object (holds a single Value element)

Value Holds 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, StoryStatistics, 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.

Click here 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 he or she would recommend this product to a friend. Int (4-byte Integer)
AverageRatingValues Holds 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 (description of its fields is provided below in this table)

AverageRating Holds 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 OverallRatingRange element, this elements shows 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 Holds 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 (description of its fields is provided below in this table)
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 (description of its fields is provided below in this table)
TagDimension

A dimension by which 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 a certain type. String (varchar(255))

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

TagDistributionItems Holds 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 Holds 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 LocaleDistribution map that holds 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 certain amount of reviews were submitted for this product. String (varchar(25))
ReviewStatistics Review statistic block that holds 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 location of a Count XML element). Int (4-byte Integer)
QAStatistics A block that holds stats information about all questions and answers of a user. Complex Object (described in this section)
ReviewCommentStatistics A block that holds stats information about all review comments of a user. Complex Object (described in this section)
StoryCommentStatistics A block that holds stats information about all story comments of a user. Complex Object (described in this section)
StoryStatistics A block that holds stats information about all stories of a user. Complex Object (described in this section)
TotalQuestionsCount Number of approved questions a certain user submitted. 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)
FeaturedStoryCount Number of user's stories 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)
NumStories Total number of approved stories 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. Check example above and description in a table below. -->
  <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>

  <StoryStatistics>
  <NumStories>2</NumStories>
  <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>
  </StoryStatistics>

  <StoryCommentStatistics>
  <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>
  </StoryCommentStatistics>

  ...
  </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

Click here for an example.

Element Description Type
Review

Holds 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 Holds 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

Holds information about a user's profile (see 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). 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 Holds a review title in a form specified by its author. String (varchar(255))
ReviewText Holds the full text of a review in a form specified by its author. String (text)
DisplayLocale Holds a 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. More details. Complex Object (sequence of TagDimension elements)
AdditionalFields Contains a list of additional (non-default) fields the review might have. More details. Complex Object (sequence of AdditionalField elements)
Comments Contains a list of comments that were submitted for a given review. 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 he or she will recommend this product to a friend. boolean
NumFeedbacks Number of any 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 author's (reviewer's) email address. String (varchar(255))
SendEmailAlertWhenPublished A boolean value that shows whether the user decided to receive email when his or her review gets published or not. boolean
SendEmailAlertWhenCommented A boolean value that shows whether the user decided to receive email when his or her review gets commented on by others or not. boolean
SendEmailAlertWhenCommentedOptOutURL

Holds OptOut URL that can be sent out to a user with an email and allows him or her 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). 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). More details. Complex Object (sequence of RatingValue elements)
Photos A set of photo references with some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. 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. 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 that are provided with Conversations. String (varchar(255))
AuthenticationType Type of authentication of a given user (review author). Can be SITE, FACEBOOK, or EMAIL. Enum
ProductReferences Holds a list of references of products linked to a review. More details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given review or its author. More details. Complex Object (sequence of Badge elements)
IpAddress Field holds an address of reviewer. 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. Those are usually submitted using the Workbench. More details. Complex Object (sequence of ClientResponse elements)
FirstPublishTime Date and time of the first time this review was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this review was published (sometimes that 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>

    <!-- Below elements are described in other sections of this doc. See references in a table below. -->

    <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>

Story type

Click here for an example.

Element Description Type
Story

Holds information about one of the stories submitted for a given product or category.

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 Holds information about the current status of a given story. Basically, this field can say whether or not a story 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 story, its author, or any of its comments. The latest timestamp will be listed. Date (Timestamp)
UserProfileReference / Reviewer / User

Hold information about certain user profiles (see the example snippet for all possible fields of this block). Depending on the scheme version, block name might differ (Reviewer, User, or UserProfileReference). 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)

StoryRatingFeedback Holds information about the rating of a given story. Complex Object (description of its fields is provided in this table below)
Range 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))
NumRatingFeedbacks Number of feedback entries given for this story. Int (int(11))
ComputedScore Average rating that is recalculated with a consideration of median score ((max + min)/ 2). Float (4-bytes)
AverageScore Average rating of a given review. Float (4-bytes)
Title Holds a story title in a form specified by its author. String (varchar(255))
ReviewText Holds the full text of a story in a form specified by its author. String (text)
DisplayLocale Holds the locale from which the story was submitted. String (varchar(25))
UserNickname A nickname chosen by a story author. String (varchar(255))
UserLocation A location of a story author. String (varchar(255))
Tags Contains a list of tag dimensions. More details. Complex Object (sequence of TagDimension elements)
AdditionalFields Contains a list of additional (non-default) fields story might have. More details. Complex Object (sequence of AdditionalField elements)
Comments Contains a list of comments that were submitted for a given story. More details. Complex Object (sequence of Comment elements)
NumFeedbacks Number of any feedback entries on a given story (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given story. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given story. Int (4-byte integer)
UserEmailAddress If client prefers to get PII data in the feed, this field should be included. This is the author's (reviewer's) email address. String (varchar(255))
SendEmailAlertWhenPublished A boolean value that shows whether or not the user decided to receive email when his or her story gets published or not. boolean
SendEmailAlertWhenCommented A boolean value that shows whether or not the user decided to receive email when his or her story gets commented on by others or not. boolean
SendEmailAlertWhenCommentedOptOutURL

Holds OptOut URL that can be sent out to a user with an email and allows him or her 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))
ProductStoriesDeepLinkedUrl

Another URL that leads directly to a given story.

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 the reviewer (like information about age, habits, or experience). More details. Complex Object (sequence of ContextDataValue elements)
Photos A set of photo references with some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. More details. Complex Object (sequence of Video elements)
NumComments Number of comments that were approved for a given story. Int (4-byte integer)
SubmissionTime Time a given story was submitted by its author (before moderation process). Date (Timestamp)
CampaignId String value that specifies the source of a story, such as the platform or origins. Refer to this list of campaign IDs that are provided with Conversations. String (varchar(255))
AuthenticationType Specifies type of authentication of a given user (story author). Possible values: SITE, FACEBOOK or EMAIL. Enum
ProductReferences Holds a list of references of products linked to a story. More details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given story or its author. More details. Complex Object (sequence of Badge elements)
IpAddress Field holds the address of a reviewer. Field is a PII, which can be turned on or off. String (varchar(255))
OriginatingDisplayCode This display code is an identification of client's display configurations that were used for submission of a given story. 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 of some other store or reason why the review was approved or rejected. String (text)
ClientResponses Contains a list of client responses to the story. Those are usually submitted using the Workbench. More details. Complex Object (sequence of ClientResponse elements)
FirstPublishTime Date and time of the first time this story was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this story was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
Example
<Stories>
    ...

    <Story id="17047">
    <ModerationStatus>APPROVED</ModerationStatus>
    <LastModificationTime>2013-10-17T09:12:56.000-05:00</LastModificationTime>
    <SubmissionTime>2011-08-25T13:19:19.000-05:00</SubmissionTime>
    <NumFeedbacks>0</NumFeedbacks>
    <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>0</NumNegativeFeedbacks>

    <StoryRatingFeedback>
    <Range>5</Range>
    <NumRatingFeedbacks>34</NumRatingFeedbacks>
    <ComputedScore>2.6364</ComputedScore>
    <AverageScore>2.6</AverageScore>
    </StoryRatingFeedback>

    <UserProfileReference id="z2qs1pvkj7x282z0rg0zvfx2fp">
    <ExternalId>z2qs1pvkj7x282z0rg0zvfx2fp</ExternalId>
    <DisplayName>IAmMusician</DisplayName>
    <Anonymous>false</Anonymous>
    <HyperlinkingEnabled>false</HyperlinkingEnabled>
    </UserProfileReference>

    <UserNickname>IAmMusician</UserNickname>
    <UserLocation>USA, TX, Austin</UserLocation>
    <Title>My guitar life.</Title>
    <StoryText>Super long story about how this person performed with this guitar for years!</StoryText>
    <NumComments>3</NumComments>
    <AuthenticationType>SITE</AuthenticationType>
    <UserEmailAddress>anyemail@anyprovider.com</UserEmailAddress>
    <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished>
    <SendEmailAlertWhenCommented>true</SendEmailAlertWhenCommented>
    <SendEmailAlertWhenCommentedOptOutURL>
    http://stories.<CLIENTNAME>.com/stories/<displayCode>/product/<productId>/story/<storyId>/startunsubscribecommentedstory.htm?signature=<enrypted_code>
    </SendEmailAlertWhenCommentedOptOutURL>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <CampaignId>BV_STORIES_DISPLAY</CampaignId>
    <ContentCodes>ABC</ContentCodes>
    <OriginatingDisplayCode>1234-code</OriginatingDisplayCode>
    <FirstPublishTime>2011-08-25T14:15:05.000-05:00</FirstPublishTime>
    <LastPublishTime>2011-08-25T16:15:04.000-05:00</LastPublishTime>

    <!-- Below elements are described in other sections of this doc. See references in a table below. -->

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

    <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>

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

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

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

    </Story>

    ...
</Stories>

Question type

Click here for an example.

Element Description Type
Question

Holds 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 Holds information about the current status of a given question. Basically, this field can say whether a question 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 question by its author or any of his or her 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 any 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 author's (reviewer's) email address. If the client prefers to get PII data in the feed, this field must be filled in. 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). Can be SITE, FACEBOOK or EMAIL. Enum
SendEmailAlertWhenPublished A boolean value that shows whether the user decided to receive email when his or her question gets published or not. boolean
SendEmailAlertWhenAnswered A boolean value that shows whether the user decided to receive email when his or her question gets commented on by others or not. boolean
SendEmailAlertWhenAnsweredOptOutURL

Holds the OptOut URL that can be sent out to a user with an email and allows him or her 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 Holds the address of a reviewer. Field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Holds 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 Conversations. 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 (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this question was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference / Reviewer / User

Holds information about a user profile (see the example snippet for all possible fields of this block). Depending on the scheme version, the block name might differ (Reviewer, User, or UserProfileReference). 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. 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). More details. Complex Object (sequence of ContextDataValue elements)
Photos A set of photo references with some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. More details. Complex Object (sequence of Video elements)
Tags Contains a list of tag dimensions. More details. Complex Object (sequence of TagDimension elements)
AdditionalFields Contains a list of additional (non-default) fields the question might have. More details. Complex Object (sequence of AdditionalField elements)
ProductReferences Holds a list of references to products linked to a question. More details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given question or its author. 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>

    <!-- Below elements are described in other sections of this doc. See references in a table below. -->

    <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

Click here for an example.

Element Description Type
Answer

Holds 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 Holds 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 any 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 The location of the author of an answer. String (varchar(255))
UserEmailAddress This is the author's (reviewer's) email address. If the client prefers to get PII data in the feed, this field must be filled in. 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 his or her 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 Holds the address of a reviewer. Field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Holds 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 that are provided with Conversations. 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 (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this answer was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference / Reviewer / User

Holds information about a certain user profile (see 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). 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). More details. Complex Object (sequence of ContextDataValue elements)
Photos A set of photo references with some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. More details. Complex Object (sequence of Video elements)
AdditionalFields Contains a list of additional (non-default) fields the answer might have. More details. Complex Object (sequence of AdditionalField elements)
ProductReferences Holds a list of references to products linked to an answer. More details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given answer or its author. 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>

    <!-- Below elements are described in other sections of this doc. See references in a table below. -->

    <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

Click here for an example.

Element Description Type
Comment

Holds information about a comment submitted for a review or story.

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 Holds 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 any 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 The location of the author of a comment. String (varchar(255))
UserEmailAddress This is the author's (reviewer's) email address. If the client prefers to get PII data in the feed, this field must be filled in. 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 his or her 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 Holds the address of a reviewer. Field is a PII, which can be turned on or off. String (varchar(255))
DisplayLocale Holds 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 that are provided with Conversations. 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 (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this comment was published (sometimes that happens more than once due to moderation process specifics). Date (Timestamp)
UserProfileReference / Reviewer / User

Holds information about a user profile (see example snippets for all possible fields of this block). Depending on the scheme version, the block name might differ (Reviewer or User or UserProfileReference). 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 some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. More details. Complex Object (sequence of Video elements)
ProductReferences Holds a list of references to products linked to a comment. More details. Complex Object (sequence of ProductReference elements)
Badges Contains a list of badges applied to a given comment or its author. 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>

    <!-- Below elements are described in other sections of this doc. See references in a table below. -->

    <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

Click here 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 (description of its fields is provided below in this table)

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 (description of its fields is provided below in this table)
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, STORY, 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 Holds 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. Those are usually submitted using the Workbench. Complex Object (sequence of ClientResponse elements)
ClientResponse Holds 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 a response is coming. 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 some captions left by the reviewer (author of any content). Complex Object (sequence of Photo elements)
Photo

Photo references with some 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

Holds 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

Holds 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 some captions. Complex Object (sequence of Video elements)
Video Holds 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 asYouTube). 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 Holds a list of references of products linked to a review. Complex Object (sequence of ProductReference elements)
ProductReference Holds a Product element with a few fields (see example above) 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). More details about Product element.

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 above in this doc)

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 see 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 see 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>
    <Sizes>
    <Size id="thumbnail" url="http://stories.GUITARSTORECLIENT.com/reviews/<displayCode>/104358/photoThumb.jpg"/>
    <Size id="normal" url="http://stories.GUITARSTORECLIENT.com/reviews/<displayCode>/104358/photo.jpg"/>
    </Sizes>
    </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

Click here 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 that would be displayed on his or her 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 seen. boolean
HyperlinkingEnabled Indicates if a reviewer's answers will automatically be parsed for hyperlinks. boolean
ContributorRank The contributor rank that was 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 Holds the locale from which a review was submitted. String (varchar(25))
ModerationStatus Holds 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 Holds 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. More details. Complex Object (sequence of Photo elements)
ReviewStatistics Holds stats information about all ratings and reviews of a user. More details. Complex Object (description of its fields is provided in this doc)
QAStatistics Holds stats information about all questions and answers of a user. More details. Complex Object (description of its fields is provided in this doc)
ReviewCommentStatistics Holds stats information about all review comments of a user. More details. Complex Object (description of its fields is provided in this doc)
StoryStatistics Holds stats information about all stories of a user. More details. Complex Object (description of its fields is provided in this doc)
StoryCommentStatistics Holds stats information about all story comments of a user. More details. Complex Object (description of its fields is provided in this doc)
Badges Contains a list of badges applied to a reviewer. More details. Complex Object (sequence of Badge elements)
AdditionalFields Contains a list of additional (non-default) fields a reviewer record might have. 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). 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). More details. Complex Object (sequence of RatingValue elements)
Photos A set of photo references with some captions. More details. Complex Object (sequence of Photo elements)
Videos A set of video references with some captions. 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>

  <!-- Below elements are described in other sections of this doc. See references in a table below. -->

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

  <ReviewStatistics>
  ...
  </ReviewStatistics>

  <QAStatistics>
  ...
  </QAStatistics>  

  <ReviewCommentStatistics>
  ...
  </ReviewCommentStatistics>

  <StoryStatistics>
  ...
  </StoryStatistics>

  <StoryCommentStatistics>
  ...
  </StoryCommentStatistics>

  <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.7" name="client_name" extractDate="2016-10-29T00:00:00.000Z">
   <Product disabled="false" removed="true" id="01">
      <Reviews>
   <Review id="59837722">
      <UserProfileReference id="6027">
         <Anonymous>false</Anonymous>
         <DisplayName>Bill Bailey</DisplayName>
         <ExternalId>6027</ExternalId>
         <HyperlinkingEnabled>false</HyperlinkingEnabled>
      </UserProfileReference>
      <ContentCodes>IMP STP</ContentCodes>
      <DisplayLocale>en_US</DisplayLocale>
      <Featured>false</Featured>
      <FirstPublishTime>2016-02-02T16:26:57.000-06:00</FirstPublishTime>
      <LastModificationTime>2016-10-26T11:10:43.375-05:00</LastModificationTime>
      <LastPublishTime>2016-02-02T16:26:57.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/16835/01/review/59837722/redirect.htm</ProductReviewsDeepLinkedUrl>
      <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/16835/01/reviews.htm?reviewID=59837722</ProductReviewsUrl>
      <Rating>5</Rating>
      <RatingRange>5</RatingRange>
      <RatingsOnly>false</RatingsOnly>
      <ReviewText>Love these speakers, and the outdoor , perfect with the 120 watt or 240 watt mixer amps, I was totally blown away with 70 volt sound quality.</ReviewText>
      <ReviewerNickname>Bill Bailey</ReviewerNickname>
      <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
      <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
      <Source>
         <Name>snapav</Name>
         <ExternalContentId>10001</ExternalContentId>
      </Source>
      <SubmissionTime>2016-02-02T16:26:57.000-06:00</SubmissionTime>
      <Title>AWESOME</Title>
      <Videos/>
   </Review>
   <Review id="59837721">
      <UserProfileReference id="202752">
         <Anonymous>false</Anonymous>
         <DisplayName>George Tsougarakis</DisplayName>
         <ExternalId>202752</ExternalId>
         <HyperlinkingEnabled>false</HyperlinkingEnabled>
      </UserProfileReference>
      <ContentCodes>IMP STP</ContentCodes>
      <DisplayLocale>en_US</DisplayLocale>
      <Featured>false</Featured>
      <FirstPublishTime>2016-02-02T16:26:57.000-06:00</FirstPublishTime>
      <LastModificationTime>2016-10-26T11:10:47.584-05:00</LastModificationTime>
      <LastPublishTime>2016-02-02T16:26:57.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/16835/01/review/59837721/redirect.htm</ProductReviewsDeepLinkedUrl>
      <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/16835/01/reviews.htm?reviewID=59837721</ProductReviewsUrl>
      <Rating>5</Rating>
      <RatingRange>5</RatingRange>
      <RatingsOnly>false</RatingsOnly>
      <ReviewText>I have looked all over the internet - YouTube, Google videos and manufacturer websites for speaker wiring details and instructions. NOTHING! SnapAV has supplied all our needs for not only hardware, but a clear instruction on how to do it and troubleshooting the system to determine the best material for the job. This video is the best tutorial to understand wiring audio in a corporate setting! Thanks guys! SkyTouch Solutions skytouch.org
      </ReviewText>
      <ReviewerNickname>George Tsougarakis</ReviewerNickname>
      <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
      <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
      <Source>
         <Name>snapav</Name>
         <ExternalContentId>10000</ExternalContentId>
      </Source>
      <SubmissionTime>2016-02-02T16:26:57.000-06:00</SubmissionTime>
      <Title>AWESOME, again I must say, AWESOME</Title>
      <Videos/>
   </Review>
      </Reviews>
      <ExternalId>01</ExternalId>
      <Source>snapav</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>
      <NumStories>0</NumStories>
      <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>1267712666</CategoryId>
   </CategoryItem>
      </CategoryItems>
      <UPCs>
   <UPC>635414671845</UPC>
      </UPCs>
      <EANs>
   <EAN>1234567891012</EAN>
      </EANs>   
   </Product>
   <Product disabled="false" removed="false" id="1529-A">
      <Reviews>
   <Review id="74851088">
      <UserProfileReference id="195050">
         <Anonymous>false</Anonymous>
         <DisplayName>Pete Sokol</DisplayName>
         <ExternalId>195050</ExternalId>
         <HyperlinkingEnabled>false</HyperlinkingEnabled>
      </UserProfileReference>
      <ContentCodes>IMP STP MMA HMP</ContentCodes>
      <DisplayLocale>en_US</DisplayLocale>
      <Featured>false</Featured>
      <FirstPublishTime>2016-10-26T17:15:04.000-05:00</FirstPublishTime>
      <LastModificationTime>2016-10-26T17:15:07.236-05:00</LastModificationTime>
      <LastPublishTime>2016-10-26T17:15: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/16835/1529-A/review/74851088/redirect.htm</ProductReviewsDeepLinkedUrl>
      <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/16835/1529-A/reviews.htm?reviewID=74851088</ProductReviewsUrl>
      <Rating>4</Rating>
      <RatingRange>5</RatingRange>
      <RatingsOnly>false</RatingsOnly>
      <ReviewText>Not sure if the bag was redesigned or if the other poster just stuffed it too full... I haven't had any complaints with the plastic multi compartment tray, it holds all the little parts that I need with room for even some rarely used parts. My helper asked me the other day where I got the bag and I believe he will be ordering one soon.</ReviewText>
      <ReviewerNickname>Pete Sokol</ReviewerNickname>
      <SendEmailAlertWhenCommented>false</SendEmailAlertWhenCommented>
      <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
      <Source>
         <Name>snapav</Name>
         <ExternalContentId>10200</ExternalContentId>
      </Source>
      <SubmissionTime>2016-10-25T18:00:16.000-05:00</SubmissionTime>
      <Title>Great bag</Title>
      <Videos/>
   </Review>
      </Reviews>
      <ImageUrl>http://www.snapav.com/wcsstore/ExtendedSitesCatalogAssetStore/attachmenimages/Tools/fullsize/1529-1B.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.snapav.com/shop/en/snapav/clc-toolworks-center-tray-tool-bag</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>
      <NumStories>0</NumStories>
      <ProductReviewsUrl>http://c1.ugc.bazaarvoice.com/16835/1529-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="BulkWire_Gear">
      <ExternalId>BulkWire_Gear</ExternalId>
      <CategoryName>Gear</CategoryName>
      <CategoryId>738161687</CategoryId>
   </CategoryItem>
   <CategoryItem id="SAV_Tools_Hardware">
      <ExternalId>SAV_Tools_Hardware</ExternalId>
      <CategoryName>Tools & Hardware</CategoryName>
      <CategoryId>785905309</CategoryId>
   </CategoryItem>
      </CategoryItems>
      <UPCs>
   <UPC>635414671845</UPC>
      </UPCs>
      <EANs>
   <EAN>1234567891012</EAN>
      </EANs>
      <ManufacturerPartNumbers>
   <ManufacturerPartNumber>1529-A</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. Instead, use inline ratings to produce small display elements, such as summary stars.

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. If you do not know your SFTP credentials or where your data is hosted, contact Bazaarvoice Client Care .

XML schema and example

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/_

where __ 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

Here is a simple example of a ratings-only export feed:

<?xml version="1.0" encoding="UTF-8"?>
<Feed xmlns="http://www.bazaarvoice.com/xs/PRR/SyndicationFeed/14.7" name="client_name" extractDate="2016-11-01T00:00:00.000Z">
   <Product removed="false" id="AN-100-AP">
      <ImageUrl>http://www.snapav.com/wcsstore/ExtendedSitesCatalogAssetStore/attachmenimages/Networking/fullsize/AN-100-AP-I-N-F1.jpg</ImageUrl>
      <Name>Araknis Networks® 100 Series Indoor Wireless Access Point</Name>
      <ExternalId>AN-100-AP</ExternalId>
      <Description>Araknis Networks® 100 Series Indoor Wireless Access Point</Description>
      <Brand>
         <ExternalId>BEBE</ExternalId>
         <Name>BEBE</Name>
         <Attributes>
            <Attribute id="NAME">
               <Value>BEBE</Value>
            </Attribute>
         </Attributes>
      </Brand>
      <Source>snapav</Source>
      <ProductPageUrl>http://www.snapav.com/shop/en/snapav/araknis-networks-100-series-indoor-wireless-access-point-an-100-ap</ProductPageUrl>
      <NativeReviewStatistics>
   <AverageOverallRating>5.0</AverageOverallRating>
   <OverallRatingRange>5</OverallRatingRange>
   <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
   <RecommendedCount>1</RecommendedCount>
   <TotalReviewCount>1</TotalReviewCount>
   <AverageRatingValues>
      <AverageRatingValue id="Quality">
         <AverageRating>5.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
      <ExternalId>Quality</ExternalId>
      <Label>Performance</Label>
      <Label1>Performance</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
      <AverageRatingValue id="Value">
         <AverageRating>2.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
      <ExternalId>Value</ExternalId>
      <Label>Value</Label>
      <Label1>Value</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
      <AverageRatingValue id="EaseOfInstallation">
         <AverageRating>2.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="EaseOfInstallation">
      <ExternalId>EaseOfInstallation</ExternalId>
      <Label>Ease of Installation or Use</Label>
      <Label1>Ease of Installation or Use</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
   </AverageRatingValues>
   <RatingDistribution>
      <RatingDistributionItem>
         <RatingValue>5</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/16835/AN-100-AP/reviews.htm</ProductReviewsUrl>
      <ReviewStatistics>
   <AverageOverallRating>5.0</AverageOverallRating>
   <OverallRatingRange>5</OverallRatingRange>
   <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
   <RecommendedCount>1</RecommendedCount>
   <TotalReviewCount>1</TotalReviewCount>
   <AverageRatingValues>
      <AverageRatingValue id="Quality">
         <AverageRating>5.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Quality">
      <ExternalId>Quality</ExternalId>
      <Label>Performance</Label>
      <Label1>Performance</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
      <AverageRatingValue id="Value">
         <AverageRating>2.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="Value">
      <ExternalId>Value</ExternalId>
      <Label>Value</Label>
      <Label1>Value</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
      <AverageRatingValue id="EaseOfInstallation">
         <AverageRating>2.0</AverageRating>
         <RatingDimension displayType="NORMAL" selectedValueInDisplayEnabled="false" id="EaseOfInstallation">
      <ExternalId>EaseOfInstallation</ExternalId>
      <Label>Ease of Installation or Use</Label>
      <Label1>Ease of Installation or Use</Label1>
      <RatingRange>5</RatingRange>
         </RatingDimension>
      </AverageRatingValue>
   </AverageRatingValues>
   <RatingDistribution>
      <RatingDistributionItem>
         <RatingValue>5</RatingValue>
         <Count>1</Count>
      </RatingDistributionItem>
   </RatingDistribution>
      </ReviewStatistics>
      <CategoryItems>
   <CategoryItem id="OvrC_Networking">
      <ExternalId>OvrC_Networking</ExternalId>
      <CategoryName>Networking</CategoryName>
      <CategoryId>1409876133</CategoryId>
   </CategoryItem>
   <CategoryItem id="SAV_OvrC">
      <ExternalId>SAV_OvrC</ExternalId>
      <CategoryName>OvrC</CategoryName>
      <CategoryId>1265121169</CategoryId>
   </CategoryItem>
      </CategoryItems>
      <ManufacturerPartNumbers>
   <ManufacturerPartNumber>AN-100-AP</ManufacturerPartNumber>
      </ManufacturerPartNumbers>
   </Product>
   <Product removed="false" id="WPS-PS9-24VAC">
      <ImageUrl>http://www.snapav.com/wcsstore/ExtendedSitesCatalogAssetStore/attachmenimages/Surveillance/fullsize/WPS-PS9-24VAC-12A-1B.jpg</ImageUrl>
      <Name>Wirepathâ„¢ Surveillance 24V AC Power Supply with PTC Fuses - 9 Output</Name>
      <ExternalId>WPS-PS9-24VAC</ExternalId>
      <Description>Wirepathâ„¢ Surveillance 24V AC Power Supply with PTC Fuses - 9 Output</Description>
      <Brand>
   <ExternalId>BEBE</ExternalId>
   <Name>BEBE</Name>
   <Attributes>
      <Attribute id="NAME">
         <Value>BEBE</Value>
      </Attribute>
   </Attributes>
      </Brand>
      <Source>snapav</Source>
      <ProductPageUrl>http://www.snapav.com/shop/en/snapav/wirepath-trade%3B-surveillance--24v-ac-power-supply-with-ptc-fuses---9-output</ProductPageUrl>
      <NativeReviewStatistics>
   <AverageOverallRating>3.0</AverageOverallRating>
   <OverallRatingRange>5</OverallRatingRange>
   <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
   <RecommendedCount>0</RecommendedCount>
   <TotalReviewCount>1</TotalReviewCount>
   <AverageRatingValues/>
   <RatingDistribution>
      <RatingDistributionItem>
         <RatingValue>3</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/16835/WPS-PS9-24VAC/reviews.htm</ProductReviewsUrl>
      <ReviewStatistics>
   <AverageOverallRating>3.0</AverageOverallRating>
   <OverallRatingRange>5</OverallRatingRange>
   <RatingsOnlyReviewCount>0</RatingsOnlyReviewCount>
   <RecommendedCount>0</RecommendedCount>
   <TotalReviewCount>1</TotalReviewCount>
   <AverageRatingValues/>
   <RatingDistribution>
      <RatingDistributionItem>
      <RatingValue>3</RatingValue>
      <Count>1</Count>
      </RatingDistributionItem>
   </RatingDistribution>
      </ReviewStatistics>
      <CategoryItems>
   <CategoryItem id="Surveillance_Power">
      <ExternalId>Surveillance_Power</ExternalId>
      <CategoryName>Power Supplies</CategoryName>
      <CategoryId>1838102495</CategoryId>
   </CategoryItem>
   <CategoryItem id="SAV_Surveillance">
      <ExternalId>SAV_Surveillance</ExternalId>
      <CategoryName>Surveillance</CategoryName>
      <CategoryId>1848637904</CategoryId>
   </CategoryItem>
      </CategoryItems>
      <ManufacturerPartNumbers>
   <ManufacturerPartNumber>WPS-PS9-24VAC</ManufacturerPartNumber>
      </ManufacturerPartNumbers>
   </Product>
</Feed>

Displayable Content Export (DCE)

For performance, flexibility, or security reasons, your company might need to limit dependencies on third-party services that power your websites. The Bazaarvoice Displayable Content Export provides a way to store consumer-generated content (CGC) locally and display the content without calling the Bazaarvoice Conversations display infrastructure.

The DCE is designed to be consumed in bulk periodically, and the CGC is intended for public display on websites and other applications. Do not use the 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 the DCE through the use of an HTTPS interface, enabling the request and transfer the content files.

Benefits of the DCE

The DCE offers the following benefits:

  • A service optimized for downloading displayable content in bulk
  • A single source of displayable native and syndicated CGC 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

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

  • Pending CGC
  • Rejected CGC
  • Approved CGC 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. The 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 the DCE and how to import and display the content:

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

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

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

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