fieldsstring
Fields to return separated by comma. ["_id", "censored", "country_code", "device_name", "device_type", "facebook_pushed", "has_comment", "product_name", "product_sku", "published", "review_content", "review_creation_date", "review_score", "review_source", "review_title", "reviewer_name", "twitter_pushed"]
query[censored]boolean
1 for censored reviews
query[country_code]string
Two-letter country code
query[device_name]string
Either mobile phone type or browser type for example: Android, iPhone, Chrome, Safari
query[facebook_pushed]boolean
1 for pushed to Facebook reviews
query[twitter_pushed]boolean
1 for Tweeted reviews
query[has_comment]boolean
1 for reviews with comments
query[product_name]string
Filter reviews by product name
query[product_name_prefix]string
Filter reviews by the product name prefix (initial characters)
query[product_sku]string
Filter reviews by the product SKU (stock-keeping unit)
query[product_sku_prefix]string
Filter reviews by the product SKU (stock-keeping unit) prefix (initial characters)
query[published]boolean
1 for published reviews
query[review_content]string
Filter reviews by review content
query[review_content_prefix]string
Filter reviews by the review content prefix (initial characters)
query[review_creation_date]string
Two dates separated by a comma. First value is since date second value is to date. Can also pass only one value
query[review_score]integer (int32)
Filter reviews by reviews score. An integer from one to 5
query[review_source]string
["unknown", "widget", "import", "reminder", "site_reminder", "resend_reminder", "testimonials_request", "mail_after_service", "mail_after_invoice", "widget_v2", "anonymous_testimonials_request", "vendor", "widget_v2_facebook_tab", "widget_v2_dedicated_page"]
query[review_title]string
Filter reviews by the review title
query[review_title_prefix]string
Filter reviews by the review title prefix (initial characters)
query[reviewer_email]string
Filter reviews by the reviewer email
query[reviewer_name]string
Filter reviews by the reviewer name
group[censored]string
Empty string, count number of censored and uncensored reviews
group[country_code]string
Empty string, count number of reviews per country code
group[device_name]string
Empty string, count number of reviews per device name
group[device_type]string
Empty string, count number of reviews per device type
group[facebook_pushed]string
Empty string, count number of reviews pushed to facebook
group[twitter_pushed]string
Empty string, count number of twitted reviews
group[has_comment]string
Empty string, count number of reviews with comments
group[published]string
Empty string, count number of published reviews
group[review_creation_date]string
Count number of reviews per time period, values can be one of: ["day", "week", "month", "quarter", "year"]*
group[review_score]string
Empty string, count number of reviews per score
group[review_source]string
Empty string, count number of reviews per source
utokenstringrequired
Your Yotpo account access token. See Yotpo Authentication for instructions on generating a utoken.
