YOyotpo

Top Reviews

Changed on

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

get/v2/{account_id}/top_reviews

Request

  • Base URL
    https://developers.yotpo.com
  • URL
    https://developers.yotpo.com/v2/{account_id}/top_reviews
  • Auth
    API key in header X-Yotpo-Token

Path parameters

account_idstring required

Your account's API app key

Query parameters

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

paginationunknown

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"
      }
    ]
  }
}

Changes