Standard client feed content types and statistics

This article contains descriptions of the content types and statistics blocks found in the standard client feed.

ReviewStatistics, QAStatistics, and CommentStatistics blocks

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

The following table describes  ReviewStatistics, QAStatistics, and CommentStatistics blocks. Refer to the example to view an example of blocks in use.

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

Complex Object

(sequence of AverageRatingValue elements)

AverageRatingValue

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

Attributes:

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

Complex Object

RatingDimension

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

Attributes:

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

Complex Object

AverageRating Contains an average value users have chosen for this specific rating dimension (secondary rating). Float (4-bytes)
ExternalId Identifier of a given object (such as content, subject, dimension, or tag) that is unique among other objects of such type. String (varchar(255))
RatingRange Much like the OverallRatingRange element, this element shows the maximum value of a given secondary rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their secondary ratings functionality. This value is configured in a client's display or submission configuration. Int (int(11))
Label / Label1 Text description of a rating or tag dimension taken from a client or the default display configurations (if any description available). String (varchar(255))
RatingDistribution Contains ratings and review counts grouped by rating values.

Complex Object

(sequence of RatingDistributionItem elements)

RatingDistributionItem Reflects the amount of reviews with a certain rating. Complex Object
RatingValue One of the possible rating value options that is used to rate reviews. Int (4-byte integer)
TagDistribution A stats block that shows which and how many tags have been chosen by reviewers for their reviews. Complex Object
TagDimension

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

Attributes:

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

Complex Object

TagDistributionItems Contains a set of unique tags that were chosen for this tag dimension (like a list of pros grouped by unique values to calculate counts).

Complex Object

(sequence of TagDistributionItem elements)

TagDistributionItem Represents the unique tag described by a string label and the number of times it appeared on different reviews for this product (Count element).

Complex Object

(description of its fields is provided in this table)

LocaleDistribution Contains stats grouped by locale. This is a map of locales and review statistics.

Complex Object

(sequence of LocaleDistributionItem elements)

LocaleDistributionItem This is an entry of the locale distribution map that contains a key (DisplayLocale value) and a value (ReviewStatistics block).

Complex Object

DisplayLocale A locale from which a certain number of reviews were submitted for this product. String (varchar(25))
ReviewStatistics Review statistic block that contains numbers and stats of reviews for a certain display locale (the same structure as the one we're describing right now, except that it won't have any stats distributed by locales). There are recursive appearances of this XML element. Complex Object
Count Number of reviews with a certain quality, tag, or rating (depending on the location of a Count XML element). Int (4-byte Integer)
QAStatistics A block that contains stats information about all questions and answers of a user. Complex Object
ReviewCommentStatistics A block that contains stats information about all review comments of a user. Complex Object 
TotalQuestionsCount Number of approved questions submitted by a certain user. Int (4-byte Integer)
TotalAnswersCount Number of approved answers submitted by a certain user. Int (4-byte Integer)
QuestionHelpfulVoteCount Number of "Helpful" votes submitted for all user's approved questions. Int (4-byte Integer)
QuestionNotHelpfulVoteCount Number of "Not Helpful" votes submitted for all user's approved questions. Int (4-byte Integer)
AnswerHelpfulVoteCount Number of "Helpful" votes submitted for all user's approved answers. Int (4-byte Integer)
AnswerNotHelpfulVoteCount Number of "Not Helpful" votes submitted for all user's approved answers. Int (4-byte Integer)
HelpfulVoteCount Total number of "Helpful" votes submitted for all user's approved content of a certain type. Int (4-byte Integer)
NotHelpfulVoteCount Total number of "Not Helpful" votes submitted for all user's approved content of a certain type. Int (4-byte Integer)
FeaturedQuestionsCount Number of user's questions that were marked as "Featured" on the client's display. Int (4-byte Integer)
FeaturedAnswersCount Number of user's answers that were marked as "Featured" on the client's display. Int (4-byte Integer)
FeaturedCommentCount Number of user's comments that were marked as "Featured" on the client's display. Int (4-byte Integer)
BestAnswersCount Number of user's answers that were marked as "Best" for a given question. Int (4-byte Integer)
FirstQuestionTime Date and time of the first question submitted by a given user. Date (Timestamp)
LastQuestionTime Date and time of the last question submitted by a given user. Date (Timestamp)
FirstAnswerTime Date and time of the first answer submitted by a given user. Date (Timestamp)
LastAnswerTime Date and time of the last answer submitted by a given user. Date (Timestamp)
LastQuestionAnswerDate Date and time of the last question or answer submitted by a given user. Date (Timestamp)
FirstSubmissionTime Date and time of the first submission of a certain content type performed by a given user. Date (Timestamp)
LastSubmissionTime Date and time of the last submission of a certain content type performed by a given user. Date (Timestamp)
NumComments Total number of approved comments that were submitted by a given reviewer. Int (4-byte integer)

