{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Search Rank Tracker", "description": "Track public US TikTok Shop product positions by keyword, separate organic and sponsored ranks, flag target products, and compare snapshots.", "version": "0.1", "x-build-id": "SBkWG5zn6H9giiat7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~tiktok-shop-search-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-tiktok-shop-search-rank-tracker", "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/automation-lab~tiktok-shop-search-rank-tracker/runs": { "post": { "operationId": "runs-sync-automation-lab-tiktok-shop-search-rank-tracker", "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/automation-lab~tiktok-shop-search-rank-tracker/run-sync": { "post": { "operationId": "run-sync-automation-lab-tiktok-shop-search-rank-tracker", "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": [ "queries" ], "properties": { "queries": { "title": "Search keywords", "minItems": 1, "maxItems": 20, "type": "array", "description": "TikTok Shop product-search phrases to rank, processed in the supplied order.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "market": { "title": "Market", "enum": [ "US" ], "type": "string", "description": "Public TikTok Shop market used for ranking. US is currently the supported market.", "default": "US" }, "targetProducts": { "title": "Target product IDs or URLs", "type": "array", "description": "Optional TikTok Shop product IDs or public product URLs to flag with targetMatch in every query snapshot.", "default": [], "items": { "type": "string" } }, "previousRanks": { "title": "Previous rank snapshot", "type": "array", "description": "Optional prior ranks used to calculate movement. Provide query and productId plus absoluteRank and/or organicRank.", "items": { "type": "object", "required": [ "query", "productId" ], "properties": { "query": { "title": "Query", "type": "string", "description": "Keyword from the prior snapshot." }, "productId": { "title": "Product ID", "type": "string", "description": "TikTok Shop product ID." }, "absoluteRank": { "title": "Absolute rank", "type": "integer", "minimum": 1, "description": "Prior position including sponsored results." }, "organicRank": { "title": "Organic rank", "type": "integer", "minimum": 1, "description": "Prior non-sponsored position; omit for a sponsored row." } } }, "default": [] }, "maxResultsPerQuery": { "title": "Maximum results per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum ordered product rows captured for each keyword.", "default": 20 }, "maxSessionRetries": { "title": "Session retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "Maximum fresh browser/proxy sessions tried per keyword when TikTok returns a challenge or empty shell.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Cloud runs default to US residential proxy sessions because TikTok Shop blocks ordinary datacenter routes.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }