Sign in

v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

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.

get/v2/{account_id}/reviews?access_token={access_token}

Path parameters

account_idstring required

Your account's API app key

Query parameters

access_tokenstring required

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

customer_emailstring

The customer’s email address

include_nestedboolean

Retrieve nested data. e.g. user data

include_site_reviewsboolean

Include site reviews in addition to product reviews

countinteger

The number of reviews you want to retrieve

pageinteger

Page number

sortstring

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

directionstring

Descending (default) or Ascending: asc, desc

starinteger

Filter by star rating score

include_unpublished_reviewsboolean

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_minstring date

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

updated_at_minstring date

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

is_incentivizedboolean

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

incentive_type'free_product' | 'coupon' | 'loyalty_points' | 'paid_ promotion' | 'employee_review' | 'other'

The type of incentive provided for the review

Response

200

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "pagination": {
    "page": 1,
    "count": 2,
    "total": 11890
  },
  "reviews": {
    "reviews": [
      {
        "id": "53697686",
        "score": 5,
        "content": "This is the best pillow I have ever used. I am used to a very firm foam pillow, but upon receiving this one with my mattress I am very pleased. It is not as firm but I find that I like it much better.",
        "title": "The Best",
        "created_at": "2018-02-06T12:25:49.000Z",
        "verified_buyer": true,
        "custom_fields": {
          "--9728": {
            "title": "Age",
            "form_id": 207,
            "value": "25 to 34",
            "field_type": "SingleChoice"
          },
          "--9729": {
            "title": "Sleep position",
            "form_id": 207,
            "value": "On my stomach",
            "field_type": "SingleChoice"
          },
          "--9730": {
            "title": "Hours of Sleep",
            "form_id": 207,
            "value": "7 to 9 hours",
            "field_type": "SingleChoice"
          }
        },
        "user": {
          "id": 16014677,
          "display_name": "George M.",
          "social_image": "https://ddcfq0gxiontw.cloudfront.net/images/anonymous_user.png",
          "email": "curiousgeorge@email.com"
        },
        "user_id": 16014677,
        "product_id": 35421776,
        "external_product_id": "59154867428",
        "published": true,
        "order_id": 10456345,
        "external_order_id": "1045"
      }
    ]
  }
}