API Reference
Core APILoyalty APIApp Developer APIHelp Center

Products

post
https://api.yotpo.com/insights/v1/products

Get the average star rating score, sentiment, sentiment change, organic reviews counts, and reviews sentiment distribution for specific products in your store.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Note:

The reviews count returned in this endpoint only includes organic reviews. Reviews from grouped products are not counted in the reviews_count.

Body Params
string
required

The store ID

date

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

date

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

countries
array of strings

Abbreviation of reviewer origin country (e.g US). Supports multiple countries. See List

countries
states
array of strings

Abbreviation of reviewer origin state (e.g. CA, NY,). Supports multiple states. See List

states
string

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

string

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

int32

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

boolean

Set as false to exclude unpublished reviews

string

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

string

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

string

ASC or DESC Case sensitive

int32

Page number

int32

Results per page. Default: 0

Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago