/nykaa/products/reviews

POST /api/nykaa/products/reviews

Price: 20 credits

Get the reviews of a Nykaa product by id or URL, sorted and filtered by star rating, verified buyers or photos: title, text, rating, date, likes, author, shade bought and photos

How to use it

Find product ids with nykaa/products/search. Each sort and filter combination reaches up to 800 reviews; combine star filters to collect more of a heavily reviewed product.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Nykaa product id or product URL (examples: "353926", "https://www.nykaa.com/maybelline-new-york-color-sensational-creamy-matte-lipsticks/p/353926")
• sort string — Review order (default: "most_useful"; one of: "most_useful", "most_helpful", "newest", "positive_first", "negative_first")
• filter string — Which reviews to keep (default: "all"; one of: "all", "verified_buyers", "with_images", "stars_5", "stars_4", "stars_3", "stars_2", "stars_1")
• count integer required — Max number of reviews (min: 1; max: 800)

Response

• @type string (default: "NykaaReview")
• id string nullable
• product_id string nullable
• option_id string nullable
• text string nullable
• rating integer nullable
• created_at integer nullable
• like_count integer nullable
• author string nullable
• author_id string nullable
• author_image string nullable
• author_review_count integer nullable
• author_image_count integer nullable
• label string nullable
• is_verified_buyer boolean nullable
• is_pro_user boolean nullable
• author_traits array (default: [])
  • @type string (default: "NykaaReviewerTrait")
  • kind string nullable
  • name string nullable
  • values array (default: [])
• images array (default: [])
• tags array (default: [])

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 — Nykaa has no product under that 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.