Fetch Structured Data (JSON-LD or Microdata)

get

https://seo-stg.bazaarvoice.com/structured-data/v1/clients/{clientId}/ugc

Retrieves structured data for a specific product. This is the recommended endpoint that accepts productId as a query parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

The name of the client. Can contain special characters.

Query Params

productId

string

required

The ID of the product. Can contain special characters.

object

A JSON-encoded query object containing parameters for various content types. Refer to Bazaarvoice CV2 documentation for specific filter and sort values.

canonical

uri

The exact identifier string used in your Product Schema's @id field. CRITICAL REQUIREMENT: For search engines to associate these reviews with your product, the string you send here MUST BE IDENTICAL (character-for-character) to the @id you assign to the Product object in your own schema generation. Recommended Format: Product Canonical URL + #product fragment.

locale

string

required

Locale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key.

siteId

string

Site ID of the implementation, default will be main_site

Headers

Bv-Forwarded-User-Agent

string

length between 10 and 500

^[a-zA-Z0-9\s\[\]\{\}\/\.\-_;:,+]+$

Clients will need to send User-Agent of consumers accessing the PDP page

User-Agent

string

length between 10 and 500

^[a-zA-Z0-9\s\[\]\{\}\/\.\-_;:,+]+$

Clients will need to send User-Agent of their backend http client

string

enum

Defaults to application/ld+json

Generated from available response content types

Allowed:

Responses

200Returns JSONLD by default for reviews and ratings.

400Bad Request, Validation failed for the request

401Unauthorized

defaultInternal Server Error