Skip to main content
POST
tiktok get_ad_interactive_analysis
Get ad interactive analysis Pricing — billed per successful call; the final charge scales by your plan multiplier. Charged only when the upstream response body code is 200.
Response structure is not yet fully documented — refer to the actual API response.

Example

Request contract

  • Method and path: POST /apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis
  • Runtime facts: 85ae03121f63417c9ff9d57a0fd59fdc6386fd71e2dc732a002843e6d8979d87
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.001
  • Cost contract: fixed_success
  • Published reference multiplier: 1.0
  • Settlement evidence source: request_snapshot

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
material_id
string
required

Ad material ID

Custom Cookie string, optional parameter, can be used to fetch more data

metric_type
string
default:remain

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
integer
default:180

Period type (days)

Usage: Time range, default 180 days

Response

Successful response. The outer object follows ResponseModel; the endpoint-specific payload is in data.

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

The media-type example is an illustrative response from the official documentation, not a live response. Its router and params metadata use upstream naming.

cache_message
string | null
default:This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again.

Cache message (EN-US)

cache_message_zh
string | null
default:本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。

Cache message (ZH-CN)

cache_url
string | null

The URL to access the cached result

code
integer
default:200

HTTP status code

data
any

Endpoint-specific response payload. The official shared model does not declare a fixed type or field set. Use the operation's documented return fields or response example; an operation-specific schema, when present, describes the documented fields. Undocumented fields must be read from the actual response rather than assumed.

docs
string | null

Link to the API Swagger documentation for this endpoint

message
string
default:Request successful. This request will incur a charge.

Response message (EN-US)

message_zh
string
default:请求成功,本次请求将被计费。

Response message (ZH-CN)

params
any
default:{}

The parameters used in the request

request_id
string | null

Unique request identifier

router
string
default:""

The endpoint that generated this response

support
string
default:Discord: https://discord.gg/aMEAS8Xsvz

Support message

time
string

The time the response was generated

time_stamp
integer

The timestamp the response was generated

time_zone
string
default:America/Los_Angeles

The timezone of the response time