{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Reviews Scraper & Change Monitor (US)", "description": "Monitor TikTok Shop US review changes. Pass a previous run ID to receive only newly observed or edited reviews, with the fields that changed. Unchanged reviews have no result charge. First run collects a baseline. One product, up to 99 recent reviews per run.", "version": "0.3", "x-build-id": "EeeradLDs6wHF02lW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jy-labs~tiktok-shop-us-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jy-labs-tiktok-shop-us-reviews", "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/jy-labs~tiktok-shop-us-reviews/runs": { "post": { "operationId": "runs-sync-jy-labs-tiktok-shop-us-reviews", "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/jy-labs~tiktok-shop-us-reviews/run-sync": { "post": { "operationId": "run-sync-jy-labs-tiktok-shop-us-reviews", "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", "required": [ "productUrl" ], "properties": { "productUrl": { "title": "TikTok Shop US product URL", "pattern": "^https://shop\\.tiktok\\.com/us/pdp/[a-z0-9]+(?:-[a-z0-9]+)*/[0-9]{19}$", "type": "string", "description": "The US product whose reviews you want to collect or monitor. Use the plain product link with no query string. For change monitoring, keep the same product across runs." }, "maxReviews": { "title": "Recent reviews to check (1-99)", "minimum": 1, "maximum": 99, "type": "integer", "description": "Size of the recent-review window to check, default 30. A first run returns all reviews found in this window. A comparison returns only newly observed or edited reviews. Keep this number unchanged across the runs you compare. Reviews outside the window are not monitored.", "default": 30 }, "previousRunId": { "title": "Track changes - previous run ID (optional)", "pattern": "^[A-Za-z0-9]{17}$", "type": "string", "description": "Leave blank for your first collection. To get only newly observed or edited reviews, open an earlier successful run of this Actor, copy its run ID, and paste it here. Use the same account, product, and review limit. Changes identify the fields that changed; unchanged reviews are omitted. For repeated monitoring, pass each successful run's ID into the next run, even when it returned zero changes. Scheduling alone does not update this ID." }, "allowSourceOrderWarnings": { "title": "Allow source order warnings", "type": "boolean", "description": "By default the run stops if TikTok returns a review dated later than the one before it, because the newest-first promise was broken. Turn this on to receive those reviews anyway, flagged with sourceOrderWarning and counted in the run summary.", "default": false } } }, "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 } } }, "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 } } } } } } } } } }