Retrieve data in JSON

This section provides sample request to retrieve structured data in the JSON format.

To retrieve data in the JSON format, send application/ld+json in the Accept request header.

Sample Request

curl --location 'https://seo.bazaarvoice.com/structured-data/v1/clients/testcustomer-fast-prs/ugc?locale=en_US&productId=product1' \
--header 'Accept: application/ld+json' \
--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>'

Sample Response

{
    "reviews": {
        "@context": "https://schema.org/",
        "review": [
            {
                "@type": "Review",
                "dateCreated": "2026-03-30T10:42:36.000+00:00",
                "datePublished": "2026-03-30T10:45:44.000+00:00",
                "reviewBody": "This is my positive review about this poor product",
                "name": "Review title",
                "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"
                    }
                ],
                "image": [
                    {
                        "@type": "ImageObject",
                        "contentUrl": "https://photos-us.bazaarvoice.com/photo/2/cGhvdG86zdGN1c3RvbWVyLWZhc3QtcHJz/f70282db-e961-5232-bddd-adc4133a7de3",
                        "name": "Example Review title",
                        "description": "Example review description",
                        "caption": "image caption"
                    }
                ],
                "video": [
                    {
                        "@type": "VideoObject",
                        "thumbnailUrl": "https://video.api.bazaarvoice.com/e6bef6e8-1777-4d6/thumbnail/image-00001.png",
                        "contentUrl": "https://video.api.bazaarvoice.com/e6bef6e8-1777-4d698/video/movie.mp4",
                        "uploadDate": "2026-07-30T09:25:23.000+00:00",
                        "thumbnail": {
                            "@type": "ImageObject",
                            "name": "BAZAARVOICE"
                        },
                        "name": "Example Review title",
                        "description": "Example review description",
                        "caption": "image caption"
                    }
                ],
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 4,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "Billy Jean2"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-29T10:42:06.000+00:00",
                "datePublished": "2026-03-29T10:46:43.000+00:00",
                "reviewBody": "This is my positive review about this poor product",
                "name": "Review title",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 1,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "Billy Jean2"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-28T10:42:22.000+00:00",
                "datePublished": "2026-03-28T10:47:00.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"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-27T10:42:14.000+00:00",
                "datePublished": "2026-03-27T10:46:59.000+00:00",
                "reviewBody": "This is my positive review about this poor product",
                "name": "Review title",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 1,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "Billy Jean2"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-26T10:42:29.000+00:00",
                "datePublished": "2026-03-26T10:48:53.000+00:00",
                "reviewBody": "This is my positive review about this poor product",
                "name": "Review title",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 4,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "Billy Jean2"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-26T05:18:36.000+00:00",
                "datePublished": "2026-03-26T05:30:32.000+00:00",
                "reviewBody": "This is my positive review about this poor product",
                "name": "Review title",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 1,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "Billy Jean2"
                }
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-25T06:06:42.000+00:00",
                "datePublished": "2026-03-25T06:16:09.000+00:00",
                "reviewBody": "",
                "name": "",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 3,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "kpkp"
                }
            },
            {
                "@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": "trying to submit multiple response",
                        "datePublished": "2026-09-24T05:35:09.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": 2
            },
            {
                "@type": "Review",
                "dateCreated": "2026-03-25T05:59:51.000+00:00",
                "datePublished": "2026-03-25T06:01:58.000+00:00",
                "reviewBody": "Prod location 36.2Prod location 36.2Prod location 36.2Prod location 36.2Prod location 36.2Prod location 36.2",
                "name": "Prod location 36.2",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": 2,
                    "bestRating": 5,
                    "worstRating": 1
                },
                "author": {
                    "@type": "Person",
                    "name": "rb2503"
                }
            },
        ]
    },
    "ratings": {
        "@context": "https://schema.org",
        "aggregateRating": {
            "@type": "AggregateRating",
            "bestRating": 5,
            "ratingValue": 3.4320546163849155,
            "reviewCount": 3076
        }
    }
}

Did this page help you?