Skip to main content
GET
Render a product Rich Snippet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

referer
string<uri>

Product page URL used when the referer query parameter is omitted.

Maximum string length: 2048
Example:

"https://shop.example.com/products/linen-shirt"

Path Parameters

productRef
string
required

Stable Cevoid product or variant id, external product reference, URL slug, or auto with a referer.

Required string length: 1 - 256
Example:

"prd_linen_shirt"

Query Parameters

market
string

Workspace market short id. When omitted, Cevoid infers the market from the referer URL.

Required string length: 1 - 128
Example:

"mar_sweden"

language
string
required

Language used for market-specific product presentation, such as sv or en-US.

Required string length: 1 - 64
Example:

"sv-SE"

referer
string<uri>

Product page URL used for auto product resolution and optional market inference.

Maximum string length: 2048
Example:

"https://shop.example.com/products/linen-shirt"

Response

Successful response

html
string
required

Visible aggregate-rating HTML rendered from the same projection snapshot as jsonLd.

Minimum string length: 1
Example:

"<div class=\"cevoid-rating\">Rated 4.8 out of 5 from 24 reviews</div>"

jsonLd
object
required
projectionVersion
enum<number>
required

Version of the authoritative review projection used for both response representations.

Available options:
1
Example:

1

computedAt
string<date-time>
required

ISO 8601 timestamp when the authoritative review projection was computed.

Example:

"2026-08-01T10:05:00.000Z"