Retrieve data in JSON-LD + HTML

This guide explains how to retrieve User-Generated Content (UGC), such as ratings and reviews, formatted as both embedded JSON-LD and CSS-hidden HTML. This combined format is highly optimized for Search Engine Optimization (SEO), ensuring search engine crawlers can easily parse structured data while also indexing the raw HTML content. This is a highly recommended approach.

Retrieve ratings, reviews, AI generated review summaries and galleries in JSON-LD + HTML

To retrieve ratings, reviews, AI-generated review summary schema markups, include q={"reviews":{}, "ratings":{}, "reviewSummary": {}, "galleries" : [{"dataSourceId":"DATA-SOURCE-ID"}]} in the request as shown below.

If you do not include any schema markups in the request, the default API response includes ratings, reviews, and aggregated ratings.

Sample Request

curl -g \
  --location \
  --header 'Accept: text/javascript, text/html' \
  --header 'User-Agent: Java-http-client/17.0.7' \
  --header 'Bv-Forwarded-User-Agent: Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko); compatible; GPTBot/1.1; +https://openai.com/gptbot' \
  --header 'bv-passkey: <PASSKEY>' \
  'https://seo-stg.bazaarvoice.com/structured-data/v1/clients/testcustomer-fast-prs/ugc?locale=en_US&productId=product1&q={"reviews":{},"ratings":{},"reviewSummary":{},"questions":{},"galleries":[{"dataSourceId":"DKQGLerBTQCDXwNS"}]}}'

Sample Response

