Skip to main content
GET
TikTok Ads Top
Beta catalog endpoint. Provider activation and live verification are in progress. An unavailable operation returns HTTP 503 and uses no credits.

Authorizations

x-api-key
string
header
required

Headers

Cache-Control
string
Idempotency-Key
string

Query Parameters

country
enum<string>
Available options:
US,
CA,
MX,
BR,
GB,
DE,
FR,
IT,
ES,
NL,
PL,
SE,
TR,
SA,
AE,
AU,
JP,
KR,
ID,
TH,
VN,
MY,
PH,
SG
period
enum<string>
Available options:
7,
30,
180
order_by
enum<string>
Available options:
for_you,
impression,
ctr,
play_2s_rate,
play_6s_rate,
cvr,
like
ad_format
enum<string>
Available options:
All ad types,
Spark ads,
Non-Spark ads
ad_language
enum<string>
Available options:
en,
ja,
zh,
vi,
th,
pt,
id
like_tier
enum<string>
Available options:
1,
2,
3,
4,
5
industry
string
keyword
string
limit
integer
Required range: 1 <= x <= 100
since
string
until
string

Response

Successful response. data is specific to this operation.

success
boolean
required
platform
string
required
endpoint
string
required
credits_used
integer
required
Required range: x >= 0
credits_remaining
integer | null
required
request_id
string
required
cached
boolean
required
data
object
required

Operation-specific data. Fields depend on the endpoint and upstream response; unavailable metrics may be null.