---
title: "Fetch Structured Data (JSON-LD or Microdata)"
method: GET
path: "/clients/{client-id}/ugc"
---

# Fetch Structured Data (JSON-LD or Microdata)

`GET /clients/{client-id}/ugc`

## Request

- Base URL: `https://seo-stg.bazaarvoice.com/structured-data/v1`
- URL: `https://seo-stg.bazaarvoice.com/structured-data/v1/clients/{client-id}/ugc`
- Auth: API key in header `Bv-Passkey`

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

## Path parameters

- `client-id` string, required

## Query parameters

- `productId` string, required
- `canonical` string, uri
- `locale` string, required
- `siteId` string

## Headers

- `Bv-Forwarded-User-Agent` string
- `User-Agent` string
- `Accept` string

## Response `200`

Returns JSONLD by default for reviews and ratings.

- JsonLdResponseJSONFormat: JSON-LD structured data object inside script tag
  - `reviews` object: contains https://schema.org/Review schema in form of array
  - `questions` object: contains https://schema.org/FAQPage
  - `ratings` object: contains https://schema.org/AggregateRating
  - `reviewSummary` object: contains https://schema.org/Review schema in form of array

## Other responses

- `400`: Bad Request, Validation failed for the request
- `401`: Unauthorized
- `default`: Internal Server Error

---

[API](https://skmtc.dev/bazaarvoice/apis/seo.md) - [All operations](https://skmtc.dev/bazaarvoice/apis/seo/llms.txt) - [OpenAPI document](https://skmtc.dev/bazaarvoice/apis/seo/revisions/9404da178e6a?raw)