All Reviews

Retrieve reviews data per account as a paginated response. This call will return reviews metrics such as review id, star-ratings score, votes_up or votes_down, review content, product identifiers, and more.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Reviews Data - Response Attributes

AttributeDescription
idThe review ID
scoreThe star-rating score where 5 is a 5-star rating
votes_up👍The number of customers who up-voted this review
votes_down👎The number of customers who down-voted this review
contentThe textual review content
titleThe title of the review
created_atThe timestamp generated upon review creation
verified_buyerThe status of the reviewer. Verified buyers are buyers who created their review via Mail After Purchase
source_review_idThe review ID by source
custom_fieldsCustom review form fields. Nested parameters include the form title,form_id,value, and field type
images_data
userUser data. Nested parameters include the user id, display _name, social_image, and email
product
user_idThe unique identifier of the reviewer who submitted the review
external_order_idThe external order ID of the purchase
product_idThe unique product identifier of the product reviewed
commentThe comment left on the review
external_product_idThe external product ID of the product reviewed
publishedThe published or unpublished state of the review as defined by the include_unpublished_reviews param.
📘

Product ID

Note that in some parts of the API, product_id may be referred to as external_product_id

Path Params
string
required

Your account's API app key

Query Params
string
required

Your Yotpo access token. Click here to learn how to generate one

string

The customer’s email address

boolean
Defaults to false

Retrieve nested data. e.g. user data

boolean

Include site reviews in addition to product reviews

int32

The number of reviews you want to retrieve

int32

Page number

string

Sort values: date, votes_up, votes_down, time, rating, reviewer_type

string

Descending (default) or Ascending: asc, desc

int32

Filter by star rating score

boolean

Pass a value of true to get all reviews including unpublished reviews. Pass a value of false (default) to get just the published reviews.

date

Retrieve all reviews created starting from this date. The date format is YYYY-MM-DD.

date

Retrieve all reviews updated from this date. The date format is YYYY-MM-DD.

boolean

Indicates if the review comes from an incentivized source (for example, a product sampling company)

string
enum

The type of incentive provided for the review

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json