Reviews

Reviews per topic

POST/insights/v1/topics/reviews

Use it in a workflow

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

Request

Headers

content typestring

application /JSON

authorizationstring

Bearer <### Your uToken goes here ###> e.g. Bearer YTJZm0J7XaIcpzVN8HsWzhOcAzwdbzFJ1HDQJXSk

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

minimum_mentionsinteger (int32)

The minimum number of times this topic was mentioned. Should always be set to no less than 10 mentions. Default: 0

Default 0

external_product_idsarray<string>

Product ID. Supports multiple products. This parameter is also sometimes referred to as `SKU` or `domain_key`

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,). [See List](https://github.com/YotpoLtd/country-states/blob/master/us.go)

product_groupsarray<string>

The name of the product group as defined in your Yotpo product catalog. [Learn More](https://support.yotpo.com/en/article/importing-product-catalogs#csv-file-structure)

product_collectionsarray<string>

The name of the product collection as defined in your Yotpo product catalog [Learn More](https://support.yotpo.com/en/article/importing-product-catalogs#product-collections)

topicsarray<string>required

The name of the topic. Supports multiple topics.

exclude_topicsstring

Use this param to filter out a certain topic from the response.

sentiment_typestringrequired

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

sentiment_fieldstringrequired

Should remain defined as `sentiment`

minimum_scoreinteger (int32)

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

exclude_unpublishedstring

Set as `true` to exclude unpublished reviews from your response

pageinteger (int32)

Page number

per_pageinteger (int32)

Results per page. Default: 0

sorting_directionstring

`ASC` or `DESC` Case sensitive.

json

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

Response

Returns 200 with an object. Read it in later steps with {{reviews.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": 1,
    "per_page": 10,
    "total": 3
  },
  "reviews": [
    {
      "review_id": 55920385,
      "email": "reviewer1@gmail.com",
      "title": "My Favorite !!",
      "content": "I have a ton of mods. Big mods, little mods, expensive mods, cheap mods. This one is my favorite, Compact with smooth edges that ride in my pocket perfectly. Huge tank that lasts days. The JVIC coils rock !! I use the .6ohm for DTL hits and its perfect. Air daw is great even without adjustable flow control. Im not a cloud chaser but, this thing makes great clouds, Flavor is excellent. Battery lasts all day. All around a perfect mod for my vaping style. I bought 2 so i always have one ready to go. Protip: Thoroughly clean all parts for the unit where you fill it or it may leak. if its clean and dry. no problems.",
      "reviewed_at": 1521728328000,
      "score": 5,
      "opinions": [
        {
          "opinion": "excellent",
          "sentence": "im not a cloud chaser but, this thing makes great clouds, flavor is excellent."
        }
      ]
    }
  ]
}

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

Was this page helpful?