Core APIs
...
Product API
Results

Reviews

2min

Reviews Results

When making a request with the type parameter 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 for a single product on Home Depot.

Customer Reviews Page
Customer Reviews Page


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

JSON


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.
    • 
      1. is_external_source
      2. boolean
      3. True/false whether the review was sourced from an external third-party.
    • 
      1. author_name
      2. string
      3. The username of the author of the review.
    • 
      1. author_id
      2. string
      3. The ID of the author of the review.
    • 
      1. author_location
      2. string
      3. The location of the author of the review, if shown.
    • 
      1. verified_purchase
      2. boolean
      3. 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 .

  • 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.
    • 
      1. one_star
      2. number
      3. The number of one-star ratings received.
    • 
      1. two_star
      2. number
      3. The number of two-star ratings received.
    • 
      1. three_star
      2. number
      3. The number of three-star ratings received.
    • 
      1. four_star
      2. number
      3. The number of four-star ratings received.
    • 
      1. five_star
      2. number
      3. 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 .

  • 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