v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Top Reviews

This endpoint automatically retrieves the top reviews from your Yotpo reviews based on the star rating.

get/v2/{account_id}/top_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

external_product_idstring

The product ID you want to retrieve data for. Unless you indicate a product reviews this endpoint would fetch site reviews

Response

200

{"stackTrail":"paths:/v2/{account_id}/top_reviews?access_token={access_token}:get:responses:200:content:application/json:schema:properties:pagination","oasType":"schema","type":"unknown"}

Example response

{
  "status": {
    "code": 200,
    "message": "ok"
  },
  "top_reviews": {
    "reviews": [
      {
        "score": 5,
        "title": "J'adore",
        "content": "Belle et confortable. On peut pas faire mieux.",
        "product_url": "https://yotpo.com/go/1usvvgxJ",
        "created_at": "2012-12-12T16:08:57.000Z"
      }
    ]
  }
}