{ "openapi": "3.0.1", "info": { "title": "TikTok Creative Center Top Ads Scraper", "description": "Export TikTok's top-performing ads from the Creative Center by country, period, industry and objective: ad title, brand, CTR, likes, landing page and video URLs.", "version": "1.0", "x-build-id": "9o8ktGlC6bcj8LUIu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pulsedata~tiktok-creative-center-top-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pulsedata-tiktok-creative-center-top-ads-scraper", "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/pulsedata~tiktok-creative-center-top-ads-scraper/runs": { "post": { "operationId": "runs-sync-pulsedata-tiktok-creative-center-top-ads-scraper", "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/pulsedata~tiktok-creative-center-top-ads-scraper/run-sync": { "post": { "operationId": "run-sync-pulsedata-tiktok-creative-center-top-ads-scraper", "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": { "countries": { "title": "Countries", "type": "array", "description": "Countries whose top ads you want, as ISO codes (US, GB, DE) or names (Germany). The Creative Center covers AR, AU, BR, CA, CO, FR, DE, ID, IT, JP, MY, MX, NL, PK, PH, RO, SA, SG, ZA, KR, ES, SE, TH, TR, AE, GB, US and VN. Each country is scraped separately. Leave empty for all countries combined.", "items": { "type": "string" } }, "period": { "title": "Period", "enum": [ "7", "30", "180" ], "type": "string", "description": "Time window the Creative Center ranks ads over.", "default": "30" }, "sortBy": { "title": "Sort by", "enum": [ "for_you", "like", "ctr", "impression", "play_6s_rate" ], "type": "string", "description": "Ranking used for the first ads of each country. When you ask for more ads than one ranking shows, the actor also reads the other rankings and filter slices to find more distinct ads.", "default": "for_you" }, "industries": { "title": "Industries", "type": "array", "description": "Only ads from these industries, by name as shown in the Creative Center (\"Beauty & Personal Care\", \"Apps\", \"Skincare\") or by numeric industry ID. A top-level industry includes its sub-industries. Leave empty for all industries.", "items": { "type": "string" } }, "objectives": { "title": "Campaign objectives", "type": "array", "description": "Only ads with these campaign objectives: Traffic, App Installs, Conversions, Video Views, Reach, Lead Generation, Product Sales, App Promotion. Leave empty for all.", "items": { "type": "string" } }, "adLanguages": { "title": "Ad languages", "type": "array", "description": "Only ads in these languages, as codes (en, es, de, fr, pt, ja, ko, ar, vi, th, id, ms, nl, it, ro, zh-Hant) or English names. Leave empty for all.", "items": { "type": "string" } }, "maxAdsPerCountry": { "title": "Maximum ads per country", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many distinct ads per country. The Creative Center shows up to about 500 ads per country and period; how many exist depends on the country and filters.", "default": 100 }, "includeDetails": { "title": "Include landing page and engagement details", "type": "boolean", "description": "Open each ad's details to add the landing page URL, comments, shares, the countries the ad ran in and its source. Costs one extra request per ad and makes the run slower, not more expensive per ad.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy works for the Creative Center. Change it only if you see blocks.", "default": { "useApifyProxy": 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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }