curl --request POST \
--url https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"material_id": "<string>"
}
'import requests
url = "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis"
payload = { "material_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({material_id: '<string>'})
};
fetch('https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'material_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis"
payload := strings.NewReader("{\n \"material_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"material_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"material_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"interactive_data": {
"average_watch_time": 8.5,
"completion_rate": 65.2,
"peak_interaction_time": 3,
"time_series": [
{
"time": 0,
"value": 100
},
{
"time": 1,
"value": 95
},
{
"time": 2,
"value": 88
}
]
}
},
"params": {
"material_id": "7213258221116751874",
"metric_type": "remain",
"period_type": 180
},
"router": "/api/v1/tiktok/ads/get_ad_interactive_analysis"
}tiktok get_ad_interactive_analysis
Get ad interactive analysis
curl --request POST \
--url https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"material_id": "<string>"
}
'import requests
url = "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis"
payload = { "material_id": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({material_id: '<string>'})
};
fetch('https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'material_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis"
payload := strings.NewReader("{\n \"material_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"material_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"material_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"interactive_data": {
"average_watch_time": 8.5,
"completion_rate": 65.2,
"peak_interaction_time": 3,
"time_series": [
{
"time": 0,
"value": 100
},
{
"time": 1,
"value": 95
},
{
"time": 2,
"value": 88
}
]
}
},
"params": {
"material_id": "7213258221116751874",
"metric_type": "remain",
"period_type": 180
},
"router": "/api/v1/tiktok/ads/get_ad_interactive_analysis"
}code is 200.
Example
curl -X POST "https://api.aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}' # see request schema below
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
{
"operationId": "post_tikhub_tiktok_ads_get_ad_interactive_analysis",
"method": "POST",
"path": "/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysis",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"cookie": {
"description": "Custom Cookie string, optional parameter, can be used to fetch more data",
"title": "Cookie",
"type": "string"
},
"material_id": {
"description": "Ad material ID",
"title": "Material Id",
"type": "string"
},
"metric_type": {
"default": "remain",
"description": "Analysis type\n - ctr: Click-through rate analysis\n - cvr: Conversion rate analysis\n - clicks: Click count analysis\n - conversion: Conversion count analysis\n - remain: Retention rate analysis (default)",
"title": "Metric Type",
"type": "string"
},
"period_type": {
"default": 180,
"description": "Period type (days)\n\nUsage: Time range, default 180 days",
"title": "Period Type",
"type": "integer"
}
},
"required": [
"material_id"
],
"title": "Body_get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_post",
"type": "object"
}
}
},
"required": true
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "fixed_success",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.001,
"estimate_source": "profile_seed",
"evidence_source": "request_snapshot"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Ad material ID
Custom Cookie string, optional parameter, can be used to fetch more data
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 (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 datatime_series: Time series datatime: Video playback time point (seconds)value: Corresponding metric value (e.g., retention rate)
average_watch_time: Average watch timecompletion_rate: Completion ratepeak_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 (EN-US)
Cache message (ZH-CN)
The URL to access the cached result
HTTP status code
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.
Link to the API Swagger documentation for this endpoint
Response message (EN-US)
Response message (ZH-CN)
The parameters used in the request
Unique request identifier
The endpoint that generated this response
Support message
The time the response was generated
The timestamp the response was generated
The timezone of the response time