{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Store Monitor Pro 💾", "description": "Monitor TikTok Shop seller stores and detect catalog changes across runs. Track matched products, price changes, additions, removals, and store-level snapshots for competitive ecommerce intelligence.", "version": "0.0", "x-build-id": "4bQFRQQBR1wcLd0gD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sentry~tiktok-shop-store-monitor-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sentry-tiktok-shop-store-monitor-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/sentry~tiktok-shop-store-monitor-pro/runs": { "post": { "operationId": "runs-sync-sentry-tiktok-shop-store-monitor-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/sentry~tiktok-shop-store-monitor-pro/run-sync": { "post": { "operationId": "run-sync-sentry-tiktok-shop-store-monitor-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", "required": [ "stores" ], "properties": { "stores": { "title": "Stores To Monitor", "type": "array", "description": "TikTok Shop store names or store URLs. The actor tracks matching products and detects catalog changes per store.", "items": { "type": "string" } }, "queries": { "title": "Optional Search Queries", "type": "array", "description": "Optional search terms used for discovery. If empty, each store name is used as its own query hint.", "items": { "type": "string" } }, "searchRegion": { "title": "Search Region", "type": "string", "description": "Region parameter sent to TikTok Shop search pages (for example: US, GB).", "default": "US" }, "maxPagesPerStore": { "title": "Max Pages Per Store", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of search-result pages scanned per store query path.", "default": 3 }, "maxProductsPerStore": { "title": "Max Products Per Store", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of unique matched products emitted per store in one run.", "default": 200 }, "maxQueriesPerStore": { "title": "Max Queries Per Store", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many query hints are used per store during a run.", "default": 2 }, "includeRawProduct": { "title": "Include Raw Product Payload", "type": "boolean", "description": "Include the full raw product object in each product row.", "default": true }, "compactNullFields": { "title": "Compact Null Fields", "type": "boolean", "description": "If true, null/undefined fields are omitted from output rows.", "default": true }, "enableSnapshotDiff": { "title": "Enable Snapshot Diff", "type": "boolean", "description": "Store per-store snapshots in key-value storage and detect additions/removals/price changes against the previous run.", "default": true }, "emitStoreSummary": { "title": "Emit Store Summary Rows", "type": "boolean", "description": "Push one store_summary row per monitored store.", "default": true }, "emitChangeRows": { "title": "Emit Change Rows", "type": "boolean", "description": "Push store_change rows for added/removed/price_changed products.", "default": true }, "maxChangeRowsPerStore": { "title": "Max Change Rows Per Store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety cap for emitted change rows per change type per store.", "default": 250 }, "snapshotKeyPrefix": { "title": "Snapshot Key Prefix", "type": "string", "description": "KVS key prefix used to store per-store snapshots.", "default": "STORE_MONITOR_SNAPSHOT" }, "stateStoreName": { "title": "State Store Name", "type": "string", "description": "Named key-value store used to persist snapshots across runs for change detection.", "default": "tiktok-shop-store-monitor-state" }, "requestTimeoutSec": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "HTTP request timeout for each page request.", "default": 30 }, "maxFetchRetries": { "title": "Max Fetch Retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many HTTP fetch attempts to try per page before giving up.", "default": 3 }, "queryRetryAttempts": { "title": "Full Query Retry Attempts", "minimum": 2, "maximum": 8, "type": "integer", "description": "How many full retries to run per store query when blocked/failure signals produce zero matched products.", "default": 3 }, "allowDirectRescueOnSoftBlock": { "title": "Allow Direct Rescue On Soft-Block", "type": "boolean", "description": "When proxy pages are soft-blocked, try one direct (no-proxy) fetch rescue before giving up that page.", "default": true }, "enableBrowserFallback": { "title": "Enable Browser Fallback On Block", "type": "boolean", "description": "If blocked/challenged and extraction is empty, try a lightweight Playwright fallback.", "default": false }, "browserFallbackWaitMs": { "title": "Browser Fallback Wait (ms)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "How long browser fallback waits after page load before reading HTML.", "default": 8000 }, "failOnZeroAfterRetries": { "title": "Fail Run If Zero After Retries", "type": "boolean", "description": "If true, fail run when all monitored stores return zero matched products after retries under blocked conditions.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Choose proxy type and settings (Apify Proxy residential/datacenter or custom proxies)." } } }, "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 } } } } } } } } } }