POST
/v1/squids/{squid_hash}Update Settings
Configure the TikTok Top Ads Scraper parametersConfigure the scraper parameters to control how TikTok ads are filtered and sorted. These settings determine region, industry, objective, and other filtering criteria.
Headers
| Key | Value | Required |
|---|---|---|
| Authorization | Token YOUR_API_KEY | Yes |
| Content-Type | application/json | Yes |
Scraper Parameters
region
Type:
string
Default:
World
Description:
Specify a predetermined region for your search (e.g., `United States`, `France`, `Germany`)
industry
Type:
string
Default:
All industries
Description:
Filter by industry (e.g., `Beauty & Personal Care`, `Games`, `E-Commerce (Non-app)`)
objective
Type:
string
Default:
All objectives
Description:
Campaign objective filter: `Conversions`, `Lead Generation`, `Traffic`, `Video Views`, etc.
like
Type:
string
Default:
All likes
Description:
Filter by engagement percentile: `Top 1~20%`, `Top 21~40%`, etc.
time_range
Type:
string
Default:
Last 7 days
Description:
Ad publication period: `Last 7 days`, `Last 30 days`, `Last 180 days`
sort_by
Type:
string
Default:
For You
Description:
Sorting option: `For You`, `Reach`, `CTY`, `2s Views Rate`, `6s Views Rate`
Pro Tip
Use `sort_by: Reach` to find ads with the highest audience reach for competitive analysis.
Pro Tip
Filter by `like: Top 1~20%` to see only the most engaging ads.
Note
Combining industry and objective filters helps narrow down ads most relevant to your use case.