/tiktok/creative_center/ads/search

POST /api/tiktok/creative_center/ads/search

Price: 5 credits

List TikTok Creative Center Top Ads (best-performing auction ads) with filters

How to use it

List TikTok Creative Center Top Ads — the best-performing auction ads on TikTok, filterable by country, time window, industry, objective, ad language, ad format, like percentile, and ranking metric. Each ad returns id, title, brand, industry, objective, ctr, like count, budget tier, and the creative video (cover image, playable url, duration, dimensions).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — Country/region to rank ads for (default: "US"; one of: "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")
• period string — Trailing time window (default: "30"; one of: "7", "30", "180")
• order_by string — Ranking metric (default: "for_you"; one of: "for_you", "impression", "ctr", "play_2s_rate", "play_6s_rate", "cvr", "like")
• industry array nullable — Filter by one or more industry ids from the Creative Center taxonomy
• objective array nullable — Filter by one or more advertising objectives (one of: "1", "2", "3", "4", "5", "8", "15")
• ad_language array nullable — Filter by one or more ad languages (one of: "en", "es", "ar", "vi", "th", "de", "id", "pt", "fr", "ms", "nl", "ja", "it", "ro", "zh-Hant", "ko")
• ad_format string nullable — Filter by ad format (one of: "1", "2")
• like string nullable — Filter by like-count percentile range (one of: "1", "2", "3", "4", "5")
• count integer required — Max number of ads to return (min: 1; max: 20)

Response

• @type string (default: "TikTokTopAd")
• id string required
• brand string nullable
• industry string nullable
• objective string nullable
• is_search boolean nullable
• ctr number nullable
• like_count integer nullable
• budget string nullable
• vid string nullable
• duration number nullable
• cover string nullable
• video_url string nullable
• width integer nullable
• height integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.