> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get](https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json) ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). --- # List TikTok Shop product reviews (https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get) ## Summary Returns customer reviews for a TikTok Shop product. Pass a public product page `url`, a `productId`, or both. Results are page-based; use `data.page.nextPage` as the `page` query parameter on the next request when `data.page.hasMore` is true. `data.lookupStatus` is `not_found` when the product cannot be resolved. **Tags:** `TikTok` ## HTTP - **Method:** GET - **Path:** `/v1/tiktok/products/reviews` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.tiktok.getProductReviews({ url?, productId?, region?, page? })` - **Accepted identifiers:** `url` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 1 credit charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `url` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Public TikTok Shop product detail page URL for the product whose reviews should be listed. ### `productId` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1 - **Description:** TikTok Shop product identifier. Provide this instead of `url` when you already know the product id. ### `region` (query) - **Required:** no - **Constraints:** type `string`; enum: US, GB, DE, FR, IT, ID, MY, MX, PH, SG, ES, TH, VN, BR, JP, IE - **Description:** Optional country or region code for the product review catalog. When omitted, the default catalog region applies. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1 - **Description:** 1-based review page number. Omit to request the first page. ## Behavior notes - **`region`**: Optional country or region code for the product review catalog. When omitted, the default catalog region applies. ## Responses (status codes) - **200**: Product reviews for the requested page. `lookupStatus` is `not_found` when the product cannot be resolved. - **400**: Invalid query parameters - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Product reviews for the requested page. `lookupStatus` is `not_found` when the product cannot be resolved. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the product could be resolved for this request. - **reviews** (required) — type `array`. Customer reviews for the product on this page. - _items:_ - **id** (required) — type `string`; minLength: 1. Stable id for the review when available. - **productId** (required) — type `string`; minLength: 1. TikTok Shop product id for this review. - **skuId** (required) — type `string`; minLength: 1; nullable. Sku id for the purchased variant, when available. - **rating** (required) — type `integer`; minimum: 1; maximum: 5. Star rating for the review (1-5). - **text** (required) — type `string`; nullable. Review body text, when available. - **createdAt** (required) — type `string`; minLength: 1; nullable. ISO-8601 timestamp for when the review was posted, when available. - **verifiedPurchase** (required) — type `boolean`; nullable. Whether the review is from a verified purchase, when available. - **incentivized** (required) — type `boolean`; nullable. Whether the review is marked as incentivized, when available. - **reviewer** (required) — type `object`. Reviewer display information. - **id** (required) — type `string`; minLength: 1; nullable. Reviewer id when available. - **name** (required) — type `string`; minLength: 1; nullable. Display name when available. - **avatarUrl** (required) — type `string`; minLength: 1; nullable. Profile image URL when available. - **media** (required) — type `object`. Media attached to a review. - **displayImageUrl** (required) — type `string`; minLength: 1; nullable. Primary image attached to the review, when available. - **imageUrls** (required) — type `array`. Additional image URLs for the review when available. - _items:_ - type `string`; minLength: 1 - **variant** (required) — type `string`; minLength: 1; nullable. Human-readable label for the purchased variant, when available. - **country** (required) — type `string`; minLength: 1; nullable. Country code associated with the review, when available. - **summary** (required) — type `object`. Summary statistics for the product review set. - **totalReviews** (required) — type `integer`; minimum: 0; nullable. Total number of reviews reported for the product, when available. - **averageRating** (required) — type `number`; minimum: 0; nullable. Average star rating, when available. - **ratingDistribution** (required) — type `object`. Breakdown of reviews by star rating, when available. - **oneStar** (required) — type `integer`; minimum: 0; nullable. Count of 1-star ratings, when available. - **twoStar** (required) — type `integer`; minimum: 0; nullable. Count of 2-star ratings, when available. - **threeStar** (required) — type `integer`; minimum: 0; nullable. Count of 3-star ratings, when available. - **fourStar** (required) — type `integer`; minimum: 0; nullable. Count of 4-star ratings, when available. - **fiveStar** (required) — type `integer`; minimum: 0; nullable. Count of 5-star ratings, when available. - **page** (required) — type `object`. Pagination information for the current response. - **currentPage** (required) — type `integer`; minimum: 1. 1-based page number for this response. - **nextPage** (required) — type `integer`; minimum: 1; nullable. Next page number to request when more pages are available; otherwise null. - **hasMore** (required) — type `boolean`. Whether another page of reviews is available. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "reviews": [ { "id": "7610144993492207374", "productId": "1731578642912612516", "skuId": null, "rating": 5, "text": "Works great for my cat.", "createdAt": "2025-12-25T10:00:00.000Z", "verifiedPurchase": true, "incentivized": false, "reviewer": { "id": "6952699155328861189", "name": "Emily", "avatarUrl": "https://p16.example.com/avatar.jpg" }, "media": { "displayImageUrl": null, "imageUrls": [] }, "variant": "Item: Default", "country": "US" } ], "summary": { "totalReviews": 808, "averageRating": 4.5, "ratingDistribution": { "oneStar": 10, "twoStar": 5, "threeStar": 8, "fourStar": 20, "fiveStar": 100 } }, "page": { "currentPage": 1, "nextPage": 2, "hasMore": true } }, "meta": { "requestId": "req_01example_tiktok_product_reviews", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (empty) ```json { "data": { "lookupStatus": "found", "reviews": [], "summary": { "totalReviews": 0, "averageRating": null, "ratingDistribution": { "oneStar": null, "twoStar": null, "threeStar": null, "fourStar": null, "fiveStar": null } }, "page": { "currentPage": 1, "nextPage": null, "hasMore": false } }, "meta": { "requestId": "req_01example_tiktok_product_reviews_empty", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (not_found) ```json { "data": { "lookupStatus": "not_found", "reviews": [], "summary": { "totalReviews": null, "averageRating": null, "ratingDistribution": { "oneStar": null, "twoStar": null, "threeStar": null, "fourStar": null, "fiveStar": null } }, "page": { "currentPage": 1, "nextPage": null, "hasMore": false } }, "meta": { "requestId": "req_01example_tiktok_product_reviews_not_found", "creditsCharged": 1, "version": "v1" } } ``` ### Example JSON (sparse) ```json { "data": { "lookupStatus": "found", "reviews": [ { "id": "7620000000000000001", "productId": "1731578642912612516", "skuId": null, "rating": 4, "text": "Good.", "createdAt": "2025-12-20T10:00:00.000Z", "verifiedPurchase": true, "incentivized": null, "reviewer": { "id": null, "name": "A**1", "avatarUrl": null }, "media": { "displayImageUrl": null, "imageUrls": [] }, "variant": "Item: Default", "country": "US" } ], "summary": { "totalReviews": 100, "averageRating": 4.4, "ratingDistribution": { "oneStar": 2, "twoStar": 1, "threeStar": 5, "fourStar": 10, "fiveStar": 20 } }, "page": { "currentPage": 2, "nextPage": 3, "hasMore": true } }, "meta": { "requestId": "req_01example_tiktok_product_reviews_sparse", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid query parameters **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.tiktok.getProductReviews(); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/tiktok/products/reviews", { headers: { "x-api-key": "YOUR_API_KEY", } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/tiktok/products/reviews" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/tiktok/products/reviews", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: optional query parameters First request illustrating common optional query flags (adjust values to your integration): ```javascript const url = "https://api.socialfetch.dev/v1/tiktok/products/reviews?region=US"; const response = await fetch(url, { headers: { "x-api-key": "YOUR_API_KEY" }, }); const data = await response.json(); ```