Example

Copy Code
XML
<Product id="Product1234">
  ...

  <ReviewStatistics>

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

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

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

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

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

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

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

  ...
  </LocaleDistribution>

  </ReviewStatistics>

  ...
  </Product>

  <UserProfile id="something">
  ...

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

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

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

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

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

  ...
  </UserProfile>

Content types

Bazaarvoice provides the following content types:

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

Review type

The following table describes the review type. Refer to the example to view an example of the review type in use.

Note: To learn more about element descriptions, schemas, and structures listed in the table, refer to Complex contextual objects for details on objects including Tags, Badges, Photos, and Videos.


Element Description Type
Review

Contains information about reviews submitted for a given product.

Attributes:

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

Complex Object

ModerationStatus

Indicates the current moderation status of the content.


Note: If you use legacy custom feeds, the configuration can change the moderation status added to the standard client feeds.


The possible standard client feed statuses are:

  • APPROVED— Content is visible on your site.
  • AUTOMATEDHOLD— Automatically flagged and temporarily held by automated system moderation filters.
  • HOLD— Temporarily held in the moderation queue for manual inspection.
  • PENDING— Waiting for client feedback.
  • REJECTED— Content failed BV moderation (automated or human).
  • REMOVEDBYCLIENT— Manually removed content.
Note: Ratings-only feeds show only content with an APPROVED  moderation status.
Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this review by its author or any of its comments. The latest timestamp will be listed. Date (Timestamp)
Featured A Boolean marker. Value is "true" if this content is especially interesting and well written. Assigned during moderation. Boolean
UserProfileReference / Reviewer / User

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

Attributes:

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

Complex Object

RatingsOnly A Boolean marker. Value is "true" if review was successfully submitted but has no texts or was marked as RatingsOnly by CMS (if a number of characters was too small to pass the threshold, which is configurable on a per-client level) Boolean
Title Contains a review title in a form specified by its author. String (varchar(255))
ReviewText Contains the full text of a review in a form specified by its author. String (text)
DisplayLocale Contains the locale from which the review was submitted. String (varchar(25))
ReviewerNickname A nickname chosen by a review author. String (varchar(255))
ReviewerLocation A location of a review author. String (varchar(255))
Tags Contains a list of tag dimensions.

Complex Object

(sequence of TagDimension elements)

AdditionalFields Contains a list of additional (non-default) fields the review might have.

Complex Object

(sequence of AdditionalField elements)

Comments Contains a list of comments that were submitted for a given review.

Complex Object

(sequence of Comment elements)

Rating A rating value chosen by the author of a review (usually this is a reflection of the number of "stars"). Int (int(11))
RatingRange The maximum value of a rating. Ratings will vary between 1 and this value. The default value is 5, but some clients prefer to have more (or fewer) "maximum stars" for their Ratings & Reviews functionality. This value is set during client provisioning. Int (int(11))
Recommended Marks whether review has a "Recommended" flag on it. This means that during review submission, a user (reviewer) confirmed that they will recommend this product to a friend. Boolean
NumFeedbacks Number of feedback entries on a given review (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given review. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given review. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported that this review has inappropriate or irrelevant content. Int (4-byte integer)
NetPromoterScore The value is a positive integer between 1 and 10 representing a numerical rating in response to a question, such as, “How would you rate this company?” or “How would you rate this product?” Int (int(11))
NetPromoterComment A comment that goes along with a NetPromoterScore and explains the score. String (text)
UserEmailAddress If client prefers to get PII data in the feed, this field must be included. This is the user's (reviewer's) email address. String (varchar(255))
SendEmailAlertWhenPublished A Boolean value that shows whether the user decided to receive email when their review gets published or not. Boolean
SendEmailAlertWhenCommented A Boolean value that shows whether the user decided to receive email when their review gets commented on by others or not. Boolean
SendEmailAlertWhenCommentedOptOutURL

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

