{ "openapi": "3.0.1", "info": { "title": "TikTok Ad Intelligence & Creative Watcher", "description": "Track TikTok competitor ads, spot new Top Ads, and turn creative signals into AI-powered marketing insights and A/B test ideas.", "version": "0.0", "x-build-id": "WeghpzwbVcKyEa8em" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/marielise.dev~tiktok-creative-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-marielise.dev-tiktok-creative-watch", "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/marielise.dev~tiktok-creative-watch/runs": { "post": { "operationId": "runs-sync-marielise.dev-tiktok-creative-watch", "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/marielise.dev~tiktok-creative-watch/run-sync": { "post": { "operationId": "run-sync-marielise.dev-tiktok-creative-watch", "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": [ "searchUrls" ], "properties": { "searchUrls": { "title": "Creative Center URLs", "type": "array", "description": "Paste one or more TikTok Creative Center Top Ads result URLs. The 'period' parameter (7, 30 or 180 days) is honoured by TikTok; the market is set by the proxy country below, not by the URL. Each URL returns one page of up to 20 ads.", "items": { "type": "string" }, "default": [ "https://ads.tiktok.com/business/creativecenter/inspiration/topads/pc/en?period=30" ] }, "maxAdsPerSearch": { "title": "Maximum ads per search", "minimum": 1, "maximum": 500, "type": "integer", "description": "A safety cap for ads emitted from each URL. TikTok serves 20 ads per Top Ads page, so values above 20 have no effect unless you add more URLs.", "default": 20 }, "watchMode": { "title": "Watch mode", "type": "boolean", "description": "Save lightweight fingerprints in a named key-value store and label each returned ad as new, changed, or unchanged on later runs.", "default": true }, "includeUnchanged": { "title": "Include unchanged ads", "type": "boolean", "description": "When watch mode is on, include ads already seen without changes. Turn off to create an alerts-only dataset.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is required. TikTok picks the Top Ads market from the proxy exit IP, so set the proxy country to choose which country's ads you receive.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "analyzeCreative": { "title": "AI creative analysis", "type": "boolean", "description": "Use configured Gemini API key to turn each ad into hook, audience, offer and testing-hypothesis insights. Disable for raw collection only.", "default": true } } }, "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 } } } } } } } } } }