Best Reviews

post

https://developers.yotpo.com/v2/{account_id}/best_reviews?access_token={access_token}

Leveraging Yotpo's Insights engine, 'Best reviews' are identified, parsed, and extracted based on the number of distinct positive topics and opinions within your reviews. You can define the minimum star-rating score, topics, sentence length, and more. Please note: this endpoint supports English reviews only. For reviews in other languages, you can use the "top reviews" endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

Your account's API app key.

Query Params

access_token

string

required

Your Yotpo access_token. Click here to learn how to generate one

Body Params

minimum_review_length

int32

The minimum length of reviews to return. Must be less than maximum_review_length. Default: 150 characters

maximum_review_length

int32

The maximum length of reviews to return. Must be greater than minimum_review_length Default: 500 characters

minimum_title_length

int32

The minimum review title length to return. Default: 20 characters

maximum_title_length

int32

The maximum review title length to return. Default: 100 characters

start_date

date

Start date of your request (Default: 12 Months) YYYY-MM-DDT00:00:00.000Z

end_date

date

End date of your request (Default: 12 Months). YYYY-MM-DDT00:00:00.000Z

external_product_ids

array of strings

Product ID. Supports multiple products. This parameter is also sometimes referred to as SKU or domain_key

external_product_ids

topics

array of strings

The name of the topic. Supports multiple topics.

topics

exclude_topics

array of strings

Use this param to filter out a certain topic from the response.

exclude_topics

max_reviews

int32

The maximum number of reviews to return (Default: 10). Limited to 1000 reviews per request.

minimum_score

int32

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

exclude_unpublished

boolean

Passing this param as false will return unpublished reviews. Default: true

exclude_syndicated

boolean

Set as true to exclude syndicated reviews. Default: false

exclude_negative_opinions

boolean

Set as false to include reviews with negative opinions. Default: true

exclude_grouped_reviews

boolean

Set as true to include reviews from grouped products. Default: false

Responses

200200

400400