Core APIs
...
Parameters
Customer Feedback
Reviews
4min
reviews parameters get get /request the reviews parameters are applicable when making a request with type=reviews to retrieve customer reviews for a single product on target the product is specified using the tcin , dpci or url parameter (where the url parameter contains a link to an target product page) the parameters should be appended as querystring parameters to the target product data api get http request reviews are retrieved from the customer reviews page https //www target com/p/ /a 78025470 for a single product on target note that redcircle will cache the gtin to asin mapping for 2 months to force a new gtin lookup (for example, if you suspect the existing mapping is stale or the product has been added to the site), use the skip gtin cache=true request parameter (note that using skip gtin cache=true decrements 2 credits from your balance, instead of 1) for example, to request reviews sorted by most recent ( sort by=most recent ), for the tcin 78025470 the request would be http https //api redcircleapi com/request?api key=demo\&type=reviews\&tcin=78025470\&sort by=most recentcurl l get https //api redcircleapi com/request \\ d api key="demo" \\ d type="reviews" \\ d tcin="78025470" \\ d sort by="most recent"const axios = require('axios'); // set up the request parameters const params = { api key "demo", type "reviews", tcin "78025470", sort by "most recent" } // make the http get request to redcircle api axios get('https //api redcircleapi com/request', { params }) then(response => { // print the json response from redcircle api console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo', 'type' 'reviews', 'tcin' '78025470', 'sort by' 'most recent' } \# make the http get request to redcircle api api result = requests get('https //api redcircleapi com/request', params) \# print the json response from redcircle api print(json dumps(api result json()))\<?php \# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo', 'type' => 'reviews', 'tcin' => '78025470', 'sort by' => 'most recent' ]); \# make the http get request to redcircle api $ch = curl init(sprintf('%s?%s', 'https //api redcircleapi com/request', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from redcircle api echo $api result; ?> reviews parameters the following parameters are available for all requests made when type=reviews in addition to the common parameters parameter required description tcin optional the target tcin (item id) to retrieve reviews for dpci optional the dpci code to look up a matching product on target for to retrieve reviews dpci based requests work by searching for the dpci on target first, then retrieving the product details for the first matching tcin gtin optional the gtin/isbn/upc code to look up a matching product on target for to retrieve reviews if the gtin parameter is supplied then the tcin and dpci parameters are ignored gtin based requests work by searching for the gtin/isbn/upc on target first, then retrieving the product details for the first matching tcin reviewer type optional the type of reviewer to retrieve reviews from valid values are verified purchase include reviews by verified purchasers only all include all reviews, regardless of whether they are from verified purchasers or not review stars optional the star rating of reviews to retrieve valid values are all stars include reviews with any star rating five star include reviews with a 5 star rating four star include reviews with a 4 star rating three star include reviews with a 3 star rating two star include reviews with a 2 star rating one star include reviews with a 1 star rating review media type optional filter the reviews to those containing a specific media type valid values are all reviews include all reviews, irrespective of whether they contain an image media reviews only include only reviews containing images sort by optional determines the sort order of reviews to return valid values are most recent returns reviews with the most recent reviews first high to low rating returns reviews ordered highest to lowest rating low to high rating returns reviews ordered lowest to highest rating most helpful returns reviews with the most helpful reviews first page optional the current page of reviews to retrieve inspect the pagination total pages property in the reviews results https //docs trajectdata com/redcircleapi/target product data api/results/reviews to see how many pages of reviews are available max page optional use the max page parameter to get multiple pages of results in one request the api will automatically paginate through pages and concatenate the results into one response see the pagination https //docs trajectdata com/redcircleapi/target product data api/pagination docs for more information url optional the target product page url to retrieve reviews details from note if the url parameter is supplied then the tcin , dpci and gtin parameters are ignored (the url overrides these parameters) next steps reviews results https //docs trajectdata com/redcircleapi/target product data api/results/reviews