get https://developers.yotpo.com/v2//reviews?access_token=
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.
Reviews Data - Response Attributes
Attribute | Description |
---|---|
id | The review ID |
score | The 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 |
content | The textual review content |
title | The title of the review |
created_at | The timestamp generated upon review creation |
verified_buyer | The status of the reviewer. Verified buyers are buyers who created their review via Mail After Purchase |
source_review_id | The review ID by source |
custom_fields | Custom review form fields. Nested parameters include the form title ,form_id ,value , and field type |
images_data | |
user | User data. Nested parameters include the user id , display _name , social_image , and email |
product | |
user_id | The unique identifier of the reviewer who submitted the review |
external_order_id | The external order ID of the purchase |
product_id | The unique product identifier of the product reviewed |
comment | The comment left on the review |
external_product_id | The external product ID of the product reviewed |
published | The 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 asexternal_product_id