Topics

post

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

Retrieves topics mentioned in reviews. The response includes Insights data such as topic sentiment score, industry average, the number of opinions detected per topic, and the opinion polarity. You can filter your request by date, product, reviewer location, review score, and much more. For a full breakdown, see the body params list below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

The minimum number of times this topic was mentioned Should always be set to no less than 10 mentions Topics associated with a low number of opinions may result in a statistically insignificant sentiment score. Default: 0

external_product_ids

array of strings

The unique product IDs (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,). Supports multiple states. See List

states

product_group

array of strings

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

product_group

product_collections

array of strings

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

product_collections

minimum_score

int32

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

topics

array of strings

The name of the topic. Supports multiple topics.

topics

page

int32

Page number

per_page

int32

Results per page. Default: 0

sorting_field

string

Accepted values: yotpo_default_sorting,sentiment_score,positive_mentions,negative_mentions,topic (alphabetically) Note: yotpo_default_sorting leverages a sorting logic which includes sentiment score, and the number of opinions to surface the most significant and polarized topics. This sorting parameter is equal to "most relevant" in the Insights dashboard.

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