All Reviews

get

https://developers.yotpo.com/v2/{account_id}/reviews?access_token={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.

Path Params

account_id

string

required

Your account's API app key

Query Params

access_token

string

required

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

customer_email

string

The customer’s email address

include_nested

boolean

Defaults to false

Retrieve nested data. e.g. user data

include_site_reviews

boolean

Include site reviews in addition to product reviews

count

int32

The number of reviews you want to retrieve

page

int32

Page number

sort

string

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

direction

string

Descending (default) or Ascending: asc, desc

star

int32

Filter by star rating score

include_unpublished_reviews

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.

created_at_min

date

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

updated_at_min

date

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

is_incentivized

boolean

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

incentive_type

string

enum

The type of incentive provided for the review

Allowed:

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200200

400400