{ "openapi": "3.0.1", "info": { "title": "TikTok Competitor Viral Outlier & Growth Monitor", "description": "Monitor competitor TikTok accounts and detect breakout videos, viral outliers, engagement spikes, follower growth, new hashtags, sounds, and profile changes.", "version": "1.0", "x-build-id": "jePhvEWMlYlMczvYf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herazur~tiktok-competitor-viral-outlier-growth-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herazur-tiktok-competitor-viral-outlier-growth-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/herazur~tiktok-competitor-viral-outlier-growth-monitor/runs": { "post": { "operationId": "runs-sync-herazur-tiktok-competitor-viral-outlier-growth-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/herazur~tiktok-competitor-viral-outlier-growth-monitor/run-sync": { "post": { "operationId": "run-sync-herazur-tiktok-competitor-viral-outlier-growth-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": [ "accounts" ], "properties": { "accounts": { "title": "TikTok accounts", "minItems": 1, "maxItems": 100, "type": "array", "description": "TikTok usernames or profile URLs. The optional name is the friendly account label used in output.", "items": { "type": "object", "required": [ "username" ], "properties": { "username": { "type": "string", "title": "Username or profile URL", "description": "A public TikTok handle, @handle, or full profile URL." }, "name": { "type": "string", "title": "Friendly name", "description": "Optional label shown in event output; it is not used as identity." } } }, "default": [ { "username": "nike", "name": "Nike" } ] }, "onlyChanges": { "title": "Only changes", "type": "boolean", "description": "Return only newly detected events. The first run establishes a baseline and normally emits zero rows.", "default": true }, "maxVideosPerAccount": { "title": "Maximum recent videos", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum recent public videos requested per account. TikTok's public embed may expose fewer.", "default": 30 }, "outlierMultiplier": { "title": "Viral threshold", "minimum": 1, "maximum": 100, "type": "number", "description": "Emit VIRAL_OUTLIER when views reach this multiple of the account's previous median.", "default": 2 }, "minimumViewsForOutlier": { "title": "Minimum views", "minimum": 0, "type": "integer", "description": "A video must have at least this many views before any relative view-outlier event is emitted.", "default": 1000 }, "baselineVideoCount": { "title": "Baseline video count", "minimum": 5, "maximum": 100, "type": "integer", "description": "Number of recent videos used for median performance. At least 5 valid videos are required.", "default": 20 }, "strongOutlierMultiplier": { "title": "Strong outlier threshold", "minimum": 2, "maximum": 100, "type": "number", "description": "View multiple used for the high-severity BREAKOUT_5X signal.", "default": 5 }, "detectFollowerGrowth": { "title": "Detect follower growth", "type": "boolean", "description": "Track follower deltas and emit a spike only after enough historical observations exist.", "default": true }, "detectHashtags": { "title": "Detect new hashtags", "type": "boolean", "description": "Emit a low-severity event when a new post uses a normalized hashtag not seen for the account.", "default": true }, "detectSounds": { "title": "Detect new sounds", "type": "boolean", "description": "Emit a low-severity event when a new post uses a previously unseen stable sound ID.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Apify Proxy can improve consistency in regions where TikTok public embeds are rate-limited." } } }, "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 } } } } } } } } } }