Reviews per topic

post

https://api.yotpo.com/insights/v1/topics/reviews

Retrieves reviews on specific products according to topics. The response includes review data such as reviewer email, review id, title, content, star-rating, opinions, and can be filtered accordingly. For a full breakdown, see the Body Params list below.

Body Params

store_id

string

required

The store ID

start_date

date

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

end_date

date

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

minimum_mentions

int32

Defaults to 0

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

external_product_ids

array of strings

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

external_product_ids

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,). See List

states

product_groups

array of strings

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

product_groups

product_collections

array of strings

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

product_collections

topics

array of strings

required

The name of the topic. Supports multiple topics.

topics*

exclude_topics

string

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

sentiment_type

string

required

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

sentiment_field

string

required

Should remain defined as sentiment

minimum_score

int32

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

exclude_unpublished

string

Set as true to exclude unpublished reviews from your response

page

int32

Page number

per_page

int32

Results per page. Default: 0

sorting_direction

string

ASC or DESC Case sensitive.

Headers

content type

string

application /JSON

authorization

string

Bearer <### Your access token goes here ###> e.g. Bearer YTJZm0J7XaIcpzVN8HsWzhOcAzwdbzFJ1HDQJXSk

Responses

200200

400400