{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Reviews Pro ⭐️", "description": "Extract TikTok Shop product reviews from product URLs, product IDs, or search-discovered products. Collect rating, review text, reviewer metadata, media flags, and product context for ecommerce intelligence.", "version": "3.1", "x-build-id": "KabTeJlkk5ohKrI5S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deepmine~tiktok-shop-reviews-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deepmine-tiktok-shop-reviews-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/deepmine~tiktok-shop-reviews-pro/runs": { "post": { "operationId": "runs-sync-deepmine-tiktok-shop-reviews-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/deepmine~tiktok-shop-reviews-pro/run-sync": { "post": { "operationId": "run-sync-deepmine-tiktok-shop-reviews-pro", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "productUrls": { "title": "🔗 Product URLs", "type": "array", "description": "TikTok Shop product links, one per line, as copied from the browser or app (shop.tiktok.com/us/pdp/… or tiktok.com/shop/pdp/…). US shop.", "items": { "type": "string" } }, "maxReviewsPerProduct": { "title": "💬 Max reviews per product", "minimum": 1, "maximum": 100000, "type": "integer", "description": "You pay per review, so this also caps the cost per product. Set 10000 for every review TikTok publishes.", "default": 100 }, "sortBy": { "title": "🔃 Review order", "enum": [ "most_recent", "recommended" ], "type": "string", "description": "Most recent first, or TikTok's recommended order (as on the product page).", "default": "most_recent" }, "queries": { "title": "🔍 Search keywords", "type": "array", "description": "Find products by keyword, e.g. \"office chair\", then collect each one's reviews. Use instead of, or with, the URLs above.", "items": { "type": "string" } }, "maxProductsPerQuery": { "title": "Max products per keyword", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Products taken from each keyword's search results, in TikTok Shop's order.", "default": 50 }, "productIds": { "title": "Product IDs", "type": "array", "description": "The long number at the end of a product URL, e.g. \"1731016350288417305\".", "items": { "type": "string" } }, "maxProductsTotal": { "title": "Max products per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Across URLs, IDs and keyword results.", "default": 50 }, "maxResults": { "title": "Max reviews per run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Optional cap on all reviews in the run. Empty = no run-wide cap." }, "includeRawReview": { "title": "Add TikTok's raw review object", "type": "boolean", "description": "Adds rawReview to each row. Large; the regular fields already cover it.", "default": false }, "outputFormat": { "title": "Field names", "enum": [ "clean", "v2" ], "type": "string", "description": "Keep Standard. Version 2 is only for integrations built on the old snake_case rows (no Products or Photo Reviews datasets).", "default": "clean" }, "includeRawProduct": { "title": "Version 2 only: add product context", "type": "boolean", "description": "Adds raw_product_context (product ID, name, seller, brand) to Version 2 rows.", "default": false }, "compactNullFields": { "title": "Version 2 only: omit empty fields", "type": "boolean", "description": "Standard rows always have every field, with null when TikTok has no value.", "default": true }, "allowPartialResults": { "title": "Succeed even if TikTok refuses every product", "type": "boolean", "description": "By default the run fails when TikTok refuses every product, so a block never looks like 'no reviews'. Products refused in a run that otherwise works are listed in OUTPUT.", "default": false }, "failOnZeroAfterRetries": { "title": "Fail if the run finds zero reviews", "type": "boolean", "description": "Also fail when the run ends with no reviews at all (e.g. only products without reviews).", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave as is: Apify Proxy, datacenter first. Requests TikTok refuses there are retried on US residential automatically, at no extra cost to you.", "default": { "useApifyProxy": true } }, "searchRegion": { "title": "Market", "type": "string", "description": "Only the US TikTok Shop is supported. US, us and United States all work.", "default": "US" }, "maxPagesPerQuery": { "title": "Max search pages per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum search result pages to read per keyword.", "default": 5 }, "maxConcurrency": { "title": "Products in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many products are collected at the same time. Each product uses its own IPs, so more in parallel is faster and costs the same.", "default": 5 }, "unionPasses": { "title": "Passes per product", "minimum": 1, "maximum": 10, "type": "integer", "description": "Extra passes on fresh IPs for products TikTok serves only partly. Complete products stop after one pass.", "default": 3 }, "maxSessionAttempts": { "title": "Fresh sessions per product", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many fresh sessions to try when TikTok refuses a product before any review is collected.", "default": 3 }, "maxFetchRetries": { "title": "Retries per request", "minimum": 1, "maximum": 8, "type": "integer", "description": "Retries for network errors, HTTP 429 and 5xx within a session. Values above 6 count as 6.", "default": 3 }, "requestTimeoutSec": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for one HTTP request.", "default": 30 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }