List product reviews

GET

/api/v1/business/website/products/{slug}/reviews/

All approved reviews for a product, plus a rating summary.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type

API Key (header: X-Periscale-Key)

Parameters

Path Parameters

slug*

Type

string

Required

Example"cotton-t-shirt"

Responses

Reviews and summary.

Content-Type

application/json

{

  

"status": true,

  

"status_code": 0,

  

"message": "string",

  

"data": {

  

  

"items": [

  

  

],

  

  

"next_cursor": "string",

  

  

"has_more": true,

  

  

"summary": {

  

  

  

"average_rating": 0,

  

  

  

"total_reviews": 0,

  

  

  

"rating_breakdown": {

  

  

  

}

  

  

}

  

}

}

GET

/api/v1/business/website/products/{slug}/reviews/

Playground

Server

Authorization

apiKey

Variables

Key

Value

slug*

Samples

Powered by VitePress OpenAPI