Reviews per product

post

https://api.yotpo.com/insights/v1/products/reviews

Get detailed organic reviews per product including top opinions and best sentences found within the review content.

Body Params

store_id

string

required

The store ID

start_date

date

Start date and time of your request. YYYY-MM-DDT00:00:00.000Z

end_date

date

End date and time of your request. YYYY-MM-DDT00:00:00.000Z

countries

array of strings

Abbreviation of reviewer origin country (e.g US). Supports multiple countries. See List

countries

states

array of strings

Abbreviation of reviewer origin state (e.g. CA, NY,). Supports multiple states. See List

states

product_groups

string

The name of the product group as defined in your Yotpo product catalog

product_collections

string

required

The name of the product collection as defined in your Yotpo product catalog

minimum_score

int32

Filter by minimum star-rating. Must be an integer between 1 and 5(stars)

exclude_unpublished

boolean

Pass as true to include unpublished reviews in your response.

external_product_ids

string

required

The unique product IDs (supports multiple products). This parameter is also sometimes referred to as SKU or domain_key

sorting_direction

string

ASC or DESC Case sensitive.

page

int32

Page number

per_page

int32

Results per page. Default: 0

sentiment_type

string

required

The sentiment associated with a topic in a review. Possible values: POSITIVE,NEGATIVE, NEUTRAL Case sensitive, must be in uppercase.

sentiment_field

string

required

Default: review_sentiment

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400