Products

POST/insights/v1/products

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Products action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{products.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 groups as defined in your Yotpo product catalog

product_collectionsstring

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

Set as `false` to exclude unpublished reviews

external_product_idsstring

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

sorting_fieldstring

Possible values: `yotpo_default_sorting`, `sentiment_score`, `average_star_rating`, `positive_reviews`, `negative_reviews`

sorting_directionstring

ASC or DESC Case sensitive

pageinteger (int32)

Page number

per_pageinteger (int32)

Results per page. Default: 0

json

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

Response

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

productsarray<object>

product_idstring

product_namestring

average_star_ratingnumber

Default 0

sentiment_scorenumber

Default 0

sentiment_changeobject2 fields

positive_reviewsinteger

Default 0

negative_reviewsinteger

Default 0

neutral_reviewsinteger

Default 0

reviews_countinteger

Default 0

pagingobject

pageinteger

Default 0

page_countinteger

Default 0

per_pageinteger

Default 0

totalinteger

Default 0

json

{
  "products": [
    {
      "product_id": "19059407",
      "product_name": "Durif - Wrinkle Free",
      "average_star_rating": 4.8793969849246235,
      "sentiment_score": 77.88945,
      "sentiment_change": {
        "value": 6.815067070891658,
        "error": ""
      },
      "positive_reviews": 160,
      "negative_reviews": 5,
      "neutral_reviews": 34,
      "reviews_count": 199
    }
  ],
  "paging": {
    "page": 0,
    "page_count": 302,
    "per_page": 3,
    "total": 904
  }
}

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

Was this page helpful?