Note: If the URL contains a reserved (special) character, you must URL-encode Opens in new tab 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 Opens in new tab 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 Opens in new tab 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).

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

Complex Object

(sequence of RatingValue elements)

Photos A set of photo references with captions.

Complex Object

(sequence of Photo elements)

Videos A set of video references with captions.

Complex Object

(sequence of Video elements)

ClientComments Contains a list of comments that were submitted for a given review by the client's personnel.

Complex Object

(sequence of ClientComment elements)

NumComments Number of comments that were approved for a given review. Int (4-byte integer)
SubmissionTime Time a given review was submitted by its author (before moderation process). Date (Timestamp)
CampaignId String value that specifies the source of a review, such as the platform or origins. Refer to this list of campaign IDs for more details. String (varchar(255))
AuthenticationType Type of authentication of a given user (review author). Can be SITE, FACEBOOK, or EMAIL. Enum
ProductReferences Contains a list of references of products linked to a review.

Complex Object

(sequence of ProductReference elements)

Badges Contains a list of badges applied to a given review or its author.

Complex Object

(sequence of Badge elements)

IpAddress Contains IP address of reviewer. This field is a PII which can be turned on or off. String (varchar(255))
OriginatingDisplayCode Identifies the client's display configurations that were used for submission of a given review. String (varchar(25))
ContentCodes Contains a string with content codes that are separated with spaces. Each content code is assigned during moderation and carries some information about content, such as whether there is reference to some other store or a reason why the review was approved or rejected. String (text)
ClientResponses Contains a list of client responses to this review. These are usually submitted using Workbench.

Complex Object

(sequence of ClientResponse elements)

FirstPublishTime Date and time of the first time this review was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)
LastPublishTime Date and time of the last time this review was published (this sometimes happens more than once due to moderation process specifics). Date (Timestamp)

Example

Copy Code
XML
<Reviews>
    ...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    </Review>

    ...
</Reviews>


Campaign IDs

Campaign ID

Campaign Source

Description of submission source

BV_RATING_SUMMARY

Rating Summary

Rating summary block

BV_REVIEW_DISPLAY

Review Display

Review display

BV_MOBILE_RATING_SUMMARY

Mobile Rating Summary

Rating summary block in mobile format

BV_MOBILE_REVIEW_DISPLAY

Mobile Review Display

Review display in mobile format

BV_QA_PORTAL_ANSWER_MANAGEMENT

AMT

Answer portal

BV_QA_BRAND_ANSWERS

Brand Answers

Brand answers

BV_APO

Ask a Product Owner

Ask Product Owners feature

BV_PIE

Bazaarvoice Review Requests (formerly post-interaction email or PIE)

Review requests that link to a single product submission form

BV_PI_TEXT

Bazaarvoice Review Requests by Text Message

Review requests that link to a multi-product submission form

BV_PI_TEXT_FOLLOWUP

Bazaarvoice Review Request Reminders by Text Message

Review requests that link to a multi-product submission form

BV_PIE_MPR

Bazaarvoice Review Requests

Review requests that link to a multi-product submission form

BV_PIE_FOLLOWUP

Bazaarvoice Review Request Reminders

Review request reminders that link to a single product submission form

BV_PIE_FOLLOWUP_MPR

Bazaarvoice Review Request Reminders

Review request reminders that link to a multi-product submission form

BV_SOCIAL_ALERT

Bazaarvoice Social Alert Email