<script type="application/ld+json" id="bv-geo-jsonld-reviews-data">{"@context":"https://schema.org/","review":[{"@type":"Review","dateCreated":"2026-11-03T10:41:30.000+00:00","datePublished":"2026-11-03T10:45:01.000+00:00","reviewBody":"This is my positive review about this poor product","name":"Review title","reviewRating":{"@type":"Rating","ratingValue":5,"bestRating":5,"worstRating":1},"author":{"@type":"Person","name":"Billy Jean2"},"additionalProperty":[{"@type":"PropertyValue","name":"Best Uses - Telecom","value":"Home Use"}],"video":[{"@type":"VideoObject","thumbnailUrl":"https://img.youtube.com/vi/9uOcuOdGRyo/0.jpg","contentUrl":"https://www.youtube.com/watch?v=9uOcuOdGRyo","uploadDate":"2026-11-03T10:41:30.000+00:00","thumbnail":{"@type":"ImageObject","name":"www.youtube.com"},"name":"Review title","description":"This is my positive review about this poor product","caption":"This is video caption"}],"comment":[{"@type":"Comment","text":"This is my comment to this review.","author":{"@type":"Person","name":"Billy Jean2"},"datePublished":"2026-11-05T10:46:45.000+00:00","upvoteCount":0,"downvoteCount":0}],"commentCount":1}],"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-reviews-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-ratings-data">{"@context":"https://schema.org","aggregateRating":{"@type":"AggregateRating","bestRating":5,"ratingValue":3.3,"reviewCount":2841},"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-ratings-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-reviewSummary-data">{"@context":"https://schema.org/","review":{"@type":"Review","datePublished":"2026-08-05T12:43:10.666000+00:00","reviewBody":"The product is highly regarded by customers, with many praising its excellent features, quality, and value. Positive reviews highlight the impressive battery life and camera performance. However, some mixed opinions mention the camera quality in low light conditions. The summary should be curated to remove irrelevant or low-quality submissions.","author":{"@type":"Organization","name":"AI Review Summary","description":"AI-generated from customer ratings & reviews, and may include incentivized reviews."}},"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-reviewSummary-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-questions-data">{"@type":"FAQPage","mainEntity":[{"@type":"Question","name":"Lorem ipsum dolor sit amet?","dateCreated":"2017-06-22T19:30:21.000+00:00","author":{"@type":"Person","name":"Lorem0"},"acceptedAnswer":{"@type":"Answer","text":"Testing answer 2","dateCreated":"2022-09-08T04:44:57.000+00:00","author":{"@type":"Person","name":"AP09"},"upvoteCount":1},"answerCount":3}],"@context":"https://schema.org/","additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-questions-data"}]}</script>
<style>.bv-structured-data-html{display:none}</style>
<div id="bv-geo-html-reviews-data" class="bv-structured-data-html">
    <article data-field="review">
        <h3 data-field="name">Review title</h3>
        <p data-field="reviewBody">This is my positive review about this poor product</p>
        <span data-field="author.name">Billy Jean2</span>
        <time data-field="dateCreated" datetime="2026-11-03T10:41:30.000+00:00">2026-11-03T10:41:30.000+00:00</time>
        <time data-field="datePublished" datetime="2026-11-03T10:45:01.000+00:00">2026-11-03T10:45:01.000+00:00</time>
        <span data-field="reviewRating.ratingValue">5</span>
        <span data-field="reviewRating.bestRating">5</span>
        <span data-field="reviewRating.worstRating">1</span>
        <span data-field="commentCount">1</span>
        <ul data-field="additionalProperty">
            <li>
                <span data-field="name">Best Uses - Telecom</span>
                <span data-field="value">Home Use</span>
            </li>
        </ul>
        <ul data-field="video">
            <li>
                <span data-field="name">Review title</span>
                <span data-field="description">This is my positive review about this poor product</span>
                <span data-field="caption">This is video caption</span>
                <span data-field="contentUrl">https://www.youtube.com/watch?v=9uOcuOdGRyo</span>
                <span data-field="thumbnailUrl">https://img.youtube.com/vi/9uOcuOdGRyo/0.jpg</span>
                <span data-field="thumbnail.name">www.youtube.com</span>
                <time data-field="uploadDate" datetime="2026-11-03T10:41:30.000+00:00">2026-11-03T10:41:30.000+00:00</time>
            </li>
        </ul>
        <ul data-field="comment">
            <li>
                <p data-field="text">This is my comment to this review.</p>
                <span data-field="author.name">Billy Jean2</span>
                <time data-field="datePublished" datetime="2026-11-05T10:46:45.000+00:00">2026-11-05T10:46:45.000+00:00</time>
                <span data-field="upvoteCount">0</span>
                <span data-field="downvoteCount">0</span>
            </li>
        </ul>
    </article>
</div>
<div id="bv-geo-html-ratings-data" class="bv-structured-data-html">
    <article data-field="aggregateRating">
        <data data-field="ratingValue" value="3.3">3.3</data>
        <data data-field="bestRating" value="5">5</data>
        <data data-field="reviewCount" value="2841">2841</data>
    </article>
</div>
<div id="bv-geo-html-reviewSummary-data" class="bv-structured-data-html">
    <article data-field="review">
        <p data-field="reviewBody">The product is highly regarded by customers, with many praising its excellent features, quality, and value. Positive reviews highlight the impressive battery life and camera performance. However, some mixed opinions mention the camera quality in low light conditions. The summary should be curated to remove irrelevant or low-quality submissions.</p>
        <span data-field="author.name">AI Review Summary</span>
        <p data-field="author.description">AI-generated from customer ratings &amp; reviews, and may include incentivized reviews.</p>
        <time data-field="datePublished" datetime="2026-08-05T12:43:10.666000+00:00">2026-08-05T12:43:10.666000+00:00</time>
    </article>
</div>
<div id="bv-geo-html-questions-data" class="bv-structured-data-html">
    <article data-field="mainEntity">
        <h3 data-field="name">Lorem ipsum dolor sit amet?</h3>
        <span data-field="author.name">Lorem0</span>
        <time data-field="dateCreated" datetime="2017-06-22T19:30:21.000+00:00">2017-06-22T19:30:21.000+00:00</time>
        <span data-field="answerCount">3</span>
        <article data-field="acceptedAnswer">
            <p data-field="text">Testing answer 2</p>
            <span data-field="author.name">AP09</span>
            <time data-field="dateCreated" datetime="2022-09-08T04:44:57.000+00:00">2022-09-08T04:44:57.000+00:00</time>
            <span data-field="upvoteCount">1</span>
        </article>
    </article>
</div>
<script type="application/ld+json" id="bv-geo-jsonld-gallery-1-data">
{
  "@context" : "https://schema.org",
  "@type" : "ItemList",
  "name" : "Visual Gallery",
  "numberOfItems" : 97,
  "itemListElement" : [ {
    "@type" : "ListItem",
    "position" : 1,
    "item" : {
      "@type" : "ImageObject",
      "name" : "Featuring Sandals",
      "description" : "Featuring Sandals",
      "uploadDate" : "2023-12-13T15:10:07Z",
      "contentUrl" : "https://edge.curalate.com/v1/img/6Fn2THYhLjt_nVj5Qq8RyZ8jucv2gSPQSfCdDEVUXgs=",
      "thumbnailUrl" : "https://edge.curalate.com/v1/img/6Fn2THYhLjt_nVj5Qq8RyZ8jucv2gSPQSfCdDEVUXgs=",
      "creator" : {
        "@type" : "Organization",
        "name" : "HabilimentClothing"
      },
      "creditText" : "HabilimentClothing",
      "copyrightNotice" : "© HabilimentClothing. All Rights Reserved.",
      "about" : [ {
        "@type" : "Thing",
        "name" : "Calgary Felt Hat",
        "url" : "http://habilimentclothing.myshopify.com/products/the-hat-trick-felt-hat"
      }, {
        "@type" : "Thing",
        "name" : "Rainier Messanger Bag",
        "url" : "http://habilimentclothing.myshopify.com/products/messenger-bag"
      } ]
    }
  }, {
    "@type" : "ListItem",
    "position" : 2,
    "item" : {
      "@type" : "ImageObject",
      "name" : "Our customer, @jessielynnshops, takes her leather jacket to Berlin for a little light (okay, not ...",
      "description" : "Our customer, @jessielynnshops, takes her leather jacket to Berlin for a little light (okay, not so light) shopping! #habiliment #hablife #habilimentlife",
      "uploadDate" : "2017-02-16T04:40:10Z",
      "contentUrl" : "https://edge.curalate.com/v1/img/787gVs2QflolT-q25sGdPYNbF3wKQDP4sGqk2esAjWA=",
      "thumbnailUrl" : "https://edge.curalate.com/v1/img/787gVs2QflolT-q25sGdPYNbF3wKQDP4sGqk2esAjWA=",
      "creator" : {
        "@type" : "Person",
        "name" : "Habiliment Clothing",
        "alternateName" : "@habiliment.co",
        "url" : "https://instagram.com/habiliment.co"
      },
      "creditText" : "@habiliment.co via Instagram",
      "copyrightNotice" : "© Habiliment Clothing. Used with permission.",
      "isBasedOn" : "https://www.instagram.com/p/BQjzSq3gLUM/",
      "interactionStatistic" : [ {
        "@type" : "InteractionCounter",
        "interactionType" : "CommentAction",
        "userInteractionCount" : 2
      } ],
      "about" : [ {
        "@type" : "Thing",
        "name" : "Calgary Felt Hat",
        "url" : "http://habilimentclothing.myshopify.com/products/the-hat-trick-felt-hat"
      }, {
        "@type" : "Thing",
        "name" : "Women's Moto Leather Jacket",
        "url" : "http://habilimentclothing.myshopify.com/products/leather-jacket"
      } ]
    }
  } ]
}
</script>

Add the response to your page

Insert the response into the <body> of your product page, not the <head>, exactly as it was received. Do not modify, reformat, or split it.

The response includes the CSS that hides the HTML blocks. The blocks stay hidden whether JavaScript is enabled or disabled, as long as that CSS is applied and nothing overrides it.

Note: Your Content Security Policy (CSP) must allow inline styles (style-src). If it does not, the CSS may be blocked and the HTML blocks may become visible.

If the HTML blocks are missing

If the response contains the JSON-LD <script> elements but no HTML blocks, the API could not generate the HTML. The request still succeeds, and the response contains complete JSON-LD with no partial HTML.

To confirm, check the BV-API-Warning response header. It has the value semantic-html-generation-failed.

Retrieve ratings, reviews, and questions and answers

To retrieve ratings, reviews, and questions and answers schema markups, include q={"reviews":{}, "ratings":{}, "questions": {}} in the request body as shown below

Sample Request

curl -g \
  --location \
  --header 'Accept: text/javascript' \
  --header 'User-Agent: Java-http-client/17.0.7' \
  --header 'Bv-Forwarded-User-Agent: Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko); compatible; GPTBot/1.1; +https://openai.com/gptbot' \
  --header 'bv-passkey: <PASSKEY>' \
  'https://seo-stg.bazaarvoice.com/structured-data/v1/clients/testcustomer-fast-prs/ugc?locale=en_US&productId=product1&q={"reviews":{},"ratings":{},"questions":{}}'

Sample Request

<script type="application/ld+json" id="bv-geo-jsonld-reviews-data">{"@context":"https://schema.org/","review":[{"@type":"Review","dateCreated":"2026-11-03T10:41:30.000+00:00","datePublished":"2026-11-03T10:45:01.000+00:00","reviewBody":"This is my positive review about this poor product","name":"Review title","reviewRating":{"@type":"Rating","ratingValue":5,"bestRating":5,"worstRating":1},"author":{"@type":"Person","name":"Billy Jean2"},"additionalProperty":[{"@type":"PropertyValue","name":"Best Uses - Telecom","value":"Home Use"}],"video":[{"@type":"VideoObject","thumbnailUrl":"https://img.youtube.com/vi/9uOcuOdGRyo/0.jpg","contentUrl":"https://www.youtube.com/watch?v=9uOcuOdGRyo","uploadDate":"2026-11-03T10:41:30.000+00:00","thumbnail":{"@type":"ImageObject","name":"www.youtube.com"},"name":"Review title","description":"This is my positive review about this poor product","caption":"This is video caption"}],"comment":[{"@type":"Comment","text":"This is my comment to this review.","author":{"@type":"Person","name":"Billy Jean2"},"datePublished":"2026-11-05T10:46:45.000+00:00","upvoteCount":0,"downvoteCount":0}],"commentCount":1}],"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-reviews-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-ratings-data">{"@context":"https://schema.org","aggregateRating":{"@type":"AggregateRating","bestRating":5,"ratingValue":3.3,"reviewCount":2841},"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-ratings-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-reviewSummary-data">{"@context":"https://schema.org/","review":{"@type":"Review","datePublished":"2026-08-05T12:43:10.666000+00:00","reviewBody":"The product is highly regarded by customers, with many praising its excellent features, quality, and value. Positive reviews highlight the impressive battery life and camera performance. However, some mixed opinions mention the camera quality in low light conditions. The summary should be curated to remove irrelevant or low-quality submissions.","author":{"@type":"Organization","name":"AI Review Summary","description":"AI-generated from customer ratings & reviews, and may include incentivized reviews."}},"additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-reviewSummary-data"}]}</script>
<script type="application/ld+json" id="bv-geo-jsonld-questions-data">{"@type":"FAQPage","mainEntity":[{"@type":"Question","name":"Lorem ipsum dolor sit amet?","dateCreated":"2017-06-22T19:30:21.000+00:00","author":{"@type":"Person","name":"Lorem0"},"acceptedAnswer":{"@type":"Answer","text":"Testing answer 2","dateCreated":"2022-09-08T04:44:57.000+00:00","author":{"@type":"Person","name":"AP09"},"upvoteCount":1},"answerCount":3}],"@context":"https://schema.org/","additionalProperty":[{"@type":"PropertyValue","name":"trace:geoidentifier","value":"bv-geo-jsonld-questions-data"}]}</script>
<style>.bv-structured-data-html{display:none}</style>
<div id="bv-geo-html-reviews-data" class="bv-structured-data-html">
    <article data-field="review">
        <h3 data-field="name">Review title</h3>
        <p data-field="reviewBody">This is my positive review about this poor product</p>
        <span data-field="author.name">Billy Jean2</span>
        <time data-field="dateCreated" datetime="2026-11-03T10:41:30.000+00:00">2026-11-03T10:41:30.000+00:00</time>
        <time data-field="datePublished" datetime="2026-11-03T10:45:01.000+00:00">2026-11-03T10:45:01.000+00:00</time>
        <span data-field="reviewRating.ratingValue">5</span>
        <span data-field="reviewRating.bestRating">5</span>
        <span data-field="reviewRating.worstRating">1</span>
        <span data-field="commentCount">1</span>
        <ul data-field="additionalProperty">
            <li>
                <span data-field="name">Best Uses - Telecom</span>
                <span data-field="value">Home Use</span>
            </li>
        </ul>
        <ul data-field="video">
            <li>
                <span data-field="name">Review title</span>
                <span data-field="description">This is my positive review about this poor product</span>
                <span data-field="caption">This is video caption</span>
                <span data-field="contentUrl">https://www.youtube.com/watch?v=9uOcuOdGRyo</span>
                <span data-field="thumbnailUrl">https://img.youtube.com/vi/9uOcuOdGRyo/0.jpg</span>
                <span data-field="thumbnail.name">www.youtube.com</span>
                <time data-field="uploadDate" datetime="2026-11-03T10:41:30.000+00:00">2026-11-03T10:41:30.000+00:00</time>
            </li>
        </ul>
        <ul data-field="comment">
            <li>
                <p data-field="text">This is my comment to this review.</p>
                <span data-field="author.name">Billy Jean2</span>
                <time data-field="datePublished" datetime="2026-11-05T10:46:45.000+00:00">2026-11-05T10:46:45.000+00:00</time>
                <span data-field="upvoteCount">0</span>
                <span data-field="downvoteCount">0</span>
            </li>
        </ul>
    </article>
</div>
<div id="bv-geo-html-ratings-data" class="bv-structured-data-html">
    <article data-field="aggregateRating">
        <data data-field="ratingValue" value="3.3">3.3</data>
        <data data-field="bestRating" value="5">5</data>
        <data data-field="reviewCount" value="2841">2841</data>
    </article>
</div>
<div id="bv-geo-html-reviewSummary-data" class="bv-structured-data-html">
    <article data-field="review">
        <p data-field="reviewBody">The product is highly regarded by customers, with many praising its excellent features, quality, and value. Positive reviews highlight the impressive battery life and camera performance. However, some mixed opinions mention the camera quality in low light conditions. The summary should be curated to remove irrelevant or low-quality submissions.</p>
        <span data-field="author.name">AI Review Summary</span>
        <p data-field="author.description">AI-generated from customer ratings &amp; reviews, and may include incentivized reviews.</p>
        <time data-field="datePublished" datetime="2026-08-05T12:43:10.666000+00:00">2026-08-05T12:43:10.666000+00:00</time>
    </article>
</div>
<div id="bv-geo-html-questions-data" class="bv-structured-data-html">
    <article data-field="mainEntity">
        <h3 data-field="name">Lorem ipsum dolor sit amet?</h3>
        <span data-field="author.name">Lorem0</span>
        <time data-field="dateCreated" datetime="2017-06-22T19:30:21.000+00:00">2017-06-22T19:30:21.000+00:00</time>
        <span data-field="answerCount">3</span>
        <article data-field="acceptedAnswer">
            <p data-field="text">Testing answer 2</p>
            <span data-field="author.name">AP09</span>
            <time data-field="dateCreated" datetime="2022-09-08T04:44:57.000+00:00">2022-09-08T04:44:57.000+00:00</time>
            <span data-field="upvoteCount">1</span>
        </article>
    </article>
</div>

Add the response to your page

Insert the response into the <body> of your product page, not the <head>, exactly as it was received. Do not modify, reformat, or split it.

The response includes the CSS that hides the HTML blocks. The blocks stay hidden whether JavaScript is enabled or disabled, as long as that CSS is applied and nothing overrides it.

Note: Your Content Security Policy (CSP) must allow inline styles (style-src). If it does not, the CSS may be blocked and the HTML blocks may become visible.

If the HTML blocks are missing

To confirm, check the BV-API-Warning response header. It has the value semantic-html-generation-failed.

Supported Markup Schema

📘
HTML Block:
The identical schema will also be present in the HTML block inside <div id="bv-geo-html-reviews-data" class="bv-structured-data-html">, structured using specific data-field attributes like <article data-field="reviews"> . Please note that HTML Block excludes Galleries.

Supported markup schema:

Review
AggregateRating
Q&A (included as FAQPage)
AI Summary (included as a review)
Galleries

Review Schema (`@type: Review`)

This schema is used for individual customer reviews and for the AI review summary.

Attribute	Description	Example
`@type`	Specifies the schema type.	`"Review"`
`dateCreated`	When the review was created (date and time).	`"2026-03-30T10:42:36.000+00:00"`
`datePublished`	When the review was published (date and time).	`"2026-03-30T10:45:44.000+00:00"`
`reviewBody`	The review's main content.	`"This is my positive review about this poor product"`
`name`	The review's title.	`"Review title"`
`reviewRating`	The rating given in the review.	See properties below.
`author`	The reviewer (person or organization).	See properties below.
`additionalProperty`	An array containing Bazaarvoice-configured contextual attributes, including trust badges (Verified Purchaser, Incentivized, Staff, Expert, Top Contributor tiers), secondary ratings (Quality, Value, Fit, Comfort, Appearance), and product questions (Best Uses, Length of Ownership).	See example below.
`video`	Nested properties: - `@type: VideoObject` - `description` - `name` - `thumbnailUrl` - `contentUrl` - `uploadDate` - `thumbnail` (nests `@type: ImageObject`, `name`) An array of videos associated with the review.	See example below.
`image`	Nested properties: - `@type: ImageObject` - `description` - `contentUrl` An array of images associated with the review.	See example below.

`reviewRating` properties

@type: Rating
ratingValue
bestRating
worstRating

Example

{"@type":"Rating","ratingValue":4,"bestRating":5,"worstRating":1}

`author` properties

Person
- @type: Person
- name
Organization
- @type: Organization
- name
- description

Examples

Person: {"@type":"Person","name":"Billy Jean2"}
Organization: {"@type":"Organization","name":"AI Review Summary","description":"This summary is generated by artificial intelligence based on customer reviews"}

Review video example

"video": [
  {
    "@type": "VideoObject",
    "description": "",
    "name": "YWhxSsj1upg",
    "thumbnailUrl": "https://www.youtube.com/watch?v=YWhxSsj1upg",
    "contentUrl": "https://www.youtube.com/watch?v=YWhxSsj1upg",
    "uploadDate": "2021-04-25T16:32:07.000+00:00",
    "thumbnail": {
      "@type": "ImageObject",
      "name": "www.youtube.com"
    }
  }
]

Review image example

"image": [
  {
    "@type": "ImageObject",
    "description": "normal",
    "contentUrl": "https://photos-cert-eu.bazaarvoice.com/photo/2/cGhvdG86dGVzdGN1c3RvbWVyLWZhc3QtcHJz/c4f2df63-64db-5ef2-8673-33ab2a4302e4"
  }
]

Review additionalProperty example

  "additionalProperty": [
          {
            "@type": "PropertyValue",
            "name": "Best Uses - Telecom",
            "value": "Office Use"
          },
          {
            "@type": "PropertyValue",
            "name": "Quality of Product",
            "value": "4",
            "maxValue": "5"
          },
          {
            "@type": "PropertyValue",
            "name": "Value of Product",
            "value": "5",
            "maxValue": "5"
          },
          {
            "@type": "PropertyValue",
            "name": "Comfort",
            "value": "5",
            "maxValue": "5"
          },
          {
            "@type": "PropertyValue",
            "name": "Length of ownership",
            "value": "3 months"
          }
        ]

Review Responses example

📘
Brand Response(ClientResponse):
Brand responses (ClientResponses) are returned inline on each review

📘
Consumer Comment:
Consumer comments are optional and are included only when "include":["comments"] is added in the q parameter. Please refer the Parameters and Headers section for more details.

"review": [
    {
        "@type": "Review",
        "dateCreated": "2017-08-16T18:07:13.000+00:00",
        "datePublished": "2026-09-24T05:35:09.000+00:00",
        "reviewBody": "You know it, everybody knows it. If you don't buy this grill we aren't friends",
        "name": "I know it",
        "reviewRating": {
            "@type": "Rating",
            "ratingValue": 5,
            "bestRating": 5,
            "worstRating": 1
        },
        "author": {
            "@type": "Person",
            "name": "Anonymous"
        },
        "@id": "https://example.github.io/SiteAuthenticationProd/testcustomer-fast-prs/exampleclientid/production/product1.html#102642289",
        "additionalProperty": [
            {
                "@type": "PropertyValue",
                "name": "Quality of Product",
                "value": "1",
                "maxValue": "5"
            },
            {
                "@type": "PropertyValue",
                "name": "Value of Product",
                "value": "1",
                "maxValue": "5"
            }
        ],
        "comment": [
            {
                "@type": "Comment",
                "text": "This is a test response for testing 1",
                "datePublished": "2026-09-24T05:34:47.000+00:00",
                "author": {
                    "@type": "Organization",
                    "name": "testcustomer-fast-prs"
                },
                "@id": "https://example.github.io/SiteAuthenticationProd/testcustomer-fast-prs/exampleclientid/production/product1.html#102642289-bv-response-102642289",
                "parentItem": {
                    "@type": "Review",
                    "@id": "https://example.github.io/SiteAuthenticationProd/testcustomer-fast-prs/exampleclientid/production/product1.html#102642289"
                }
            },
            {
                "@type": "Comment",
                "text": "BFD Comment for testing",
                "author": {
                    "@type": "Person",
                    "name": "Anonymous"
                },
                "datePublished": "2025-01-29T09:49:24.000+00:00",
                "upvoteCount": 7,
                "downvoteCount": 1,
                "@id": "https://example.github.io/SiteAuthenticationProd/testcustomer-fast-prs/exampleclientid/production/product1.html#102642289-bv-comment-4410718",
                "parentItem": {
                    "@type": "Review",
                    "@id": "https://example.github.io/SiteAuthenticationProd/testcustomer-fast-prs/exampleclientid/production/product1.html#102642289"
                }
            }
        ],
        "commentCount": 3
    }
]

AggregateRating Schema (`@type: AggregateRating`)

This schema is used to represent ratings summary.

Attribute	Description	Example
`@type`	Defines the schema type.	`"AggregateRating"`
`bestRating`	The highest value possible in the rating scale.	`5`
`ratingValue`	The overall average rating score.	`3.4320546163849155`
`reviewCount`	The total number of reviews contributing to the aggregate rating.	`3076`

FAQPage Schema

These schemas are used for Q&A mapped as Frequently Asked Questions content.

Attribute	Description	Example
`@type`	Defines the schema type.	`"FAQPage"`
`mainEntity`	An array of questions on the FAQ page.	See Question properties below.

Question properties

Attribute	Description	Example
`@type`	Defines the schema type.	`"Question"`
`name`	The text of the question.	`"Question 27?"`
`dateCreated`	The date and time the question was created.	`"2019-04-15T13:54:06.000+00:00"`
`author`	The person who asked the question.	`{"@type":"Person","name":"stgtest27"}`
`answerCount`	The number of answers provided for the question.	`582`
`acceptedAnswer`	The accepted or primary answer to the question.	See selection rules below.

`acceptedAnswer` selection rules

Only one answer is chosen in this order of priority:

Pick an answer given by the client or brand.
Pick an answer with maximum positive feedback.
Pick the latest answer.

Example

{"@type":"Answer","text":"This is my answer for this question."}

Answer properties

Attribute	Description	Example
`@type`	Defines the schema type.	`"Answer"`
`text`	The main body of the answer.	`"This is my answer for this question."`
`dateCreated`	The date and time the answer was created.	`"2026-03-20T10:38:06.000+00:00"`
`author`	The person who provided the answer.	`{"@type":"Person","name":"Billy Jean2"}`
`upvoteCount`	The number of upvotes the answer has received.	`0`

AI Summary Schema

This schema is included as a review and contains the AI-generated review summary.

Attribute	Description	Example
`@type`	Defines the schema type.	`"Review"`
`datePublished`	The date and time the AI summary was published.	`"2025-10-09T19:18:37.064000+00:00"`
`reviewBody`	The AI-generated review summary text.	`"The product is highly regarded by customers, with many praising its excellent features, quality, and value."`
`author`	The organization that generated the summary.	See properties below.

AI Summary `author` properties

@type: Organization
name
description

Example

{"@type":"Organization","name":"AI Review Summary","description":"This summary is generated by artificial intelligence based on customer reviews"}

Galleries Schema `@type : ItemList`

This schema represents a Bazaarvoice media gallery. The gallery is returned as an ItemList; each media item is a ListItem whose item is an ImageObject. Gallery structured data is produced by the Media API.

Attribute	Description	Example
`@type`	Specifies the schema type.	`"ItemList"`
`name`	The display name of the gallery.	`"Visual Gallery"`
`numberOfItems`	Total number of items in the gallery.	`97`
`itemListElement`	An array of `ListItem` entries.	See properties below.

`listItem` Properties

Attribute	Description	Example
`@type`	Specifies the schema type.	`"ListItem"`
`position`	The 1-based position of the item in the list.	`1`
`item`	The media object (an `ImageObject`).	See properties below.

`item` (`@type = ImageObject` ) Properties

Attribute	Description	Example
`@type`	Specifies the schema type.	`"ImageObject"`
`name`	The name/caption of the media item.	`"Featuring Sandals"`
`contentUrl`	The URL of the media asset.	`"https://example.com/image1.jpg"`

Example

curl --request GET \
     --url 'https://seo-stg.bazaarvoice.com/structured-data/v1/clients/yourclientid/ugc?productId=product1&q=%7B%22galleries%22%3A%5B%7B%22noExpired%22%3Afalse%2C%22dataSourceId%22%3A%22DKQGLerBTQCDXwNS%22%2C%22filter%22%3A%22productId%3Aleather-jacket%22%2C%22sort%22%3A%22Latest%22%2C%22limit%22%3A10%2C%22requireProduct%22%3Atrue%2C%22networkSource%22%3A%22Instagram%22%7D%5D%7D&locale=en_US' \
     --header 'Accept: application/ld+json' \
     --header 'Bv-passkey: Your-passkey'

Sample

"galleries": [
    {
      "@context": "https://schema.org",
      "@type": "ItemList",
      "name": "Visual Gallery",
      "numberOfItems": 97,
      "itemListElement": [
        {
          "@type": "ListItem",
          "position": 1,
          "item": {
            "@type": "ImageObject",
            "name": "Featuring Sandals",
            "contentUrl": "https://example.com/image1.jpg"
          }
        },
        {
          "@type": "ListItem",
          "position": 2,
          "item": {
            "@type": "ImageObject",
            "name": "Featuring Boots",
            "contentUrl": "https://example.com/image2.jpg"
          }
        }
      ]

Retrieve ratings, reviews, AI generated review summaries and galleries in JSON-LD + HTML

Sample Request

Sample Response

Add the response to your page

If the HTML blocks are missing

Retrieve ratings, reviews, and questions and answers

Sample Request

Sample Request

Add the response to your page

If the HTML blocks are missing

Supported Markup Schema

HTML Block:

Review Schema (@type: Review)

reviewRating properties

author properties

Review video example

Review image example

Review additionalProperty example

Review Responses example

Brand Response(ClientResponse):

Consumer Comment:

AggregateRating Schema (@type: AggregateRating)

FAQPage Schema

Question properties

acceptedAnswer selection rules

Answer properties

AI Summary Schema

AI Summary author properties

Galleries Schema @type : ItemList

listItem Properties

item (@type = ImageObject ) Properties

Example

Sample

Review Schema (`@type: Review`)

`reviewRating` properties

`author` properties

AggregateRating Schema (`@type: AggregateRating`)

`acceptedAnswer` selection rules

AI Summary `author` properties

Galleries Schema `@type : ItemList`

`listItem` Properties

`item` (`@type = ImageObject` ) Properties