TikTok Ads Get Ad Keyframe Analysis

2.07 credits/call
ae_tiktok_ads_get_ad_keyframe_analysis

Analyze audience retention in an ad video across different time points. Required: request_body.material_id, the ad material ID. Optional: request_body.metric, which defaults to retain_ctr and can be retain_cvr, click_cnt, convert_cnt, or play_retain_cnt; request_body.cookie can provide a custom cookie. The response provides keyframe analysis, including time points, corresponding retention rates, higher-drop-off points, and higher-interest points.

VideoSocial
2.07 credits/call

Pricing

2.07 credits/call
ConditionCharge
Each call2.07 credits/call

2.07 credits/call Charges are per query. A successful query is billed even if it returns no results.

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
request_bodyobjectYes用于广告视频关键帧分析的请求体对象,包含广告素材 ID(material_id)、分析指标(metric)和自定义 Cookie 字符串(cookie)。—
request_body.cookiestringNo自定义Cookie字符串(可选)—
request_body.metricstringNo分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)retain_ctr
request_body.material_idstringYes广告素材ID/Ad material ID—

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_tiktok_ads_get_ad_keyframe_analysis' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "request_body": {
      "material_id": "7185251306050420738",
      "metric": "play_retain_cnt"
    }
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "code": 200,
  "data": {
    "code": 0,
    "data": {
      "analysis": [
        {
          "second": 0,
          "value": 1
        }
      ],
      "duration": 17
    },
    "msg": "OK"
  },
  "docs": "https://api.tikhub.io/#/TikTok-Ads-API/get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_post",
  "message": "Request successful. This request will incur a charge."
}

This example shows part of the response. Copied content is valid JSON.