YOyotpo

Best Reviews

Changed on

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.

post/v2/{account_id}/best_reviews

Request

  • Base URL
    https://developers.yotpo.com
  • URL
    https://developers.yotpo.com/v2/{account_id}/best_reviews
  • Auth
    API key in header X-Yotpo-Token

Path parameters

account_idstring required

Your account's API app key.

Request body

minimum_review_lengthinteger

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

maximum_review_lengthinteger

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

minimum_title_lengthinteger

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

maximum_title_lengthinteger

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

start_datestring date

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

end_datestring date

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

external_product_idsstring[]

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

topicsstring[]

The name of the topic. Supports multiple topics.

exclude_topicsstring[]

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

max_reviewsinteger

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

minimum_scoreinteger

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

exclude_unpublishedboolean

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

exclude_syndicatedboolean

Set as true to exclude syndicated reviews. Default: false

exclude_negative_opinionsboolean

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

exclude_grouped_reviewsboolean

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

Response

200

paginationunknown

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "best_review": {
    "best_reviews": [
      {
        "review_id": "46388102",
        "external_product_id": "54588",
        "topics": [
          "adore"
        ]
      }
    ]
  }
}

Changes