{ "openapi": "3.0.1", "info": { "title": "Tiktok Creative Center Scraper", "description": "Scrape TikTok Creative Center Top Ads and trends in one Actor. Search ads by brand or product keyword, extract ad analytics, keyframes, percentile benchmarks, and recommendations, or collect trending hashtags, hashtag analytics, and trending videos for creative and competitor research.", "version": "0.2", "x-build-id": "NzWDuCmiu52JND30f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doliz~tiktok-creative-center-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doliz-tiktok-creative-center-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/doliz~tiktok-creative-center-scraper/runs": { "post": { "operationId": "runs-sync-doliz-tiktok-creative-center-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/doliz~tiktok-creative-center-scraper/run-sync": { "post": { "operationId": "run-sync-doliz-tiktok-creative-center-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": { "target": { "title": "Target", "enum": [ "top_ads_dashboard", "top_ads_spotlight", "ad_analytics", "ad_keyframe", "ad_percentile", "ad_recommend", "trending_hashtags", "hashtag_analytics", "trending_videos" ], "type": "string", "description": "Select one of the currently supported data sources. Deprecated Creative Center targets are documented in the README but are no longer selectable.", "default": "top_ads_dashboard" }, "cookies": { "title": "Cookies", "type": "string", "description": "Your cookies. Way to obtain: ![](https://github.com/lofe-w/tiktok-creative-center-scraper-public/raw/main/imgs/get_cookie.png)" }, "dashboard_search": { "title": "Search", "type": "string", "description": "Search by brand or product keywords." }, "dashboard_region": { "title": "Region", "type": "array", "description": "Filter results by one or more regions currently shown in the Top Ads Dashboard. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/top_ads_dashboard_region.json)", "items": { "type": "string", "enum": [ "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", "VN" ], "enumTitles": [ "Argentina", "Australia", "Brazil", "Canada", "Colombia", "France", "Germany", "Indonesia", "Italy", "Japan", "Malaysia", "Mexico", "Netherlands", "Pakistan", "Philippines", "Romania", "Saudi Arabia", "Singapore", "South Africa", "South Korea", "Spain", "Sweden", "Thailand", "Turkey", "United Arab Emirates", "United Kingdom", "United States", "Vietnam" ] } }, "dashboard_industry": { "title": "Industry", "type": "array", "description": "Filter ads by one or more industries. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_industry.json)", "items": { "type": "string", "enum": [ "22000000000", "22102000000", "22101000000", "22107000000", "22108000000", "22109000000", "22106000000", "22999000000", "22112000000", "22105000000", "22113000000", "22110000000", "22111000000", "16000000000", "16105000000", "16104000000", "16101000000", "16102000000", "16999000000", "16100000000", "20000000000", "20101000000", "20110000000", "20104000000", "20106000000", "20109000000", "20107000000", "20102000000", "20105000000", "20999000000", "20111000000", "20103000000", "20100000000", "20108000000", "20112000000", "12000000000", "12104000000", "12108000000", "12100000000", "12102000000", "12110000000", "12105000000", "12107000000", "12109000000", "12103000000", "12999000000", "12101000000", "12106000000", "14000000000", "14105000000", "14104000000", "14107000000", "14106000000", "14101000000", "14100000000", "14999000000", "14103000000", "14102000000", "24000000000", "24108000000", "24118000000", "24105000000", "24103000000", "24104000000", "24109000000", "24114000000", "24107000000", "24120000000", "24119000000", "24116000000", "24117000000", "24111000000", "24106000000", "24112000000", "24101000000", "24999000000", "24113000000", "24100000000", "24102000000", "24110000000", "24115000000", "30000000000", "30100000000", "30102000000", "30101000000", "10000000000", "10100000000", "10102000000", "10105000000", "10106000000", "10999000000", "10103000000", "10101000000", "10104000000", "13000000000", "13100000000", "13108000000", "13117000000", "13115000000", "13116000000", "13112000000", "13107000000", "13104000000", "13102000000", "13110000000", "13111000000", "13109000000", "13999000000", "13105000000", "13113000000", "13101000000", "13114000000", "13103000000", "27000000000", "27103000000", "27104000000", "27100000000", "27101000000", "27102000000", "27999000000", "25000000000", "25301000000", "25302000000", "25300000000", "25313000000", "25303000000", "25999000000", "25311000000", "25304000000", "25305000000", "25306000000", "25307000000", "25308000000", "25309000000", "25310000000", "25312000000", "29000000000", "29102000000", "29101000000", "29100000000", "29103000000", "29999000000", "21000000000", "21102000000", "21101000000", "21103000000", "21104000000", "21100000000", "21999000000", "21105000000", "18000000000", "18106000000", "18110000000", "18104000000", "18101000000", "18102000000", "18105000000", "18108000000", "18109000000", "18999000000", "18112000000", "18100000000", "18103000000", "18107000000", "18111000000", "26000000000", "26114000000", "26112000000", "26102000000", "26113000000", "26108000000", "26104000000", "26105000000", "26111000000", "26999000000", "26101000000", "26106000000", "26107000000", "26109000000", "26103000000", "26100000000", "23000000000", "23113000000", "23114000000", "23122000000", "23102000000", "23126000000", "23108000000", "23105000000", "23111000000", "23116000000", "23104000000", "23128000000", "23107000000", "23124000000", "23125000000", "23127000000", "23115000000", "23106000000", "23109000000", "23110000000", "23100000000", "23119000000", "23999000000", "23129000000", "23101000000", "23118000000", "23130000000", "23131000000", "23103000000", "23134000000", "23123000000", "23132000000", "23133000000", "23112000000", "23117000000", "19000000000", "19999000000", "19103000000", "19101000000", "19102000000", "19105000000", "19106000000", "19104000000", "19100000000", "28000000000", "28100000000", "28101000000", "15000000000", "15100000000", "15105000000", "15103000000", "15101000000", "15102000000", "15104000000", "15106000000", "15107000000", "15999000000", "17000000000", "17103000000", "17999000000", "17105000000", "17106000000", "11000000000", "11111000000", "11110000000", "11101000000", "11103000000", "11102000000", "11100000000", "11107000000", "11112000000", "11104000000", "11108000000", "11106000000", "11999000000", "11105000000", "11109000000" ], "enumTitles": [ "Apparel & Accessories", "Bags", "Clothing Accessories", "High-end Jewelry", "Men's Clothing", "Men's Shoes", "Ordinary Jewelry", "Other Apparel & Accessories", "Traditional & Ceremonial Clothing", "Watches", "Wearable Tech Devices", "Women's Clothing", "Women's Shoes", "Appliances", "Digital Devices", "Home Appliances", "Kitchen & Bathroom Appliances", "Large Appliances", "Other Appliances", "Personal Care Appliances", "Apps", "Audio & Video Players", "Business & Productivity", "Education", "Financial Services", "Health & Fitness", "Life & Leisure", "News & Reading", "Online Shopping", "Other Apps", "Parenting", "Photography", "Social", "Travel", "Utilities", "Baby, Kids & Maternity", "Baby Bedding", "Baby Feeding Supplies", "Baby Food", "Baby Formula", "Baby Hygiene Products", "Baby Shoes", "Child Car Seats", "Children's Apparel", "Diapers & Baby Wipes", "Other Baby, Kids & Maternity", "Strollers & Cribs", "Toys for Kids", "Beauty & Personal Care", "Aesthetic Medicine", "Cosmetics", "Feminine Care", "Fragrances & Perfumes", "Haircare", "Oral Care", "Other Beauty & Personal Care", "Skincare", "Wig & Hair Styling", "Business Services", "Agriculture, Forestry, Animal Husbandry & Fishing", "Auction Services", "Chemical Materials", "Constructional Engineering", "Electronics & Electrical", "Energy Conservation & Environmental Protection", "Exhibition Services", "Franchising", "Individual Entrepreneurship", "Investment Planning & Management", "IT Services", "Legal Services", "Logistics", "Machinery & Equipment", "Marketing & Advertising", "Office Equipment & Supplies", "Other Business Services", "Professional Consultation", "Real Estate & Home Rentals", "Recruitment & Job Searching", "Safety & Security", "Service Outsourcing", "E-Commerce (Non-app)", "Big Box Retailers", "Large E-commerce Platforms", "Small & Medium-sized E-commerce Platforms", "Education", "Early Childhood & Preschool Education", "Higher Education", "Language Training", "Non-academic Training (Hobbies)", "Other Education", "Overseas Education", "Primary & Secondary Education & K-12", "Vocational Training", "Financial Services", "Commercial Banks", "Credit Bureaus", "Credit Cards", "Crowd Funding", "Cryptocurrencies", "Foreign Exchange Transactions", "Funds", "Guarantees", "Insurance", "Investment Advisory", "Loan Services", "Microfinance Companies", "Other Financial Services", "Pawn Shops", "Precious Metals", "Securities", "Third-Party Payments", "Trusts", "Food & Beverage", "Alcoholic Beverages", "Cooking & Recipes", "Cuisine", "Food & Fresh Produce", "Non-alcoholic Beverages", "Other Food & Beverage", "Games", "Action", "Casino", "Hyper-Casual", "Kids", "Match", "Other", "Party", "Puzzle", "Racing", "RPG", "Shooting", "Simulation", "Sports", "Strategy", "Tabletop", "Health", "Dietary Supplements", "Medical Information", "Medical Services", "Medicine", "Other Health", "Home Improvement", "Construction Materials & Lighting", "Furniture", "Hardware & Electrical", "Home Decor", "Interior Design & Decorating Services", "Other Home Improvement", "Power Strips & Socket", "Household Products", "Cleaning Appliances", "Cleaning Supplies", "Coffee Accessories", "Daily Essentials", "Glasses & Drinkware", "Kitchen Accessories", "Laundry", "Leather Care", "Other Household Products", "Pest Control", "Storage Products", "Tea Sets", "Tissues & Wet Wipes", "Toys", "Life Services", "Beauty & Personal Care", "Consumer Services", "Dating & Matchmaking Services", "Exercise & Fitness", "Gardening", "Gifts & Flowers", "Housekeeping", "Internet Services", "Other Life Services", "Photography", "Shopping Services", "Used Good Sales Platforms", "Utilities Payments", "Wedding Celebrations", "Wedding Photography", "News & Entertainment", "Anime", "Astrology", "Beauty & Personal Care", "Business & Economy", "Car Information", "Celebrities & Gossip", "Charity & Public Welfare", "Collectables & Antiques", "Culture & Art", "Culture & History", "E-commerce Information", "Environmental Protection", "Food & Cooking", "Games & Utility Software", "General Information", "Humor", "Law", "Lifestyle News", "Live Events", "Military", "Movies", "Other News & Entertainment", "Pet Information", "Politics", "Reading", "Real Estate Information", "Relationship Information", "Science & Technology", "Social Media Account Promotion", "Sports & Fitness", "Streaming Site", "Tourist Information", "TV Drama & Series", "TV Variety Shows", "Pets", "Other Pets", "Pet Grooming", "Pet Healthcare", "Pet Household Products", "Pet Toys", "Pet Travel Accessories", "Pet Treats", "Petfood", "Sports & Outdoor", "Outdoor Equipment", "Sports & Equipment", "Tech & Electronics", "Cell Phones", "Computer Accessories", "Computer Repair", "Computers", "Computers Components", "Gaming Devices", "Network Products", "Office Equipment", "Other Tech & Electronics", "Travel", "Hotels & Accommodation", "Other Travel", "Tours & Attractions", "Travel Agencies & Services", "Vehicle & Transportation", "Accessories for 2/3-Wheeled Vehicles", "Airplanes", "Auto Accessories", "Auto Parts", "Auto Services", "Automobiles", "Bicycles", "Car Dealerships", "Car Rentals", "Electric Scooters", "Motorcycles", "Other Vehicle & Transportation", "Used Cars", "Water Vehicles" ] } }, "dashboard_objective": { "title": "Objective", "type": "array", "description": "Filter ads by their campaign marketing objective. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_objective.json)", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "8", "15" ], "enumTitles": [ "Traffic", "App Installs", "Conversions", "Video Views", "Reach", "Lead Generation", "Product sales" ] } }, "dashboard_period": { "title": "Period", "enum": [ "7", "30", "180" ], "type": "string", "description": "Filter ads by their publication period. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_period.json)", "default": "7" }, "dashboard_ad_language": { "title": "Ad language", "type": "array", "description": "Filter ads by the language used in the creative. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_ad_language.json)", "items": { "type": "string", "enum": [ "en", "es", "ar", "vi", "th", "de", "id", "pt", "fr", "ms", "nl", "ja", "it", "ro", "zh-Hant", "ko" ], "enumTitles": [ "English", "Spanish", "Arabic", "Vietnamese", "Thai", "German", "Indonesian", "Portuguese", "French", "Malay", "Dutch", "Japanese", "Italian", "Romanian", "Chinese - Traditional", "Korean" ] } }, "dashboard_ad_format": { "title": "Ad format", "enum": [ "1", "2" ], "type": "string", "description": "Filter by ad format. 'Spark ads' use organic posts; 'Non-Spark ads' are traditional." }, "dashboard_likes": { "title": "Likes", "type": "array", "description": "Filter ads by the percentile range of likes received. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_likes.json)", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "Top 1~20%", "Top 21~40%", "Top 41~60%", "Top 61~80%", "Top 81~100%" ] } }, "dashboard_sort_by": { "title": "Sort by", "enum": [ "for_you", "impression", "ctr", "play_2s_rate", "play_6s_rate", "cvr", "like" ], "type": "string", "description": "Select the metric for sorting the ad results.", "default": "for_you" }, "dashboard_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number.", "default": 1 }, "dashboard_limit": { "title": "Limit", "minimum": 1, "maximum": 20, "type": "integer", "description": "Page size.", "default": 20 }, "spotlight_industry": { "title": "Industry", "type": "array", "description": "Filter ads by one or more industries for Spotlight. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/spotlight_industry.json)", "items": { "type": "string", "enum": [ "22000000000", "14000000000", "27000000000", "25000000000", "21000000000", "15000000000" ], "enumTitles": [ "Apparel & Accessories", "Beauty & Personal Care", "Food & Beverage", "Games", "Home Improvement", "Tech & Electronics" ] } }, "spotlight_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number.", "default": 1 }, "spotlight_limit": { "title": "Limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Page size.", "default": 50 }, "ad_analytics_material_id": { "title": "Material id", "type": "string", "description": "Material id. Obtain from the result of `Top Ads Dashboard` or `Top Ads Spotlight`", "default": "7558904828435202056" }, "ad_keyframe_material_id": { "title": "Material id", "type": "string", "description": "Material id. Obtain from the result of `Top Ads Dashboard` or `Top Ads Spotlight`", "default": "7558904828435202056" }, "ad_keyframe_metric": { "title": "Ad keyframe metric", "enum": [ "retain_ctr", "retain_cvr", "click_cnt", "convert_cnt", "play_retain_cnt" ], "type": "string", "description": "Select specific keyframe metric to retrieve. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/ad_keyframe_metric.json).", "default": "retain_ctr" }, "ad_percentile_material_id": { "title": "Material id", "type": "string", "description": "Material id. Obtain from the result of `Top Ads Dashboard` or `Top Ads Spotlight`", "default": "7558904828435202056" }, "ad_percentile_metric": { "title": "Ad percentile metric", "enum": [ "ctr_percentile", "time_attr_conversion_rate_percentile", "click_cnt_percentile", "time_attr_convert_cnt_percentile", "show_cnt_percentile" ], "type": "string", "description": "Select specific percentile metric to retrieve. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/ad_percentile_metric.json).", "default": "ctr_percentile" }, "ad_percentile_period": { "title": "Period", "enum": [ "7", "30", "180" ], "type": "string", "description": "Define the time frame for the percentile data.", "default": "180" }, "ad_recommend_material_id": { "title": "Material id", "type": "string", "description": "Material id. Obtain from the result of `Top Ads Dashboard` or `Top Ads Spotlight`", "default": "7558904828435202056" }, "ad_recommend_industry": { "title": "Industry", "enum": [ "22000000000", "22102000000", "22101000000", "22107000000", "22108000000", "22109000000", "22106000000", "22999000000", "22112000000", "22105000000", "22113000000", "22110000000", "22111000000", "16000000000", "16105000000", "16104000000", "16101000000", "16102000000", "16999000000", "16100000000", "20000000000", "20101000000", "20110000000", "20104000000", "20106000000", "20109000000", "20107000000", "20102000000", "20105000000", "20999000000", "20111000000", "20103000000", "20100000000", "20108000000", "20112000000", "12000000000", "12104000000", "12108000000", "12100000000", "12102000000", "12110000000", "12105000000", "12107000000", "12109000000", "12103000000", "12999000000", "12101000000", "12106000000", "14000000000", "14105000000", "14104000000", "14107000000", "14106000000", "14101000000", "14100000000", "14999000000", "14103000000", "14102000000", "24000000000", "24108000000", "24118000000", "24105000000", "24103000000", "24104000000", "24109000000", "24114000000", "24107000000", "24120000000", "24119000000", "24116000000", "24117000000", "24111000000", "24106000000", "24112000000", "24101000000", "24999000000", "24113000000", "24100000000", "24102000000", "24110000000", "24115000000", "30000000000", "30100000000", "30102000000", "30101000000", "10000000000", "10100000000", "10102000000", "10105000000", "10106000000", "10999000000", "10103000000", "10101000000", "10104000000", "13000000000", "13100000000", "13108000000", "13117000000", "13115000000", "13116000000", "13112000000", "13107000000", "13104000000", "13102000000", "13110000000", "13111000000", "13109000000", "13999000000", "13105000000", "13113000000", "13101000000", "13114000000", "13103000000", "27000000000", "27103000000", "27104000000", "27100000000", "27101000000", "27102000000", "27999000000", "25000000000", "25301000000", "25302000000", "25300000000", "25313000000", "25303000000", "25999000000", "25311000000", "25304000000", "25305000000", "25306000000", "25307000000", "25308000000", "25309000000", "25310000000", "25312000000", "29000000000", "29102000000", "29101000000", "29100000000", "29103000000", "29999000000", "21000000000", "21102000000", "21101000000", "21103000000", "21104000000", "21100000000", "21999000000", "21105000000", "18000000000", "18106000000", "18110000000", "18104000000", "18101000000", "18102000000", "18105000000", "18108000000", "18109000000", "18999000000", "18112000000", "18100000000", "18103000000", "18107000000", "18111000000", "26000000000", "26114000000", "26112000000", "26102000000", "26113000000", "26108000000", "26104000000", "26105000000", "26111000000", "26999000000", "26101000000", "26106000000", "26107000000", "26109000000", "26103000000", "26100000000", "23000000000", "23113000000", "23114000000", "23122000000", "23102000000", "23126000000", "23108000000", "23105000000", "23111000000", "23116000000", "23104000000", "23128000000", "23107000000", "23124000000", "23125000000", "23127000000", "23115000000", "23106000000", "23109000000", "23110000000", "23100000000", "23119000000", "23999000000", "23129000000", "23101000000", "23118000000", "23130000000", "23131000000", "23103000000", "23134000000", "23123000000", "23132000000", "23133000000", "23112000000", "23117000000", "19000000000", "19999000000", "19103000000", "19101000000", "19102000000", "19105000000", "19106000000", "19104000000", "19100000000", "28000000000", "28100000000", "28101000000", "15000000000", "15100000000", "15105000000", "15103000000", "15101000000", "15102000000", "15104000000", "15106000000", "15107000000", "15999000000", "17000000000", "17103000000", "17999000000", "17105000000", "17106000000", "11000000000", "11111000000", "11110000000", "11101000000", "11103000000", "11102000000", "11100000000", "11107000000", "11112000000", "11104000000", "11108000000", "11106000000", "11999000000", "11105000000", "11109000000" ], "type": "string", "description": "Industry for recommend ads. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_industry.json)", "default": "23116000000" }, "ad_recommend_country": { "title": "Country", "enum": [ "DZ", "AR", "AU", "AT", "AZ", "BH", "BD", "BY", "BE", "BO", "BR", "BG", "KH", "CA", "CL", "CO", "CR", "HR", "CY", "CZ", "DK", "DO", "EC", "EG", "EE", "FI", "FR", "DE", "GR", "GT", "JO", "HU", "ID", "IQ", "IE", "IL", "IT", "JP", "KZ", "KE", "KW", "LV", "LB", "MY", "MX", "MA", "NL", "NZ", "NG", "NO", "OM", "PK", "PA", "PY", "PE", "PH", "PL", "PT", "PR", "QA", "LT", "RO", "SA", "RS", "SG", "SK", "SI", "ZA", "KR", "ES", "LK", "SE", "CH", "TW", "TH", "TR", "AE", "GB", "US", "UY", "VN" ], "type": "string", "description": "Country for recommend ads. [Options](https://raw.githubusercontent.com/lofe-w/tiktok-creative-center-scraper-public/refs/heads/main/options/dashboard_region.json)", "default": "US" }, "hashtags_country": { "title": "Country", "enum": [ "US", "FR", "DE", "IT", "ES", "GB", "AR", "AU", "BR", "CA", "CO", "EG", "ID", "IL", "JP", "KR", "MY", "MX", "PH", "SA", "SG", "ZA", "TW", "TH", "TR", "AE", "VN" ], "type": "string", "description": "Country shown in the Hashtag trends page header.", "default": "US" }, "hashtags_period": { "title": "Time Period", "enum": [ "7", "30", "90" ], "type": "string", "description": "Time period shown in the Hashtag trends filter.", "default": "7" }, "hashtags_industry": { "title": "Industry", "enum": [ "", "10000000000", "11000000000", "12000000000", "14000000000", "15000000000", "17000000000", "18000000000", "19000000000", "21000000000", "22000000000", "23000000000", "25000000000", "27000000000", "28000000000", "29000000000" ], "type": "string", "description": "Industry filter shown on the Hashtag trends page. Choose All Industries to omit the industry filter.", "default": "" }, "hashtags_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number.", "default": 1 }, "hashtags_limit": { "title": "Limit", "minimum": 1, "maximum": 20, "type": "integer", "description": "Page size.", "default": 20 }, "hashtag_analytics_hashtag_id": { "title": "Hashtag ID", "type": "string", "description": "Hashtag ID from a `Trending Hashtags` result or from the official hashtag analytics page URL.", "default": "16149850" }, "hashtag_analytics_country": { "title": "Country", "enum": [ "US", "FR", "DE", "IT", "ES", "GB", "AR", "AU", "BR", "CA", "CO", "EG", "ID", "IL", "JP", "KR", "MY", "MX", "PH", "SA", "SG", "ZA", "TW", "TH", "TR", "AE", "VN" ], "type": "string", "description": "Country shown in the Hashtag analytics page header.", "default": "US" }, "hashtag_analytics_period": { "title": "Time Period", "enum": [ "7", "30", "90" ], "type": "string", "description": "Time period shown in the Hashtag analytics filter.", "default": "7" }, "videos_country": { "title": "Country", "enum": [ "US", "JP", "VN", "TH", "ID" ], "type": "string", "description": "Country shown on the current Trending Videos page.", "default": "US" }, "videos_period": { "title": "Period", "enum": [ "7", "30" ], "type": "string", "description": "Time period shown on the current Trending Videos page.", "default": "7" }, "videos_content_tags": { "title": "Video Content Tags", "type": "array", "description": "Filter by one or more current website content tags.", "items": { "type": "string", "enum": [ "11002", "11003", "11010", "11013", "11015" ], "enumTitles": [ "Beauty & Care", "Fashion", "Food & Beverage", "Lifestyle & Leisure", "Technology & Finance" ] }, "default": [] }, "videos_sort_by": { "title": "Sort By", "enum": [ "vv", "engagement", "six_seconds_vtr" ], "type": "string", "description": "Metric used to rank Trending Videos.", "default": "vv" }, "videos_page": { "title": "Page", "minimum": 1, "type": "integer", "description": "Page number. The Actor fetches only this page.", "default": 1 }, "videos_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Page size. TikTok currently accepts up to 100.", "default": 100 } } }, "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 } } } } } } } } } }