Sign in

v1

latestOpenAPI 3.0.02026-07-24283460.8 KB
Reviews and Questions

Retrieve Reviews and Questions

get/reviews

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring

Your REVIEWS.io private api key. This will add additional private data to the API response such as reviewer email addresses.

skustring

Product SKUs, seperated by semi colons

mpnstring

Product MPNs, seperated by semi colons

gtinstring

Product GTINs, seperated by semi colons

type'store_review' | 'product_review' | 'store_third_party_review' | 'questions'

Type of reviews to return. One of store_review, product_review, store_third_party_review or questions. If type is omitted or set to store_third_party_review, an apikey must be provided.

tagstring

Tags, seperated by semi colons

branchstring

Filter reviews by branch

pagenumber

Page of results to return

per_pagenumber

How many items to return per page

withstring

Return reviews with active photos or videos. One of images, videos or media.

keywordstring

Return reviews containing your keyword in the review text.

dateFromstring date

Return reviews newer than dateFrom.

dateTostring date

Return reviews older than dateTo.

minRatingnumber

Return reviews with rating higher than minRating.

sort'date_desc' | 'date_asc' | 'highest_rating' | 'lowest_rating' | 'helpful_desc' | 'helpful_asc' | 'date_update_desc' | 'date_update_asc'

Order for reviews to be returned in. Defaults to newest first if none specified

{"stackTrail":"components:parameters:attribute:schema:items","oasType":"schema","type":"unknown"}

Array of reviewer attribute, keyed by the attribute_id

{"stackTrail":"components:parameters:review_attribute:schema:items","oasType":"schema","type":"unknown"}

Array of review attributes, keyed by the attribute_id

include_unpublished_photosboolean

Includes photos on the review that are not currently published

include_product_imagesboolean

Only return verified reviews

include_product_reviewsboolean

Include product_reviews when type is set to store_review

include_local_reviewsboolean

Include store_third_party_reviews when type is set to store_review

include_subrating_breakdownboolean

Include a counts and ratings of your rating attributes

must_have_bodyboolean

Return reviews that have comments only

emailstring

Return reviews left by a specific email address. Requires apikey

Response

OK

review_countstring

Total Reviews

results_countstring

Total Reviews with filters applied, use for pagination

average_ratingstring

Average Rating

verdictstring

A keyword to reflect the average rating

store_namestring

Name of the REVIEWS.io account

Example response

{
  "reviews": [
    {
      "id": "store_review-123456",
      "type": "store_review",
      "type_label": "Company",
      "source": "Reviews",
      "author": {
        "name": "Gary",
        "location": "Leicester, United Kingdom"
      }
    }
  ],
  "stats": {
    "company": {
      "review_count": "1234",
      "average_rating": "4.57"
    }
  },
  "review_count": "1234",
  "results_count": "57",
  "average_rating": "4.57",
  "verdict": "Excellent",
  "store_name": "The Plant Company"
}