{ "openapi": "3.0.1", "info": { "title": "TikTok Trending Videos Insights & Author Engagement", "description": "TikTok Trending Videos Insights & Author Engagement extracts trending videos, creator profiles, views, likes, comments, shares, hashtags, captions, and engagement metrics. Ideal for trend discovery, creator research, competitor analysis, and content performance insights.", "version": "0.1", "x-build-id": "gpi1mRD4A47GV1M2I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~tiktok-trending-videos-insights/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-tiktok-trending-videos-insights", "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/scrapio~tiktok-trending-videos-insights/runs": { "post": { "operationId": "runs-sync-scrapio-tiktok-trending-videos-insights", "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/scrapio~tiktok-trending-videos-insights/run-sync": { "post": { "operationId": "run-sync-scrapio-tiktok-trending-videos-insights", "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", "properties": { "countryCode": { "title": "🌍 Country Code", "type": "string", "description": "Two-letter country code for ad discovery (e.g. 'US', 'AU', 'GB', 'CA'). Default: 'US'.", "default": "US" }, "sortOrder": { "title": "📊 Ad Sort Order", "enum": [ "hot", "view", "like", "share", "comment" ], "type": "string", "description": "How to order the discovered ads. Options: 'hot', 'view', 'like', 'share', 'comment' (TikTok's Creative Center only exposes two real underlying orderings; values map onto those).", "default": "view" }, "period": { "title": "📅 Period (Days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Ad discovery lookback window in days (1-30). Default: 7.", "default": 7 }, "adUrls": { "title": "🔗 Direct Ad / Video URLs or IDs", "type": "array", "description": "Optional. Paste TikTok video URLs (e.g. https://www.tiktok.com/@user/video/7123456789012345678) or bare numeric video IDs to enrich directly, bypassing the Top Ads discovery list. Leave empty to discover ads via countryCode/sortOrder/period instead.", "default": [], "items": { "type": "string" } }, "videoLimit": { "title": "🎬 Video Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of ad videos to process (1-1000). Also accepts the base actor's original 'maxItems' key as a fallback (used only if videoLimit is left blank). Default when both are omitted: 100." }, "enrichEngagement": { "title": "📊 Enrich Real Engagement (likes/comments/shares/saves)", "type": "boolean", "description": "Fetch the ad video's public watch page and extract real diggCount/commentCount/shareCount/collectCount. Example: 20 ads in → typically only a fraction resolve to a public post (reported honestly in the log/status). Default: true.", "default": true }, "includeCreatorProfile": { "title": "👤 Include Creator / Author Profile", "type": "boolean", "description": "Also pull the real creator's uniqueId (handle), nickname, verified flag, bio (signature) and follower count from the same resolved watch page. Default: true.", "default": true }, "includeComments": { "title": "💬 Fetch Top-Level Comments", "type": "boolean", "description": "For every ad whose video resolves to a public post, also fetch up to maxCommentsPerAd top-level comments as extra child rows (type='comment', isChild=true) in the same dataset, plus a per-run mirror dataset. Default: false.", "default": false }, "maxCommentsPerAd": { "title": "🔢 Max Comments per Ad", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap on top-level comments fetched per resolved ad video (0-50). Example: maxCommentsPerAd=10 with 5 resolved ads -> up to 50 comment rows. Default: 10.", "default": 10 }, "proxyConfiguration": { "title": "⚙️ Proxy Configuration", "type": "object", "description": "Choose which proxies to use. If TikTok rejects the request, a residential proxy with a fresh IP is retried automatically." } } }, "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 } } } } } } } } } }