Rejected review email messages having 'Submit something new' button

BV_EDIT_REJECTED_REVIEW

Bazaarvoice Review Resubmission Email

Edit rejected review (review resubmission) email message

Question type

The following table describes the question type. Refer to the example to view an example of the question type in use.

Note:   To learn more about element descriptions, schemas, and structures listed in the table, refer to Complex contextual objects for details on objects including Tags, Badges, Photos, and Videos. 


Element Description Type
Question

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

Attributes:

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

Complex Object

ModerationStatus

Indicates the current moderation status of the content.


Note: If you use legacy custom feeds, the configuration can change the moderation status added to the standard client feeds.


The possible standard client feed statuses are:

  • APPROVED— Content is visible on your site.
  • AUTOMATEDHOLD— Automatically flagged and temporarily held by automated system moderation filters.
  • HOLD— Temporarily held in the moderation queue for manual inspection.
  • PENDING— Waiting for client feedback.
  • REJECTED— Content failed BV moderation (automated or human).
  • REMOVEDBYCLIENT— Manually removed content.
Note: Ratings-only feeds show only content with an APPROVED  moderation status.
 Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this question by its author or any of their answers. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given question was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given question (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given question. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given question. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported this question for inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of a question. String (varchar(255))
UserLocation The location of the author of a question. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
QuestionSummary The summary line of a given question. String (varchar(255))
QuestionDetails The body of a question. String (text)
NumAnswers Number of answers that were submitted and approved for this question. Int (4-byte integer)
AuthenticationType Specifies the type of authentication used by a given user (question author). This can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished A Boolean value that shows whether the user decides to receive an email when their question gets published or not. Boolean
SendEmailAlertWhenAnswered A Boolean value that shows whether the user decides to receive an email when their question is answered by others or not. Boolean
SendEmailAlertWhenAnsweredOptOutURL

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

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

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

Attributes:

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

Complex Object

Answers Contains answers to a question. Refer to the Answer type section for more details.

Complex Object

(sequence of Answer elements)

ContextDataValues Contains multiple context data values chosen by a reviewer (such as information about age, habits, or experience).

Complex Object

(sequence of ContextDataValue elements)

Photos A set of photo references with captions. Complex Object (sequence of Photo elements)
Videos A set of video references with captions. 

Complex Object

(sequence of Video elements)

Tags Contains a list of tag dimensions.

Complex Object

(sequence of TagDimension elements)

AdditionalFields Contains a list of additional (non-default) fields the question might have.

Complex Object

(sequence of AdditionalField elements)

ProductReferences Contains a list of references to products linked to a question.

Complex Object

(sequence of ProductReference elements)

Badges Contains a list of badges applied to a given question or its author.

Complex Object

(sequence of Badge elements)

Example

Copy Code
XML
<Question id="313672">
    <ModerationStatus>APPROVED</ModerationStatus>
    <LastModificationTime>2015-10-11T02:18:18.000-05:00</LastModificationTime>
    <SubmissionTime>2011-09-30T11:35:41.000-05:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>2</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>1</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>CertainSomeone</UserNickname>
    <UserLocation>Southern California</UserLocation>
    <UserEmailAddress>email@emailprovider.com</UserEmailAddress>
    <QuestionSummary>Would someone compare this model to previous years ones? I'm trying to figure out which one makes the most sense for business</QuestionSummary>
    <QuestionDetails>from a comfort or classy look point of view.</QuestionDetails>
    <NumAnswers>3</NumAnswers>
    <AuthenticationType>SITE</AuthenticationType>
    <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished>
    <SendEmailAlertWhenAnswered>true</SendEmailAlertWhenAnswered>
    <SendEmailAlertWhenAnsweredOptOutURL>
    http://answers.<clientName>.com/answers/<displayCode>/product/<productId>/question/<questionId>/startunsubscribeansweredquestion.htm?signature=<encryptedId>
    </SendEmailAlertWhenAnsweredOptOutURL>
    <SubjectQuestionsUrl>http://answers.<clientName>.com/answers/<displayCode>/product/>productId>/questions.htm</SubjectQuestionsUrl>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <CampaignId>BV_QA_BROWSE</CampaignId>
    <ContentCodes>ABC DEF GHI</ContentCodes>
    <OriginatingDisplayCode>1234-displayCode</OriginatingDisplayCode>
    <FirstPublishTime>2011-09-30T15:45:09.000-05:00</FirstPublishTime>
    <LastPublishTime>2011-09-30T15:45:09.000-05:00</LastPublishTime>

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

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

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

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

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

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

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

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

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

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

</Question>

Answer type

The following table describes the answer type . Refer to the example to view an example of the answer type in use.

Note: To learn more about element descriptions, schemas, and structures listed in the table, refer to Complex contextual objects for details on objects including Tags, Badges, Photos, and Videos.  


Element Description Type
Answer

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

Attributes:

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

Complex Object

ModerationStatus

Indicates the current moderation status of the content.


Note: If you use legacy custom feeds, the configuration can change the moderation status added to the standard client feeds.


The possible standard client feed statuses are:

  • APPROVED— Content is visible on your site.
  • AUTOMATEDHOLD— Automatically flagged and temporarily held by automated system moderation filters.
  • HOLD— Temporarily held in the moderation queue for manual inspection.
  • PENDING— Waiting for client feedback.
  • REJECTED— Content failed BV moderation (automated or human).
  • REMOVEDBYCLIENT— Manually removed content.
Note: Ratings-only feeds show only content with an APPROVED  moderation status.
 Enum
LastModificationTime This element contains the timestamp of the last modification that was performed on this answer by its author. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given answer was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given answer (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given answer. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given answer. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported that this answer has inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of an answer. String (varchar(255))
UserLocation A location of the author of an answer. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
AnswerText An answer text to a certain question. String (text)
AuthenticationType Specifies the type of authentication of a given user (answer author). Can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished Shows whether the user decided to receive an email when their answer gets published or not. Boolean
SubjectAnswersDeepLinkedUrl

URL that leads directly to given answers.

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

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

Attributes:

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

Complex Object

ContextDataValues Contains multiple context data values chosen by a reviewer (like information about age, habits, or experience).

Complex Object

(sequence of ContextDataValue elements)

Photos A set of photo references with captions. 

Complex Object

(sequence of Photo elements)

Videos A set of video references with captions. 

Complex Object

(sequence of Video elements)

AdditionalFields Contains a list of additional (non-default) fields the answer might have.

Complex Object

(sequence of AdditionalField elements)

ProductReferences Contains a list of references to products linked to an answer.

Complex Object

(sequence of ProductReference elements)

Badges Contains a list of badges applied to a given answer or its author.

Complex Object

(sequence of Badge elements)

Example

Copy Code
XML
<Answer id="466688">
    <ModerationStatus>APPROVED</ModerationStatus>
    <LastModificationTime>2015-10-11T02:18:18.000-05:00</LastModificationTime>
    <SubmissionTime>2011-09-30T11:35:41.000-05:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>2</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>1</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>CertainSomeone</UserNickname>
    <UserLocation>Southern California</UserLocation>
    <UserEmailAddress>email@emailprovider.com</UserEmailAddress>
    <AnswerText>
    A huge answer for a given question goes here. Yadda yadda yadda.
    </AnswerText>
    <AuthenticationType>SITE</AuthenticationType>
    <SendEmailAlertWhenPublished>true</SendEmailAlertWhenPublished>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <CampaignId>BV_QA_BROWSE</CampaignId>
    <ContentCodes>ABC DEF GHI</ContentCodes>
    <OriginatingDisplayCode>1234-displayCode</OriginatingDisplayCode>
    <FirstPublishTime>2011-09-30T15:45:09.000-05:00</FirstPublishTime>
    <LastPublishTime>2011-09-30T15:45:09.000-05:00</LastPublishTime>

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

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

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

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

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

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

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

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

</Answer>

Comment type

The following table describes the comment type . Refer to the example to view an example of the comment type in use.

Note: To learn more about element descriptions, schemas, and structures listed in the table, refer to Complex contextual objects for details on objects including Tags, Badges, Photos, and Videos.


Element Description Type
Comment

Contains information about a comment submitted for a review.

Attributes:

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

Complex Object 
ModerationStatus

Indicates the current moderation status of the content.


Note: If you use legacy custom feeds, the configuration can change the moderation status added to the standard client feeds.


The possible standard client feed statuses are:

  • APPROVED— Content is visible on your site.
  • AUTOMATEDHOLD— Automatically flagged and temporarily held by automated system moderation filters.
  • HOLD— Temporarily held in the moderation queue for manual inspection.
  • PENDING— Waiting for client feedback.
  • REJECTED— Content failed BV moderation (automated or human).
  • REMOVEDBYCLIENT— Manually removed content.
Note: Ratings-only feeds show only content with an APPROVED  moderation status.
 Enum
LastModificationTime Contains the timestamp of the last modification that was performed on this comment by its author. The latest timestamp will be listed. Date (Timestamp)
SubmissionTime Time a given comment was submitted by its author (before moderation process). Date (Timestamp)
NumFeedbacks Number of feedback entries on a given comment (positive + negative). Int (4-byte integer)
NumPositiveFeedbacks Number of positive feedback entries on a given comment. Int (4-byte integer)
NumNegativeFeedbacks Number of negative feedback entries on a given comment. Int (4-byte integer)
NumInappropriateFeedbacks Number of times customers reported a comment for inappropriate or irrelevant content. Int (4-byte integer)
UserNickname A nickname chosen by the author of a comment. String (varchar(255))
UserLocation A location of the author of a comment. String (varchar(255))
UserEmailAddress This is the user's (reviewer's) email address. If the client prefers to include PII data in the feed, this field must be completed. String (varchar(255))
Title The title of a comment. String (varchar(255))
CommentText The text in a comment body. String (text)
AuthenticationType Specifies type of authentication of a given user (comment author). Can be SITE, FACEBOOK, or EMAIL. Enum
SendEmailAlertWhenPublished Shows whether the user decided to receive email when their comment is published or not. Boolean
SubjectCommentsDeepLinkedUrl

URL that leads directly to a given comment.

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

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

Attributes:

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

Complex Object

Photos A set of photo references with captions.

Complex Object

(sequence of Photo elements)

Videos A set of video references with captions.

Complex Object

(sequence of Video elements)

ProductReferences Contains a list of references to products linked to a comment.

Complex Object

(sequence of ProductReference elements)

Badges Contains a list of badges applied to a given comment or its author.

Complex Object

(sequence of Badge elements)

Example

Copy Code
XML
<Comment id="57">
    <ModerationStatus>REMOVEDBYCLIENT</ModerationStatus>
    <LastModificationTime>2010-03-11T10:15:04.000-06:00</LastModificationTime>
    <SubmissionTime>2009-11-06T09:09:07.000-06:00</SubmissionTime>
    <NumFeedbacks>3</NumFeedbacks>
    <NumPositiveFeedbacks>0</NumPositiveFeedbacks>
    <NumNegativeFeedbacks>3</NumNegativeFeedbacks>
    <NumInappropriateFeedbacks>0</NumInappropriateFeedbacks>
    <UserNickname>wife4life</UserNickname>
    <UserLocation>North Carolina</UserLocation>
    <UserEmailAddress>some@email.com</UserEmailAddress>
    <Title>Nice stuff</Title>
    <CommentText>Why do men do this? My husband is the same way. Yadda yadda yadda.</CommentText>
    <SendEmailAlertWhenPublished>false</SendEmailAlertWhenPublished>
    <IpAddress>172.0.0.1</IpAddress>
    <DisplayLocale>en_US</DisplayLocale>
    <OriginatingDisplayCode>1234-code</OriginatingDisplayCode>
    <FirstPublishTime>2010-03-11T10:15:04.000-06:00</FirstPublishTime>
    <LastPublishTime>2010-03-11T10:15:04.000-06:00</LastPublishTime>

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

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

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

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

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

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

</Comment>

Provide feedback button