Best Sentences

post

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

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!

Path Params

account_id

string

required

Your Yotpo App Key

Query Params

access_token

string

required

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

Body Params

minimum_sentence_length

int32

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

maximum_sentence_length

int32

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

maximum_number_of_sentences

int32

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

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

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

product_groups

string

The name of a product group.

product_collections

string

The name of a product collection

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 true will only return best sentences from published reviews.

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200200

400400