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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Authentication and request format

Authenticate with Authorization: Bearer YOUR_ACCESS_TOKEN. The Insights API does not accept the X-Yotpo-Token header.

Send filters inside the filter object, pagination inside paging and sorting inside sorting. Fields sent at the top level of the body are ignored.

Body Params
filter
object
required

Filters for the request. app_key is required.

paging
object

Pagination. If omitted, up to 25 results are returned.

sorting
object

Sorting options.

Responses

401

Missing or invalid bearer token. The body is the plain string unauthorized.

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