TikTok API endpoint
Returns filter metadata for TikTok Creative Center Top Ads. Dynamic values come from TikTok; static UI enums are included for `order_by`, `duration`, `like`, and `ad_format`.
/tiktok/top-ads/filtersNotable response behavior:
ad_language, country, industry, objective, pattern_label, and period.order_by, duration, like, ad_format, and analysis_metric so clients can render every dashboard and detail analysis control.docs/tiktok-top-ads-enums.md, including the latest verified live snapshot for dynamic upstream values.| Field | Filled in, of 258 checked |
|---|---|
| id | 258 |
| value | 258 |
| label | 258 |
| parent_id | 237 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/tiktok/top-ads/filters" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"code": 0,
"msg": "OK",
"data": {
"country": [
{
"id": "US",
"value": "United States",
"label": "US"
}
],
"period": [
{
"id": 30,
"value": "Last 30 days",
"label": "thirty_day"
}
],
"order_by": [
{
"id": "for_you",
"value": "For you",
"label": "top_ads_for_you"
}
],
"duration": [
{
"id": "time-3",
"value": "10-20s",
"label": "10-20s"
}
],
"analysis_metric": [
{
"id": "retain_cvr",
"value": "CVR",
"label": "retain_cvr"
}
]
}
}
}Request schema
No body schema
Response schema
#/definitions/populartrend.topAdsFiltersResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | popularTrend.TopAdsFiltersResp | No | ||||
| data.code | integer | No | ||||
| data.data | object | No | Filter options available for top ads, grouped by filter name. | |||
| data.data.ad_format | array | No | ||||
| data.data.ad_format[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.ad_format[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.ad_format[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.ad_format[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.ad_format[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.ad_language | array | No | ||||
| data.data.ad_language[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.ad_language[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.ad_language[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.ad_language[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.ad_language[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.analysis_metric | array | No | ||||
| data.data.analysis_metric[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.analysis_metric[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.analysis_metric[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.analysis_metric[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.analysis_metric[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.country | array | No | ||||
| data.data.country[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.country[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.country[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.country[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.country[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.duration | array | No | ||||
| data.data.duration[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.duration[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.duration[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.duration[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.duration[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.industry | array | No | ||||
| data.data.industry[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.industry[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.industry[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.industry[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.industry[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.like | array | No | ||||
| data.data.like[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.like[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.like[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.like[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.like[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.objective | array | No | ||||
| data.data.objective[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.objective[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.objective[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.objective[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.objective[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.order_by | array | No | ||||
| data.data.order_by[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.order_by[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.order_by[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.order_by[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.order_by[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.pattern_label | array | No | ||||
| data.data.pattern_label[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.pattern_label[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.pattern_label[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.pattern_label[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.pattern_label[].value | string | No | Display value of the option, always returned as a string. | |||
| data.data.period | array | No | ||||
| data.data.period[].has_conversion | boolean | No | Whether the objective is one that tracks conversions. Only set on objective options. | |||
| data.data.period[].id | object | No | Filter option id in TikTok's own format, a string or a number depending on the filter. | |||
| data.data.period[].label | string | No | Label key TikTok uses for the option. | |||
| data.data.period[].parent_id | object | No | Id of the parent option, for example the top-level industry of a sub-industry. | |||
| data.data.period[].value | string | No | Display value of the option, always returned as a string. | |||
| data.msg | string | No | ||||
| data.request_id | string | No | Request id returned by TikTok Creative Center. | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 429 | Rate limit exceeded | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/tiktok/top-ads/filters" \
-H "x-api-key: $CRAWLORA_API_KEY"