Documentation navigation

OpenAPI

TikTok ad detail

Read a creative. Media URLs may expire; missing metrics are null.

POST/v1/ads/tiktok/detail
Authentication
X-API-Key
Required scope
ads:tiktok:detail
Billing
Free
Rate limits
View your active rate limits

Parameters

Send this request as a JSON body.

ad_idstringRequired

Response

successbooleanRequired
dataobjectOptional
Show fields
idstringRequired
ad_titlestringOptional
urlstringOptional
coverstringOptional
country_codearrayOptional
Show fields

Schema details are unavailable for this endpoint.

objectivesarrayOptional
Show fields

Schema details are unavailable for this endpoint.

industry_enamestringOptional
material_format_enamestringOptional
likeintegerOptional
ctrnumberOptional

上游 CTR 指标;缺失为 null

costintegerOptional

预算等级,不代表实际金额

brand_namestringOptional
landing_page_urlstringOptional
errorobjectOptional

错误详情

Show fields
codeintegerRequired

业务错误码

messagestringRequired

可读错误信息

metaobjectOptional

响应元数据

Show fields
request_idstringOptional

请求唯一标识

Default: ""

pageintegerOptional

当前页码

sizeintegerOptional

每页数量

totalintegerOptional

总数

quota_remainingintegerOptional

剩余配额(-1 表示不限制)

Default: -1

service_levelstringOptional

本次请求的服务等级

langstringOptional

响应语言(cn/en),为空表示未翻译

platformstringOptional

本次请求的达人平台

recall_typestringOptional

召回类型:hybrid / vector / scalar

credits_consumedintegerOptional

本次请求扣减的积分数

Default: 0

credits_remainingintegerOptional

积分余额(-1 不限制)

Default: -1

billable_unitsintegerOptional

Server-calculated billable units for this response

Default: 0

0 ≤ billable_units ≤ ∞

skill_namestringOptional

调用方 skill 名称

skill_current_versionstringOptional

调用方 skill 当前版本

skill_latest_versionstringOptional

服务端声明的最新 skill 版本

skill_min_supported_versionstringOptional

服务端声明的最低支持版本

skill_update_availablebooleanOptional

是否存在可用 skill 更新

Default: false

skill_update_requiredbooleanOptional

是否要求更新 skill 后再继续使用

Default: false

skill_update_messagestringOptional

skill 更新提示文案

skill_update_manifest_urlstringOptional

skill 更新 manifest URL