How Authentic Discovery API works

The following steps describe how this server-side solution works for API clients, regardless of display implementation.

  1. A search engine or AI crawler visits your product detail page (PDP).
  2. Your server receives the page request and reads the User-Agent header.
  3. The User-Agent header value is checked against a list of known search engines and AI crawler identifiers.
    ℹ️

    Note:

    Consider blocking bad bots for your website using robots.txt or WAF rules much before your website's home page, Product List Page (PLP), or PDPs.

  4. If the User-Agent matches, call the Bazaarvoice Authentic Discovery API. When making this call, ensure you include the original crawler's User-Agent in the Bv-Forwarded-User-Agent request header.
  5. Bazaarvoice returns ready-to-embed structured data markup. Embed the response into your PDP's HTML.
    ℹ️

    Note:

    If User-Agent does not match any known search engines or AI crawlers, skip the Bazaarvoice Authentic Discovery API call and serve the page normally. Bazaarvoice JavaScript handles visual rendering for human visitors

Content types

This API provides a complete set of "structured data," including:

Content TypeDescription
Ratings (default)Overall star rating and total review count for the product.
Reviews (default)Individual customer reviews, including ratings, body text, author, dates, images, and videos. See sample request and response
AI-generated Review SummaryAI-generated review summary, returned as the Review object when available. See sample request and response
Questions and AnswersQuestion and answer content structured as FAQPage schema. See sample request and response
❗️

Important:

By default, the Authentic Discovery API returns aggregated ratings, reviews, and aggregated ratings. You can customize the request to fetch additional content types (Questions and Answers and AI-generated review summaries) by passing the desired types in the request query parameters.

Response formats

You can choose how the API sends data back to you using the Accept header. Though it is an optional header, you can use this to determine the response format. The default response format is text/javascript.

Accept Header ValueDescription
text/javascriptReturns <script type="application/ld+json"> tag. Embed the response directly in your HTML or without modification. Recommended by schema.org and search engines.
application/ld+jsonReturns markup objects in JSON format. You can use this JSON directly in the Product Schema..
text/htmlReturns HTML with inline microdata attributes. Add as hidden content on the PDP. Use only when JSON-LD is not suitable for your environment.