---
title: Reviews
slug: bigboxapi/homedepot-product-data-api/results/reviews
docTags: 
createdAt: 2024-07-22T08:01:06.003Z
---

# Reviews Results

When making a request with the  `type`  [parameter](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/reviews) set to  `type=reviews`  BigBox 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.

![](https://apiimages.imgix.net/bigboxapi/images/png/docs/reviews.png?auto=format\&ixlib=react-9.5.1-beta.1\&w=600 "Customer Reviews Page")

An example of the JSON object returned from a Reviews request is shown below:

:::CodeblockTabs
json

```json
{
  "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": {
    "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
  }
}
```
:::

BigBox API returns the following properties for Reviews requests:

| *`Property`*         | *`Type`*         | *`Description`*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *`reviews`*<br />    | *`array`*<br />  | An array of Review objects, containing each of the Customer Reviews shown on the Customer Reviews page. The Review object has the following properties:<br />- `id`<br />- `string`<br />- The unique, Home Depot-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.<br /><br />- `title`<br />- `string`<br />- The title of the review.<br /><br />- `body`<br />- `string`<br />- The body text of the review.<br /><br />- `item_id`<br />- `string`<br />- The Item ID of the product the review relates to, if shown..<br /><br />- `campaign_id`<br />- `string`<br />- The campaign ID of the review, if shown..<br /><br />- `date`<br />- `string`<br />- The date of the review.<br /><br />- `rating`<br />- `number`<br />- The rating, out of 5, given by the reviewer.<br /><br />- `positive_feedback`<br />- `number`<br />- The number of times this review has been given positive feedback.<br /><br />- `negative_feedback`<br />- `number`<br />- The number of times this review has been given negative feedback.<br /><br />- `is_recommended`<br />- `boolean`<br />- Set to  `true`  if the review is marked as 'recommended'.<br /><br />- `is_early_reviewer_incentive`<br />- `boolean`<br />- Set to  `true`  if the review is marked as an 'early reviewer incentivized review'.<br /><br />- `is_incentivized_review`<br />- `boolean`<br />- Set to  `true`  if the review is marked as an 'incentivized review'.<br /><br />- `is_top_1000_contributor`<br />- `boolean`<br />- Set to  `true`  if the review author is marked as a 'top 1000 contributor'.<br /><br />- `is_top_250_contributor`<br />- `boolean`<br />- Set to  `true`  if the review author is marked as a 'top 250 contributor'.<br /><br />- `is_top_250_contributor`<br />- `boolean`<br />- Set to  `true`  if the review author is marked as a 'top 250 contributor'.<br /><br />- `images`<br />- `array`<br />- An array of image objects containing the reviewer-supplied images accompanying the review. Each item in the array contains an  `id`  and  `link`  property.<br /><br />- `videos`<br />- `array`<br />- 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.<br /><br />- `source`<br />- `object`<br />- **Review Source Object &#xD;**<br />The  `source`  object contains details about the source and author of the review.<br />- <br />1. `is_external_source`<br />2. `boolean`<br />3. True/false whether the review was sourced from an external third-party.<br />- <br />1. `author_name`<br />2. `string`<br />3. The username of the author of the review.<br />- <br />1. `author_id`<br />2. `string`<br />3. The ID of the author of the review.<br />- <br />1. `author_location`<br />2. `string`<br />3. The location of the author of the review, if shown.<br />- <br />1. `verified_purchase`<br />2. `boolean`<br />3. Whether this reviewer is an verified purchaser of the product. |
| *`product`*<br />    | *`object`*<br /> | 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/bigboxapi/homedepot-product-data-api/results/product).<br />- `item_id`<br />- `string`<br />- The Item ID of the product the reviews relate to.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| *`summary`*<br />    | *`object`*<br /> | An object containing a summary of all reviews for the product, as shown at the top-left of the Customer Reviews page.<br />- `rating`<br />- `number`<br />- The overall rating of the product, out of 5.<br /><br />- `ratings_total`<br />- `number`<br />- The total number of customer ratings the product has received.<br /><br />- `recommended_count`<br />- `number`<br />- The number of reviews that recommend the product (all reviews, not just those on the current page).<br /><br />- `not_recommended_count`<br />- `number`<br />- The number of reviews that do not recommend the product (all reviews, not just those on the current page).<br /><br />- `rating_breakdown`<br />- `object`<br />- **Rating Breakdown Object &#xD;**<br />Contains details how many of each star rating value the product has received.<br />- <br />1. `one_star`<br />2. `number`<br />3. The number of one-star ratings received.<br />- <br />1. `two_star`<br />2. `number`<br />3. The number of two-star ratings received.<br />- <br />1. `three_star`<br />2. `number`<br />3. The number of three-star ratings received.<br />- <br />1. `four_star`<br />2. `number`<br />3. The number of four-star ratings received.<br />- <br />1. `five_star`<br />2. `number`<br />3. The number of five-star ratings received.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| *`pagination`*<br /> | *`object`*<br /> | **Pagination Object**<br />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/bigboxapi/homedepot-product-data-api/parameters/reviews).<br />- `current_page`<br />- `number`<br />- The current page number.<br /><br />- `next_page`<br />- `number`<br />- The next page number, if a next page of results is available.<br /><br />- `total_pages`<br />- `number`<br />- The total number of pages of results.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

***

**Next Steps**
     [Reviews Parameters](https://docs.trajectdata.com/bigboxapi/homedepot-product-data-api/parameters/reviews)
