/joshin/products/reviews/summary

POST /api/joshin/products/reviews/summary

Price: 5 credits

Get the aggregate review picture of one Joshin (上新電機) product: average star rating, review count, how many reviews sit at each star level, the sliding scales averaged over all reviewers, who buys the product and what for, and the automatically written summary of what reviewers say.

How to use it

Fetch the review aggregates of one joshin (joshinweb.jp) product. Pass product (13-digit JAN code or a full product URL) together with review_group, both of which the search and ranking endpoints return for every product; a product paired with the wrong review_group looks unreviewed. Returns rating (average out of 5), review_count, rating_distribution (review_count and percent per star level), scales (name, low_label, high_label and the averaged position between them as a percentage), modes (the most common answer per question with its share) and summary_headline/summary_text, an automatically generated digest of the reviews. A product nobody has reviewed returns review_count 0 and empty collections.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — 13-digit JAN code of the product, or a full Joshin product URL (examples: "4973028506105", "https://joshinweb.jp/hobby/15302/4973028506105.html")
• review_group string required — Review group the product belongs to, as returned by the search endpoint (one of: "kaden", "hobby", "cg", "liquor", "outlet", "dp")

Response

• @type string (default: "JoshinProductReviewSummary")
• id string required
• review_group string required
• rating number nullable
• review_count integer nullable
• rating_distribution array (default: [])
  • @type string (default: "JoshinReviewRatingBucket")
  • rating integer required
  • review_count integer nullable
  • percent number nullable
• scales array (default: [])
  • @type string (default: "JoshinReviewScale")
  • name string required
  • low_label string nullable
  • high_label string nullable
  • position number nullable
• modes array (default: [])
  • @type string (default: "JoshinReviewMode")
  • name string required
  • answer string required
  • percent number nullable
• summary_headline string nullable
• summary_text string 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 — The entity was not found, or a precondition failed 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.