{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Monitor: Prices & Reviews", "description": "Check selected US TikTok Shop products for observed prices, public sold counters, ratings, reviews and availability evidence. Export JSON or CSV and build monitoring history in your own Google Sheets workflow.", "version": "0.1", "x-build-id": "047eucI42X4KtrTcn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexascout~tiktok-shop-product-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexascout-tiktok-shop-product-monitor", "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/nexascout~tiktok-shop-product-monitor/runs": { "post": { "operationId": "runs-sync-nexascout-tiktok-shop-product-monitor", "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/nexascout~tiktok-shop-product-monitor/run-sync": { "post": { "operationId": "run-sync-nexascout-tiktok-shop-product-monitor", "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": [ "schemaVersion", "region", "watchlist" ], "properties": { "schemaVersion": { "title": "Contract version", "enum": [ "1.0" ], "type": "string", "description": "Stable Google Sheets contract version.", "default": "1.0" }, "region": { "title": "Market", "enum": [ "US" ], "type": "string", "description": "Only the US market is supported.", "default": "US" }, "watchlist": { "title": "Product watchlist", "minItems": 1, "maxItems": 100, "type": "array", "description": "Paste 1–100 direct US product URLs as entries with unique, stable watchId values. Add skuId as a string only for a specific variant. Replace the example URLs with your products.", "items": { "type": "object", "additionalProperties": false, "required": [ "watchId", "url" ], "properties": { "watchId": { "type": "string", "minLength": 1, "maxLength": 128, "title": "Watch ID", "description": "Unique stable ID from your watchlist." }, "url": { "type": "string", "maxLength": 2048, "title": "Product URL", "description": "A direct US TikTok Shop PDP URL." }, "skuId": { "type": "string", "pattern": "^[0-9]{1,25}$", "title": "Variant ID", "description": "Optional exact variant ID, as a string." }, "label": { "type": "string", "maxLength": 256, "title": "Your label", "description": "Optional personal label." } } }, "default": [ { "watchId": "goli-001", "url": "https://shop.tiktok.com/us/pdp/goli-ashwagandha-gummies-with-vitamin-d-ksm-66-vegan-non-gmo/1729587769570529799", "label": "Goli gummies" }, { "watchId": "manspot-001", "url": "https://shop.tiktok.com/us/pdp/body-hair-trimmer-by-manspot-waterproof-ceramic-heads-ultra-smooth-shave/1730383241618035288", "label": "Manspot trimmer" } ] }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxy is the current collector baseline. Proxy and platform costs may apply even without usable data.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "maxConcurrency": { "title": "Parallel checks", "minimum": 1, "maximum": 2, "type": "integer", "description": "Use 1 with 1024 MB. For 2 parallel checks, allocate 2048 MB in run options.", "default": 1 }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 10, "maximum": 90, "type": "integer", "description": "Maximum duration of one source navigation, in seconds.", "default": 45 }, "maxAttemptsPerProduct": { "title": "Maximum attempts per target", "minimum": 1, "maximum": 3, "type": "integer", "description": "First attempt uses HTTP; subsequent attempts use a browser. No additional automatic source retries.", "default": 2 }, "includeRawData": { "title": "Save extra product details", "type": "boolean", "description": "Optional sanitized source details in separate DEBUG records. Off by default; never printed to the run log.", "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 }, "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 } } } } } } } } } }