v1

latestOpenAPI 3.0.02026-07-24154539.9 KB

Fetch Structured Data (JSON-LD or Microdata)

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

get/clients/{client-id}/ugc

Path parameters

client-idstring required

The name of the client. Can contain special characters.

Query parameters

productIdstring required

The ID of the product. Can contain special characters.

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

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

localestring required
Example:en_US

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.

siteIdstring
Example:main_site

Site ID of the implementation, default will be main_site

Headers

Bv-Forwarded-User-Agentstring
Example:Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko); compatible; ChatGPT-User/1.0; +https://openai.com/bot

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

User-Agentstring
Example:Apache-HttpClient/4.5.8 (Java/1.8.0_191)

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

Acceptstring

Accept header must be empty or omitted. The API will return the default content type (text/javascript) for now, in future this might change.

Response

Returns JSONLD by default for reviews and ratings.