/tokopedia/products/rating

POST /api/tokopedia/products/rating

Price: 10 credits

Get the rating summary for a Tokopedia product by product URL (or shop/slug path): average score, review count, media-review count, buyer-satisfaction percentage, the per-star breakdown and review topics.

How to use it

Fetch the aggregated rating for a Tokopedia product by its page URL or shop/slug path. Returns one item with product_id, rating (average), review_count, review_with_media_count, satisfaction_percentage, breakdown (per-star rate/count/percentage) and topics (review keyword aggregates with counts).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Tokopedia product page URL, or the shop/slug path from it (examples: "https://www.tokopedia.com/basain-official/basain-casing-iphone-12-pro-soft-silicone-2-0-case-black", "basain-official/basain-casing-iphone-12-pro-soft-silicone-2-0-case-black"; minLength: 1)

Response

• @type string (default: "TokopediaProductRating")
• product_id string required
• rating number nullable
• review_count integer nullable
• review_with_media_count integer nullable
• satisfaction_percentage integer nullable
• breakdown array (default: [])
  • @type string (default: "TokopediaRatingBreakdown")
  • rate integer required
  • count integer nullable
  • percentage number nullable
• topics array (default: [])
  • @type string (default: "TokopediaReviewTopic")
  • name string required
  • key string nullable
  • rating 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 (well-formed but nonexistent product URL/slug) 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.