/v1/tiktok/shop/product/reviews
Product Reviews
Get a product's reviews
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
urlThe URL of the product (required if product_id is not provided) | query / optional |
|
product_idThe ID of the product (required if url is not provided) | query / optional |
|
regionProduct region. Only US is reliable; non-US regions may return limited or inconsistent reviews. | query / optional |
|
pageThe page number of the reviews | query / optional |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/tiktok/shop/product/reviews' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/tiktok/shop/product/reviews", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/tiktok/shop/product/reviews",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
has_morerequired
boolean
total_reviewsrequired
string
product_reviewsrequired
array
Array items
object
review_idrequired
string
product_idrequired
string
sku_idrequired
string
reviewer_idoptional
string
review_ratingrequired
integer
review_timerequired
string
is_verified_purchaserequired
boolean
is_incentivized_reviewrequired
boolean
product_namerequired
string
reviewer_namerequired
string
reviewer_avatar_urloptional
string
review_textrequired
string
display_image_urlrequired
string
review_imagesrequired
array
Array items
string
sku_specificationrequired
string
review_countryrequired
string
review_ratingsrequired
object
review_countrequired
string
overall_scorerequired
number
rating_resultrequired
object
1required
string
2required
string
3required
string
4required
string
5required
string