/chewy/products/reviews/summary

POST /api/chewy/products/reviews/summary

Price: 5 credits

Get the review summary of a Chewy product by id or URL: average rating, rating and written-review counts, the star histogram, the most-mentioned review keywords and the written summary of customer opinion

How to use it

rating_count counts every star rating while review_count counts written reviews only, so do not expect them to match. Pass a keyword to the Chewy reviews endpoint to read the reviews that mention it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Chewy product id or product page URL (examples: "52999", "https://www.chewy.com/multipet-lamb-chop-squeaky-plush-dog/dp/52999"; minLength: 1)

Response

• @type string (default: "ChewyReviewSummary")
• product_id string required
• product_part_number string nullable
• name string nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• rating_distribution array
  • @type string (default: "ChewyRatingBucket")
  • rating integer required
  • count integer nullable
  • percent number nullable
• keywords array
• summary string nullable
• question_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No Chewy product has this id Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.