Product Reviews

Reviews per product

POST/insights/v1/products/reviews

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Product Reviews action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{productReviews.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

app_keystringrequired

The store ID

start_datestring (date)

Start date and time of your request. YYYY-MM-DDT00:00:00.000Z

end_datestring (date)

End date and time of your request. YYYY-MM-DDT00:00:00.000Z

countriesarray<string>

Abbreviation of reviewer origin country (e.g US). Supports multiple countries. [See List](https://github.com/pariz/gountries/tree/master/data/json/countries)

statesarray<string>

Abbreviation of reviewer origin state (e.g. CA, NY,). Supports multiple states. [See List](https://github.com/YotpoLtd/country-states/blob/master/us.go)

product_groupsstring

The name of the product group as defined in your Yotpo product catalog

product_collectionsstringrequired

The name of the product collection as defined in your Yotpo product catalog

minimum_scoreinteger (int32)

Filter by minimum star-rating. Must be an integer between 1 and 5(stars)

exclude_unpublishedboolean

Pass as `true` to include unpublished reviews in your response.

external_product_idsstringrequired

The unique product IDs (supports multiple products). This parameter is also sometimes referred to as SKU or `domain_key`

sorting_directionstring

ASC or DESC Case sensitive.

pageinteger (int32)

Page number

per_pageinteger (int32)

Results per page. Default: 0

sentiment_typestringrequired

The sentiment associated with a topic in a review. Possible values: `POSITIVE`,`NEGATIVE`, `NEUTRAL` Case sensitive, must be in uppercase.

sentiment_fieldstringrequired

Default: `review_sentiment`

json

{
  "app_key": "string",
  "product_collections": "string",
  "external_product_ids": "string",
  "sentiment_type": "string",
  "sentiment_field": "string",
  "start_date": "2025-01-01",
  "end_date": "2025-01-01",
  "countries": [
    "string"
  ],
  "states": [
    "string"
  ],
  "product_groups": "string",
  "minimum_score": 0,
  "exclude_unpublished": false
}

Response

Returns 200 with an object. Read it in later steps with {{productReviews.response.data.<field>}}.

pagingobject

pageinteger

Default 0

page_countinteger

Default 0

per_pageinteger

Default 0

totalinteger

Default 0

reviewsarray<object>

review_idinteger

Default 0

emailstring

titlestring

contentstring

reviewed_atinteger

Default 0

scoreinteger

Default 0

opinionsarray<object>2 fields

json

{
  "paging": {
    "page": 0,
    "page_count": 43,
    "per_page": 3,
    "total": 129
  },
  "reviews": [
    {
      "review_id": 59353058,
      "email": "anne.taylor@email.com",
      "title": "",
      "content": "The size 8 (which was the exchange for the size 10) is a perfect fit. How can I return the size 10. Would you kindly provide an address?",
      "reviewed_at": 1526398665000,
      "score": 5,
      "opinions": [
        {
          "opinion": "is a perfect fit",
          "sentence": "the size 8 (which was the exchange for the size 10) is a perfect fit."
        }
      ]
    }
  ]
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.

Was this page helpful?