Skip to content
looot docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

Get TikTok ad keyframe analysis

TikHub tool tikhub-api-tiktok-ads-get-ad-keyframe-analysis on looot: input fields, $0.001 per call, output shape, and code to run it with curl, JavaScript or Python.

Returns TikTok keyframe analysis of ad videos to understand audience retention at different time points. Send material_id (Ad material ID); optional cookie, metric. Do not send a cookie; public data only.

  • Tool id: tikhub-api-tiktok-ads-get-ad-keyframe-analysis
  • Provider: TikHub
  • Job: Get ad keyframe analysis api tiktok ads (api.tiktok.ads.get-ad-keyframe-analysis)
  • Price: $0.001 per call. A call that fails at the provider costs $0.

Inputs

Name Type Required Description
cookie string no Custom cookie string (optional)
material_id string yes Ad material ID
metric string no Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)

Output

Shape of the run’s result, the expected shape, not yet checked against real answers:

{ code, data: { code }, docs, time, params: { material_id }, router, message, support, cache_url, time_zone, message_zh, request_id, time_stamp, cache_message, cache_message_zh }

Run it

Every call needs your API token in LOOOT_TOKEN; Sign in shows how to get one. Each run also needs a new idempotency key, so a retry never pays twice. With wait: 30 the answer comes back inline when the run ends within 30 seconds. Otherwise you get the running run back: poll GET /v1/runs/<runId>.

Example input with placeholder values:

curl -X POST "https://api.looot.ai/v1/runs" \
  -H "Authorization: Bearer $LOOOT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"endpointId":"tikhub-api-tiktok-ads-get-ad-keyframe-analysis","input":{"material_id":"<material_id>"},"wait":30}'
const response = await fetch("https://api.looot.ai/v1/runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LOOOT_TOKEN}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    endpointId: "tikhub-api-tiktok-ads-get-ad-keyframe-analysis",
    input: {
      material_id: "<material_id>",
    },
    wait: 30,
  }),
});
const run = await response.json();
console.log(run.status, run.result);
import os
import uuid

import requests

response = requests.post(
    "https://api.looot.ai/v1/runs",
    headers={
        "Authorization": f"Bearer {os.environ['LOOOT_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "endpointId": "tikhub-api-tiktok-ads-get-ad-keyframe-analysis",
        "input": {
            "material_id": "<material_id>",
        },
        "wait": 30,
    },
    timeout=90,
)
run = response.json()
print(run["status"], run.get("result"))

To let looot pick among every provider of this job instead, send job:api.tiktok.ads.get-ad-keyframe-analysis as endpointId; see the job page.

Was this page helpful?