Site integrations
Home Depot
Home Depot product reviews, every one a product page counts, ratings-only entries included.
Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.
- Site:
homedepot - Version:
1.0.1 - Reads from:
homedepot.com
| Action | Description | Listed price |
|---|---|---|
reviews | Read a Home Depot product's reviews, 100 a page, newest, oldest, highest, lowest or most helpful first, optionally only some star ratings: rating, title, text, date, author, the variant reviewed, verified-purchase, incentive and syndication flags, feedback votes, photos and the brand's reply. Every review the product page counts is reachable, ratings-only entries included, with no cap on the offset. | Billed per request at your plan's rates |
reviews
Read a Home Depot product's reviews, 100 a page, newest, oldest, highest, lowest or most helpful first, optionally only some star ratings: rating, title, text, date, author, the variant reviewed, verified-purchase, incentive and syndication flags, feedback votes, photos and the brand's reply. Every review the product page counts is reachable, ratings-only entries included, with no cap on the offset.
POST https://request.usestring.ai/v1/integrations/homedepot/reviewsInput
Unknown fields are rejected.
| Field | Type | Description |
|---|---|---|
product | string | Required. A Home Depot item id, or a homedepot.com product or review page URL. At least 1 character. |
sort | newest oldest highest lowest helpful | newest (the default), oldest, highest or lowest rating, or helpful first. Oldest first keeps pages stable while reviews arrive, so an offset resumes a crawl exactly. |
stars | integer[] | null | Only reviews with one of these star ratings, 1 to 5. Omitted, every rating. At most 5 entries. |
pages | integer | How many pages of up to 100 reviews to read, from 1. From 1 to 50. |
offset | integer | How many reviews, in this sort order, to skip before the first page. At least 0. |
Output
data is an array of rows, one per result. Each row has:
| Field | Type | Description |
|---|---|---|
itemId | string | The item id asked for. |
totalResults | integer | How many reviews match this query, ratings-only entries included. |
offset | integer | The review's position in this sort order, from 0. |
reviewId | string | — |
reviewProductId | string | The item id of the variant the review was written for. |
reviewProductName | string | null | — |
reviewProductBrand | string | null | — |
reviewProductUrl | string | null | — |
rating | integer | null | — |
title | string | null | — |
text | string | null | — |
isRatingsOnly | boolean | A star rating with no written review. |
submissionTime | string | null | ISO 8601. |
lastModificationTime | string | null | ISO 8601. |
userNickname | string | null | — |
userLocation | string | null | — |
authorId | string | null | — |
isRecommended | boolean | null | — |
isVerifiedPurchaser | boolean | — |
isEarlyReviewerIncentive | boolean | The author was rewarded for an early review. |
isSyndicated | boolean | null | — |
syndicationSource | string | null | The site a syndicated review was written on, such as the brand's own. |
positiveFeedbackCount | integer | null | — |
negativeFeedbackCount | integer | null | — |
pros | string | null | — |
cons | string | null | — |
photoUrls | string[] | — |
clientResponse | string | null | The brand's or Home Depot's latest public reply. |
clientResponseDate | string | null | ISO 8601. |
contentLocale | string | null | — |
Example
curl https://request.usestring.ai/v1/integrations/homedepot/reviews \
-H "Authorization: Bearer $STRING_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"product": "https://www.homedepot.com/p/Milwaukee-16-in-Chainsaw-Chain-49-16-2715/305993859",
"sort": "oldest",
"stars": [1]
}'data starts with these rows:
[
{
"itemId": "305993859",
"totalResults": 29,
"offset": 0,
"reviewId": "221924793",
"reviewProductId": "305993859",
"reviewProductName": "16 in. Chainsaw Chain",
"reviewProductBrand": "Milwaukee",
"reviewProductUrl": "https://www.homedepot.com/p/Milwaukee-16-in-Chainsaw-Chain-49-16-2715/305993859",
"rating": 1,
"title": "Love the chainsaw and the original chain that came on...",
"text": "Love the chainsaw and the original chain that came on the saw worked good but the replacement chain was terrible. It cut down one medium size tree and was so dull we couldn’t use it anymore. Extremely unhappy with the replacement chain and am looking at another brand that will fit the saw and work",
"isRatingsOnly": false,
"submissionTime": "2019-07-10T03:02:56.000+00:00",
"lastModificationTime": "2020-08-21T10:10:51.000+00:00",
"userNickname": "HomeDepotCustomer",
"userLocation": null,
"authorId": "03E8D82B988834700S",
"isRecommended": null,
"isVerifiedPurchaser": true,
"isEarlyReviewerIncentive": false,
"isSyndicated": false,
"syndicationSource": null,
"positiveFeedbackCount": 1,
"negativeFeedbackCount": 0,
"pros": null,
"cons": null,
"photoUrls": [],
"clientResponse": "\nHello Beef, this is Brianna with Milwaukee. I apologize for your experience with our products and appreciate that you took the time to bring this to our attention. We would like the opportunity to investigate your feedback further. Please could you contact me at [email protected]? We’ll work with you to resolve any issues as quickly as possible.<br />Thank you! Brianna<!--[if ReviewResponse]><![endif]-->",
"clientResponseDate": "2019-07-10T12:46:28.000+00:00",
"contentLocale": "en_US"
},
{
"itemId": "305993859",
"totalResults": 29,
"offset": 1,
"reviewId": "235625889",
"reviewProductId": "305993859",
"reviewProductName": "16 in. Chainsaw Chain",
"reviewProductBrand": "Milwaukee",
"reviewProductUrl": "https://www.homedepot.com/p/Milwaukee-16-in-Chainsaw-Chain-49-16-2715/305993859",
"rating": 1,
"title": "It is not milwaukee brand, it is oregon chain saw...",
"text": "It is not milwaukee brand, it is oregon chain saw chain brand. False advertising",
"isRatingsOnly": false,
"submissionTime": "2020-08-04T19:32:49.000+00:00",
"lastModificationTime": "2020-08-07T19:32:55.000+00:00",
"userNickname": "Homedepotcustomer",
"userLocation": null,
"authorId": "03ED08240679AF900S",
"isRecommended": null,
"isVerifiedPurchaser": true,
"isEarlyReviewerIncentive": false,
"isSyndicated": false,
"syndicationSource": null,
"positiveFeedbackCount": 0,
"negativeFeedbackCount": 1,
"pros": null,
"cons": null,
"photoUrls": [],
"clientResponse": null,
"clientResponseDate": null,
"contentLocale": "en_US"
}
]Requests and billing
- Requests: 1 Web Access request per result page.
- Billing:
passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.