[中文]

用途:

获取广告的互动时间分析，了解观众在视频不同时间点的留存和互动情况

分析广告视频的吸引力曲线，找出最佳时长和关键互动点

优化广告内容结构，提高整体效果

参数:

material_id: 广告素材ID，必填参数

metric_type: 分析类型

ctr: 点击率分析

cvr: 转化率分析

clicks: 点击次数分析

conversion: 转化次数分析

remain: 留存率分析 (默认)

period_type: 时间范围，默认180天

返回内容说明:

interactive_data: 互动分析数据

time_series: 时间序列数据

time: 视频播放时间点（秒）

value: 对应的指标值（如留存率）

average_watch_time: 平均观看时长

completion_rate: 完播率

peak_interaction_time: 互动高峰时间点

示例响应:

{
  "code": 200,
  "router": "/api/v1/tiktok/ads/get_ad_interactive_analysis",
  "params": {
    "material_id": "7213258221116751874",
    "metric_type": "remain",
    "period_type": 180
  },
  "data": {
    "interactive_data": {
      "time_series": [
        {"time": 0, "value": 100},
        {"time": 1, "value": 95},
        {"time": 2, "value": 88}
      ],
      "average_watch_time": 8.5,
      "completion_rate": 65.2,
      "peak_interaction_time": 3
    }
  }
}

[English]

Purpose:

Get ad interactive time analysis to understand audience retention and engagement at different video time points

Analyze ad video attractiveness curve to find optimal duration and key interaction points

Optimize ad content structure to improve overall effectiveness

Parameters:

material_id: Ad material ID, required parameter

metric_type: Analysis type

ctr: Click-through rate analysis

cvr: Conversion rate analysis

clicks: Click count analysis

conversion: Conversion count analysis

remain: Retention rate analysis (default)

period_type: Time range, default 180 days

Return Description:

interactive_data: Interactive analysis data

time_series: Time series data

time: Video playback time point (seconds)

value: Corresponding metric value (e.g., retention rate)

average_watch_time: Average watch time

completion_rate: Completion rate

peak_interaction_time: Peak interaction time point

Example Response:

{
  "code": 200,
  "router": "/api/v1/tiktok/ads/get_ad_interactive_analysis",
  "params": {
    "material_id": "7213258221116751874",
    "metric_type": "remain",
    "period_type": 180
  },
  "data": {
    "interactive_data": {
      "time_series": [
        {"time": 0, "value": 100},
        {"time": 1, "value": 95},
        {"time": 2, "value": 88}
      ],
      "average_watch_time": 8.5,
      "completion_rate": 65.2,
      "peak_interaction_time": 3
    }
  }
}

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful Response

Body

Example

{
    "code": 200,
    "request_id": "string",
    "message": "Request successful. This request will incur a charge.",
    "message_zh": "请求成功，本次请求将被计费。",
    "support": "Discord: https://discord.gg/aMEAS8Xsvz",
    "time": "string",
    "time_stamp": 0,
    "time_zone": "America/Los_Angeles",
    "docs": "string",
    "cache_message": "string",
    "cache_message_zh": "string",
    "cache_url": "string",
    "router": "",
    "params": {},
    "data": null
}

🟠422Parameter Error

获取广告互动分析/Get ad interactive analysis

[中文]#

用途:#

参数:#

返回内容说明:#

示例响应:#

[English]#

Purpose:#

Parameters:#

Return Description:#

Example Response:#

Request