Reviews

reviews results when making a request with the type parameter https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews set to type=reviews backyard api will return all customer reviews for the product specified in the item id or url parameter reviews are retrieved from the customer reviews page https //www homedepot com/reviews/product/317061059 for a single product on home depot an example of the json object returned from a reviews request is shown below { "request info" { "success" true, "credits used" 1, "credits remaining" 999 }, "request metadata" { "created at" "2020 01 01t00 00 00 000z", "processed at" "2020 01 01t00 00 00 001z", "total time taken" 0 1, "homedepot url" "https //www homedepot com/p/317061059" }, "request parameters" { "engine" "homedepot", "type" "reviews", "item id" "317061059", "sort by" "most helpful" }, "reviews" \[ { "position" 1, "id" "257606120", "item id" "317061059", "title" "great mower", "body" "i always wanted a lithium powered lawn mower and this fit the bill", "campaign id" "20220519 ppc pr1 out 4034447 ", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 19t14 27 36 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8151927", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86ag9tzwrlcg90/7604b51f ed3b 5aeb 9432 827200805aef" } ], "source" { "is external source" true, "external source" false, "author name" "ianlynphotography", "author id" "243961987", "author location" "valley stream", "verified purchase" false } }, { "position" 2, "id" "257555766", "item id" "317061059", "title" "after one day of use, so far so good ", "body" "i picked up the mower this morning at my local hd \r\nit assembled way easier than i expected \r\nand the battery charged completely after about 30 minutes \r\n\r\nsome minor quality things \r\none \r\nwhen i ordered the mower on the hd web site, i saw model ry401170vnm\r\nand that is the model numer on the sticker affixed to the mower \r\nbut, the manuals (booklets really) all reference model number ry401017\r\ni thought that was kinda odd \r\n\r\ntwo \r\non the front of the battery that came with the mower, there is a button that, when pressed, should illuminate a number of green lights indicating how much charge is currently in the battery (charge level indicator button )\r\nwell, nothing happens when i press my batteries charge level indicator button \r\nthe light do light up when i insert the battery into the charger while it is being charged \r\nbut not when that button is pressed \r\nso, for now, i have no way of telling how much charge is in the battery unless i plug it into the charger \r\nthe ryobi customer support rep told me i should pack up the mower and battery and take it back to hd for a replacement \r\nthe hd online chat support person told me the same thing \r\ni'm unsure is that is really worth it but i just wanted others to know of my experience ", "campaign id" "bv review display", "rating" 5, "positive feedback" 2, "negative feedback" 0, "date" "2022 05 17t23 20 06 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8146005", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86ag9tzwrlcg90/e5991de2 86f8 5e14 9784 151b382780f0" } ], "source" { "is external source" true, "external source" false, "author name" "justray", "author id" "9jq3gh1wmsfdaufmd437w22fo", "verified purchase" false } }, { "position" 3, "id" "257554616", "item id" "317061059", "title" "alot of power", "body" "\[this review was collected as part of a promotion ] i bought this mower, my grass was incredibly high so to procrastinating and it powered right through it didn't big down i have 25 acres and it got the job done very quickly", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 17t22 24 52 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8145858", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/836e7cf7 9a07 5b78 9591 1b52af625d61" } ], "source" { "is external source" true, "external source" true, "author name" "jmaggicc", "author id" "9w60z3rp81e4tokgcwt7vu4ae", "author location" "waxahachie texas", "verified purchase" false } }, { "position" 4, "id" "257537365", "item id" "317061059", "title" "awesome product", "body" "\[this review was collected as part of a promotion ] i have a range of ryobi, 10 tools atleast in love with this brand", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 17t02 16 07 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8143232", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/bb0b2296 38f9 5689 b802 a0397558506d" } ], "source" { "is external source" true, "external source" true, "author name" "gagan19", "author id" "f42tk4rc403orrpl5eb7e1sbr", "author location" "toronto", "verified purchase" false } }, { "position" 5, "id" "257521677", "item id" "317061059", "title" "lots of mowing power", "body" "\[this review was collected as part of a promotion ] my work in electrification and i was very please with both the battery life and mowing power of the 40v ryobi ", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 16t11 57 36 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8140063", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/9fb60d6f b356 5ec8 b1ca 2e1526554abe" } ], "source" { "is external source" true, "external source" true, "author name" "ds19192", "author id" "q0jx794xmyrqqzs97xnhpbkvq", "author location" "golden co", "verified purchase" false } }, { "position" 6, "id" "257500171", "item id" "317061059", "title" "buy one", "body" "\[this review was collected as part of a promotion ] they are great!! i just a bought weed wacker and i love it!! thank ryobi for the garden tool ", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 15t01 20 36 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8136369", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/4c0ec901 dac3 5847 9b5c ca5072df28bc" } ], "source" { "is external source" true, "external source" true, "author name" "markito", "author id" "q9c09lcudqmbriadr1pcxnlsj", "author location" "utah", "verified purchase" false } }, { "position" 7, "id" "257494850", "item id" "317061059", "title" "great for the $$$", "body" "\[this review was collected as part of a promotion ] i really like how simple it is to start and so light easy storage easily mowed over a half acre with on bar left my wife likes how simple to start and easily use the self propelled great bang for the buck! keep up the good work ryobi!", "rating" 4, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 14t19 12 50 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8135278", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/312f8436 599a 59e8 a84c de7f568087d8" } ], "source" { "is external source" true, "external source" true, "author name" "tjmoore1968", "author id" "trv20uwpsuvrqtzkmwmj2yq2d", "author location" "mattydale, ny", "verified purchase" false } }, { "position" 8, "id" "257468638", "item id" "317061059", "title" "quick & easy", "body" "\[this review was collected as part of a promotion ] just received this yesterday took right out of box charged up battery and away we went! the grass was high but used the height knob to easily go over it! i’m a 62 yr young woman and this was manageable for me!!!", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 13t14 18 20 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8129944", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/9a765f37 8cad 5b6e 8cb5 0ef1bfb83356" } ], "source" { "is external source" true, "external source" true, "author name" "anonymous", "author id" "th54zoxuq8mkw0zpdufes7x65", "author location" "new jersey", "verified purchase" false } }, { "position" 9, "id" "257386248", "item id" "317061059", "title" "awesome", "body" "\[this review was collected as part of a promotion ] bought this lovely girl today , definitely candy wait to see her shape up my yard", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 11t16 11 19 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8121105", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/2a073dcf 4ff4 5af1 a155 572233903eba" } ], "source" { "is external source" true, "external source" true, "author name" "chocolate rage", "author id" "75hb3rbeqmgowebz22icurbx6", "author location" "indiana", "verified purchase" false } }, { "position" 10, "id" "257197890", "item id" "317061059", "title" "easy to use", "body" "\[this review was collected as part of a promotion ] i am so happy with my ryobi battery operated lawn mower my husband loved taking care of our lawn he recently passed and i needed something i could handle this lawnmower is lightweight, easy to start and store this is what my yard looks like after that first mow my husband would be proud thank you", "rating" 5, "positive feedback" 0, "negative feedback" 0, "date" "2022 05 04t12 05 20 000+00 00", "is recommended" true, "is early reviewer incentive" false, "is incentivized review" false, "is top 1000 contributor" false, "is top 250 contributor" false, "images" \[ { "id" "8083597", "link" "https //photos us bazaarvoice com/photo/2/cghvdg86cnlvymlvdxrkb29ydg9vbhm/b55c2dfe 7546 595e 887f 72a26c81f814" } ], "source" { "is external source" true, "external source" true, "author name" "mbooth62", "author id" "eyzq1f3q5l3glgxqzq0rgb8f8", "author location" "clifton park ny", "verified purchase" false } } ], "summary" { "rating" 4 7, "ratings total" 863, "recommended count" 525, "not recommended count" 26, "rating breakdown" { "five star" 667, "four star" 139, "three star" 20, "two star" 12, "one star" 25 } }, "product" { "item id" "317061059" }, "pagination" { "current page" 2, "next page" 3, "total pages" 87, "total reviews" 863 } } backyard api returns the following properties for reviews requests property type description reviews array an array of review objects, containing each of the customer reviews shown on the customer reviews page the review object has the following properties id string the unique, home improvement assigned, id of the customer review this can be used by your app to flag whether you have previously processed this review on a prior request title string the title of the review body string the body text of the review item id string the item id of the product the review relates to, if shown campaign id string the campaign id of the review, if shown date string the date of the review rating number the rating, out of 5, given by the reviewer positive feedback number the number of times this review has been given positive feedback negative feedback number the number of times this review has been given negative feedback is recommended boolean set to true if the review is marked as 'recommended' is early reviewer incentive boolean set to true if the review is marked as an 'early reviewer incentivized review' is incentivized review boolean set to true if the review is marked as an 'incentivized review' is top 1000 contributor boolean set to true if the review author is marked as a 'top 1000 contributor' is top 250 contributor boolean set to true if the review author is marked as a 'top 250 contributor' is top 250 contributor boolean set to true if the review author is marked as a 'top 250 contributor' images array an array of image objects containing the reviewer supplied images accompanying the review each item in the array contains an id and link property videos array an array of video objects containing the reviewer supplied videos accompanying the review each item in the array contains an id , thumbnail and link property source object review source object the source object contains details about the source and author of the review is external source boolean true/false whether the review was sourced from an external third party author name string the username of the author of the review author id string the id of the author of the review author location string the location of the author of the review, if shown verified purchase boolean whether this reviewer is an verified purchaser of the product product object an object containing details of the product (in so far as those details are shown on the customer reviews page) for full product details you should issue a request with type=product to retrieve details from the product page https //docs trajectdata com/backyardapi/home improvement product data api/results/product item id string the item id of the product the reviews relate to summary object an object containing a summary of all reviews for the product, as shown at the top left of the customer reviews page rating number the overall rating of the product, out of 5 ratings total number the total number of customer ratings the product has received recommended count number the number of reviews that recommend the product (all reviews, not just those on the current page) not recommended count number the number of reviews that do not recommend the product (all reviews, not just those on the current page) rating breakdown object rating breakdown object contains details how many of each star rating value the product has received one star number the number of one star ratings received two star number the number of two star ratings received three star number the number of three star ratings received four star number the number of four star ratings received five star number the number of five star ratings received pagination object pagination object an object containing details of the current page and the total number of pages that are available to paginate you should specify the page number in your request's page parameter https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews current page number the current page number next page number the next page number, if a next page of results is available total pages number the total number of pages of results next steps reviews parameters https //docs trajectdata com/backyardapi/home improvement product data api/parameters/reviews