/gog/products/reviews

POST /api/gog/products/reviews

Price: 10 credits

Get GOG product user reviews by product ID, store slug, or store URL

How to use it

Get user reviews of a GOG.com product by its numeric product ID, store slug, or store page URL. Returns each review's title, text, star rating, language, upvote and downvote counts, whether the reviewer is a verified owner, whether the review was edited, its creation date, and the reviewer (username, number of games owned, and number of reviews written). Use order to sort by newest, oldest, highest or lowest rating, or most voted.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — GOG product as a numeric product ID, a store slug, or a store URL (examples: "1207658924", "the_witcher", "https://www.gog.com/en/game/the_witcher"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)
• order string — Review sort order (default: "most_voted"; one of: "newest", "oldest", "rating_high", "rating_low", "most_voted")

Response

• @type string (default: "GogReview")
• id string required
• review_title string nullable
• text string nullable
• rating integer nullable
• language string nullable
• upvotes integer nullable
• downvotes integer nullable
• is_verified_owner boolean (default: false)
• is_edited boolean (default: false)
• created_at string nullable
• reviewer object nullable
  • @type string (default: "GogReviewer")
  • id string nullable
  • username string nullable
  • game_count integer nullable
  • review_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 — Product not found 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.