API Reference
Core APILoyalty APIApp Developer APIHelp Center

Search reviews

post
https://api-cdn.yotpo.com/v1/reviews//filter.json

This endpoint acts as a flexible search that can be used to retrieve reviews with various metadata or with top_mentioned_topics.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The store ID (App Key)

Query Params
integer
Defaults to 1

The paginated response page number to return, beginning from 1

integer
Defaults to 10

The number of results to return per page

Body Params
string

The unique product identifier (Product ID)

scores
array of integers

The review star rating score(s) to return e.g. [4] would return 4-star reviews

scores
topic_names
array of strings

The topics mentioned in the review e.g. top_mention_topics

topic_names
boolean

Pass a value of true to return reviews with pictures

string

Free text search terms. Supported languages: English, French, German, Italian, Norwegian, Portuguese, Spanish, Russian, Swedish, Turkish

crfs
array of objects

CRF object (Custom Questions/Custom Review Form)

crfs
orders
array of objects

Array of order filter objects

orders
sortings
array of objects

Sorting options. Possible sort_by values: _score (elastic_search_score), reviewer_type (badge), score, date, votes_up (votes), votes_down (low_votes), image_count (images), grouping_originated (grouping)

sortings
integer

The number of results to return per page

Responses

Updated about 2 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 about 2 months ago