YOyotpo

Best Sentences

Changed on

This endpoint automatically retrieves the very best sentences from your Yotpo reviews, so you can leverage the social proof of top customer testimonials at key conversion points throughout the buyer journey! You define the star-rating score, sentence length, and more!

post/v2/{account_id}/best_sentences

Request

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

Path parameters

account_idstring required

Your Yotpo App Key

Request body

minimum_sentence_lengthinteger

Define the minimum length of best sentences by character count. Must be less than the maximum_sentence_length. Default: 20 chars

maximum_sentence_lengthinteger

Define the maximum length of best sentences by character count. Must be greater than the minimum_sentence_length. Default: 100 chars

maximum_number_of_sentencesinteger

Define the maximum number of sentences to return for this request. Default: 3 sentences

start_datestring date

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

end_datestring date

End date and time of your request. 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

product_groupsstring

The name of a product group.

product_collectionsstring

The name of a product collection

minimum_scoreinteger

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

exclude_unpublishedboolean

Passing this param as true will only return best sentences from published reviews.

Response

200

Example response

{
  "review_sentences": [
    {
      "review_id": 47084341,
      "sentence": "this web site is a great place to get very cute bracelets, necklaces, or rings!",
      "external_product_id": "5420399557",
      "topics": [
        "necklace"
      ]
    }
  ]
}

Changes