API Reference
ReviewsLoyaltyApp partnersHelp CenterAPI keys
  1. Reviews V1 · Insights

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…
📘

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.

🚧

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
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.

Updated 12 days ago

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

Updated 12 days ago

Did this page help you?