Schema Information - Tiktok Ads
Schema Information - Tiktok Ads
Tables/APIs
The following are the Tables or APIs associated with the Tiktok Ads connector.
Report Daily
Purpose: This API generates a comprehensive daily report on various metrics related to your TikTok Ads campaign.
Source API Documentation: TikTok API Documentation
Field
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
ad_id | NUMERIC |
ad_name | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | STRING |
campaign_dedicate_type | STRING |
app_promotion_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
ad_text | STRING |
call_to_action | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
reach | NUMERIC |
cost_per_1000_reached | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
secondary_goal_result | STRING |
cost_per_secondary_goal_result | STRING |
secondary_goal_result_rate | STRING |
frequency | NUMERIC |
currency | STRING |
is_aco | STRING |
is_smart_creative | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
average_video_play_per_user | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
engaged_view | NUMERIC |
engagements | NUMERIC |
engagement_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
clicks_on_music_disc | NUMERIC |
duet_clicks | NUMERIC |
stitch_clicks | NUMERIC |
sound_usage_clicks | NUMERIC |
anchor_clicks | NUMERIC |
anchor_click_rate | NUMERIC |
clicks_on_hashtag_challenge | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_page_viewrate_avg | NUMERIC |
ix_video_views | NUMERIC |
ix_video_views_p25 | NUMERIC |
ix_video_views_p50 | NUMERIC |
ix_video_views_p75 | NUMERIC |
ix_video_views_p100 | NUMERIC |
ix_average_video_play | NUMERIC |
interactive_add_on_impressions | NUMERIC |
interactive_add_on_destination_clicks | NUMERIC |
interactive_add_on_activity_clicks | NUMERIC |
interactive_add_on_option_a_clicks | NUMERIC |
interactive_add_on_option_b_clicks | NUMERIC |
countdown_sticker_recall_clicks | NUMERIC |
live_views | NUMERIC |
live_unique_views | NUMERIC |
live_effective_views | NUMERIC |
live_product_clicks | NUMERIC |
vta_app_install | NUMERIC |
cost_per_vta_app_install | NUMERIC |
vta_conversion | NUMERIC |
cost_per_vta_conversion | NUMERIC |
vta_registration | NUMERIC |
cost_per_vta_registration | NUMERIC |
vta_purchase | NUMERIC |
cost_per_vta_purchase | NUMERIC |
cta_app_install | NUMERIC |
cost_per_cta_app_install | NUMERIC |
cta_conversion | NUMERIC |
cost_per_cta_conversion | NUMERIC |
cta_registration | NUMERIC |
cost_per_cta_registration | NUMERIC |
cta_purchase | NUMERIC |
cost_per_cta_purchase | NUMERIC |
skan_result | NUMERIC |
skan_cost_per_result | NUMERIC |
skan_result_rate | NUMERIC |
skan_conversion | NUMERIC |
skan_cost_per_conversion | NUMERIC |
skan_conversion_rate | NUMERIC |
skan_conversion_rate_v2 | NUMERIC |
skan_click_time_conversion | NUMERIC |
skan_click_time_conversion_rate | NUMERIC |
skan_click_time_conversion_rate_v2 | NUMERIC |
skan_vta_conversion | NUMERIC |
skan_cost_per_vta_conversion | NUMERIC |
skan_vta_app_install | NUMERIC |
skan_cost_per_vta_app_install | NUMERIC |
skan_vta_registration | NUMERIC |
skan_cost_per_vta_registration | NUMERIC |
skan_vta_purchase | NUMERIC |
skan_cost_per_vta_purchase | NUMERIC |
skan_cta_conversion | NUMERIC |
skan_cost_per_cta_conversion | NUMERIC |
skan_cta_app_install | NUMERIC |
skan_cost_per_cta_app_install | NUMERIC |
skan_cta_registration | NUMERIC |
skan_cost_per_cta_registration | NUMERIC |
skan_cta_purchase | NUMERIC |
skan_cost_per_cta_purchase | NUMERIC |
Report Daily Age Gender
Purpose: Specifically focuses on providing daily campaign reports categorized by age and gender demographics.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
ad_id | NUMERIC |
ad_name | STRING |
country_code | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
campaign_dedicate_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | NUMERIC |
aeo_type | STRING |
ad_text | STRING |
call_to_action | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
mobile_app_id | STRING |
rf_campaign_type | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
currency | STRING |
is_smart_creative | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Report Daily Country
Purpose: Offers daily campaign reports segmented by the countries where the ad campaigns are running.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
ad_id | NUMERIC |
ad_name | STRING |
country_code | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
campaign_dedicate_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | NUMERIC |
aeo_type | STRING |
ad_text | STRING |
call_to_action | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
mobile_app_id | STRING |
rf_campaign_type | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
currency | STRING |
is_smart_creative | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Report Hourly
Purpose: Provides detailed reports on campaign performance at an hourly granularity, allowing for more precise analysis of time-specific trends.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
ad_id | NUMERIC |
ad_name | STRING |
stat_time_hour | DATETIME |
objective_type | STRING |
split_test | STRING |
campaign_budget | STRING |
campaign_dedicate_type | STRING |
app_promotion_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
ad_text | STRING |
call_to_action | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
reach | NUMERIC |
cost_per_1000_reached | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
secondary_goal_result | STRING |
cost_per_secondary_goal_result | STRING |
secondary_goal_result_rate | STRING |
frequency | NUMERIC |
currency | STRING |
is_aco | STRING |
is_smart_creative | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
average_video_play_per_user | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
engaged_view | NUMERIC |
engagements | NUMERIC |
engagement_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
clicks_on_music_disc | NUMERIC |
duet_clicks | NUMERIC |
stitch_clicks | NUMERIC |
sound_usage_clicks | NUMERIC |
anchor_clicks | NUMERIC |
anchor_click_rate | NUMERIC |
clicks_on_hashtag_challenge | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_page_viewrate_avg | NUMERIC |
ix_video_views | NUMERIC |
ix_video_views_p25 | NUMERIC |
ix_video_views_p50 | NUMERIC |
ix_video_views_p75 | NUMERIC |
ix_video_views_p100 | NUMERIC |
ix_average_video_play | NUMERIC |
interactive_add_on_impressions | NUMERIC |
interactive_add_on_destination_clicks | NUMERIC |
interactive_add_on_activity_clicks | NUMERIC |
interactive_add_on_option_a_clicks | NUMERIC |
interactive_add_on_option_b_clicks | NUMERIC |
countdown_sticker_recall_clicks | NUMERIC |
live_views | NUMERIC |
live_unique_views | NUMERIC |
live_effective_views | NUMERIC |
live_product_clicks | NUMERIC |
vta_app_install | NUMERIC |
cost_per_vta_app_install | NUMERIC |
vta_conversion | NUMERIC |
cost_per_vta_conversion | NUMERIC |
vta_registration | NUMERIC |
cost_per_vta_registration | NUMERIC |
vta_purchase | NUMERIC |
cost_per_vta_purchase | NUMERIC |
cta_app_install | NUMERIC |
cost_per_cta_app_install | NUMERIC |
cta_conversion | NUMERIC |
cost_per_cta_conversion | NUMERIC |
cta_registration | NUMERIC |
cost_per_cta_registration | NUMERIC |
cta_purchase | NUMERIC |
cost_per_cta_purchase | NUMERIC |
Adgroup Report Daily
Purpose: Focuses on generating daily reports specific to ad groups within your TikTok Ads campaign.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | STRING |
campaign_dedicate_type | STRING |
app_promotion_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
reach | NUMERIC |
cost_per_1000_reached | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
secondary_goal_result | STRING |
cost_per_secondary_goal_result | STRING |
secondary_goal_result_rate | STRING |
frequency | NUMERIC |
currency | STRING |
is_aco | STRING |
is_aco__1 | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
average_video_play_per_user | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
engaged_view | NUMERIC |
engagements | NUMERIC |
engagement_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
clicks_on_music_disc | NUMERIC |
duet_clicks | NUMERIC |
stitch_clicks | NUMERIC |
sound_usage_clicks | NUMERIC |
anchor_clicks | NUMERIC |
anchor_click_rate | NUMERIC |
clicks_on_hashtag_challenge | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_page_viewrate_avg | NUMERIC |
ix_video_views | NUMERIC |
ix_video_views_p25 | NUMERIC |
ix_video_views_p50 | NUMERIC |
ix_video_views_p75 | NUMERIC |
ix_video_views_p100 | NUMERIC |
ix_average_video_play | NUMERIC |
interactive_add_on_impressions | NUMERIC |
interactive_add_on_destination_clicks | NUMERIC |
interactive_add_on_activity_clicks | NUMERIC |
interactive_add_on_option_a_clicks | NUMERIC |
interactive_add_on_option_b_clicks | NUMERIC |
countdown_sticker_recall_clicks | NUMERIC |
live_views | NUMERIC |
live_unique_views | NUMERIC |
live_effective_views | NUMERIC |
live_product_clicks | NUMERIC |
vta_app_install | NUMERIC |
cost_per_vta_app_install | NUMERIC |
vta_conversion | NUMERIC |
cost_per_vta_conversion | NUMERIC |
vta_registration | NUMERIC |
cost_per_vta_registration | NUMERIC |
vta_purchase | NUMERIC |
cost_per_vta_purchase | NUMERIC |
cta_app_install | NUMERIC |
cost_per_cta_app_install | NUMERIC |
cta_conversion | NUMERIC |
cost_per_cta_conversion | NUMERIC |
cta_registration | NUMERIC |
cost_per_cta_registration | NUMERIC |
cta_purchase | NUMERIC |
cost_per_cta_purchase | NUMERIC |
skan_result | NUMERIC |
skan_cost_per_result | NUMERIC |
skan_result_rate | NUMERIC |
skan_conversion | NUMERIC |
skan_cost_per_conversion | NUMERIC |
skan_conversion_rate | NUMERIC |
skan_conversion_rate_v2 | NUMERIC |
skan_click_time_conversion | NUMERIC |
skan_click_time_conversion_rate | NUMERIC |
skan_click_time_conversion_rate_v2 | NUMERIC |
skan_vta_conversion | NUMERIC |
skan_cost_per_vta_conversion | NUMERIC |
skan_vta_app_install | NUMERIC |
skan_cost_per_vta_app_install | NUMERIC |
skan_vta_registration | NUMERIC |
skan_cost_per_vta_registration | NUMERIC |
skan_vta_purchase | NUMERIC |
skan_cost_per_vta_purchase | NUMERIC |
skan_cta_conversion | NUMERIC |
skan_cost_per_cta_conversion | NUMERIC |
skan_cta_app_install | NUMERIC |
skan_cost_per_cta_app_install | NUMERIC |
skan_cta_registration | NUMERIC |
skan_cost_per_cta_registration | NUMERIC |
skan_cta_purchase | NUMERIC |
skan_cost_per_cta_purchase | NUMERIC |
Adgroup Report Daily Age Gender
Purpose: Similar to the previous API but provides additional segmentation by age and gender for ad groups.
Source API Documentation: TikTok API Documentation
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
age | STRING |
gender | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
campaign_dedicate_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
mobile_app_id | STRING |
rf_campaign_type | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
currency | STRING |
is_aco | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Adgroup Report Daily Country
Purpose: Offers daily reports for ad groups, categorized by the countries in which the ads are being displayed.
Source API Documentation: TikTok API Documentation
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
country_code | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
campaign_dedicate_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
mobile_app_id | STRING |
rf_campaign_type | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
currency | STRING |
is_aco | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Adgroup Report Hourly
Purpose: Provides hourly insights specifically for ad groups, allowing for detailed tracking of performance over different times of the day.
Source API Documentation: TikTok API Documentation
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
adgroup_id | NUMERIC |
adgroup_name | STRING |
stat_time_hour | DATETIME |
objective_type | STRING |
split_test | STRING |
campaign_budget | STRING |
campaign_dedicate_type | STRING |
app_promotion_type | STRING |
placement_type | STRING |
promotion_type | STRING |
opt_status | STRING |
dpa_target_audience_type | STRING |
budget | NUMERIC |
optimization_preference | STRING |
billing_event | STRING |
bid_strategy | STRING |
bid | STRING |
aeo_type | STRING |
tt_app_id | STRING |
tt_app_name | STRING |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
reach | NUMERIC |
cost_per_1000_reached | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | NUMERIC |
cost_per_result | NUMERIC |
result_rate | NUMERIC |
real_time_result | NUMERIC |
real_time_cost_per_result | NUMERIC |
real_time_result_rate | NUMERIC |
secondary_goal_result | STRING |
cost_per_secondary_goal_result | STRING |
secondary_goal_result_rate | STRING |
frequency | NUMERIC |
currency | STRING |
is_aco | STRING |
is_aco__1 | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
average_video_play_per_user | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
engaged_view | NUMERIC |
engagements | NUMERIC |
engagement_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
clicks_on_music_disc | NUMERIC |
duet_clicks | NUMERIC |
stitch_clicks | NUMERIC |
sound_usage_clicks | NUMERIC |
anchor_clicks | NUMERIC |
anchor_click_rate | NUMERIC |
clicks_on_hashtag_challenge | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_page_viewrate_avg | NUMERIC |
ix_video_views | NUMERIC |
ix_video_views_p25 | NUMERIC |
ix_video_views_p50 | NUMERIC |
ix_video_views_p75 | NUMERIC |
ix_video_views_p100 | NUMERIC |
ix_average_video_play | NUMERIC |
interactive_add_on_impressions | NUMERIC |
interactive_add_on_destination_clicks | NUMERIC |
interactive_add_on_activity_clicks | NUMERIC |
interactive_add_on_option_a_clicks | NUMERIC |
interactive_add_on_option_b_clicks | NUMERIC |
countdown_sticker_recall_clicks | NUMERIC |
live_views | NUMERIC |
live_unique_views | NUMERIC |
live_effective_views | NUMERIC |
live_product_clicks | NUMERIC |
vta_app_install | NUMERIC |
cost_per_vta_app_install | NUMERIC |
vta_conversion | NUMERIC |
cost_per_vta_conversion | NUMERIC |
vta_registration | NUMERIC |
cost_per_vta_registration | NUMERIC |
vta_purchase | NUMERIC |
cost_per_vta_purchase | NUMERIC |
cta_app_install | NUMERIC |
cost_per_cta_app_install | NUMERIC |
cta_conversion | NUMERIC |
cost_per_cta_conversion | NUMERIC |
cta_registration | NUMERIC |
cost_per_cta_registration | NUMERIC |
cta_purchase | NUMERIC |
cost_per_cta_purchase | NUMERIC |
Campaign Report Daily
Purpose: Generates daily reports that give an overview of the entire campaign's performance.
Source API Documentation: TikTok API Documentation
Fields
Field Name | Data Type |
---|---|
real_time_cost_per_conversion | NUMERIC |
skan_cta_purchase | INTEGER |
anchor_clicks | INTEGER |
reach | INTEGER |
ix_average_video_play | NUMERIC |
video_views_p100 | INTEGER |
cost_per_vta_purchase | NUMERIC |
engaged_view | INTEGER |
ctr | NUMERIC |
ix_video_views_p25 | INTEGER |
skan_cost_per_cta_app_install | NUMERIC |
interactive_add_on_option_a_clicks | INTEGER |
live_views | INTEGER |
cta_purchase | INTEGER |
skan_cta_app_install | INTEGER |
skan_cost_per_conversion | NUMERIC |
split_test | STRING |
clicks_on_music_disc | INTEGER |
skan_conversion_rate | NUMERIC |
clicks_on_hashtag_challenge | INTEGER |
cta_app_install | INTEGER |
skan_vta_purchase | INTEGER |
video_views_p75 | INTEGER |
ix_page_viewrate_avg | NUMERIC |
ix_video_views_p100 | INTEGER |
interactive_add_on_destination_clicks | INTEGER |
skan_click_time_conversion_rate | NUMERIC |
secondary_goal_result_rate | STRING |
video_watched_2s | INTEGER |
real_time_conversion_rate | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_video_views_p50 | INTEGER |
objective_type | STRING |
shares | INTEGER |
stat_time_day | DATE |
skan_cost_per_vta_app_install | NUMERIC |
currency | STRING |
conversion_rate | NUMERIC |
cost_per_conversion | NUMERIC |
cost_per_cta_purchase | NUMERIC |
real_time_conversion | INTEGER |
interactive_add_on_activity_clicks | INTEGER |
skan_cost_per_vta_conversion | NUMERIC |
impressions | INTEGER |
skan_result_rate | STRING |
cost_per_cta_app_install | NUMERIC |
anchor_click_rate | NUMERIC |
cost_per_cta_conversion | NUMERIC |
duet_clicks | INTEGER |
sound_usage_clicks | INTEGER |
live_effective_views | INTEGER |
ix_video_views_p75 | INTEGER |
video_views_p25 | INTEGER |
cta_registration | INTEGER |
real_time_conversion_rate_v2 | NUMERIC |
secondary_goal_result | STRING |
vta_app_install | INTEGER |
skan_cta_conversion | INTEGER |
frequency | NUMERIC |
ix_video_views | INTEGER |
skan_cost_per_vta_registration | NUMERIC |
skan_click_time_conversion_rate_v2 | NUMERIC |
campaign_budget | STRING |
cpc | NUMERIC |
cost_per_vta_app_install | NUMERIC |
cost_per_cta_registration | NUMERIC |
skan_vta_app_install | INTEGER |
campaign_id | NUMERIC |
likes | INTEGER |
cpm | NUMERIC |
live_product_clicks | INTEGER |
countdown_sticker_recall_clicks | INTEGER |
skan_conversion_rate_v2 | NUMERIC |
skan_cta_registration | INTEGER |
cost_per_1000_reached | NUMERIC |
gross_impressions | INTEGER |
interactive_add_on_impressions | INTEGER |
skan_cost_per_cta_purchase | NUMERIC |
cta_conversion | INTEGER |
video_watched_6s | INTEGER |
cost_per_vta_conversion | NUMERIC |
average_video_play | NUMERIC |
vta_registration | INTEGER |
average_video_play_per_user | NUMERIC |
skan_cost_per_result | STRING |
skan_cost_per_cta_conversion | NUMERIC |
skan_cost_per_cta_registration | NUMERIC |
skan_click_time_conversion | INTEGER |
engagement_rate | NUMERIC |
skan_result | STRING |
campaign_dedicate_type | STRING |
campaign_name | STRING |
conversion_rate_v2 | NUMERIC |
spend | NUMERIC |
video_play_actions | INTEGER |
engagements | INTEGER |
stitch_clicks | INTEGER |
conversion | INTEGER |
interactive_add_on_option_b_clicks | INTEGER |
video_views_p50 | INTEGER |
comments | INTEGER |
vta_conversion | INTEGER |
live_unique_views | INTEGER |
skan_vta_conversion | INTEGER |
cost_per_vta_registration | NUMERIC |
skan_cost_per_vta_purchase | NUMERIC |
cost_per_secondary_goal_result | STRING |
skan_conversion | INTEGER |
vta_purchase | INTEGER |
skan_vta_registration | INTEGER |
app_promotion_type | STRING |
clicks | INTEGER |
Campaign Report Daily Age Gender
Purpose: Similar to the previous API but includes segmentation by age and gender for the entire campaign.
Source API Documentation: TikTok API Documentation
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
age | STRING |
gender | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | STRING |
cost_per_result | STRING |
result_rate | STRING |
real_time_result | STRING |
real_time_cost_per_result | STRING |
real_time_result_rate | STRING |
currency | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Campaign Report Daily Country
Purpose: Offers daily reports for the entire campaign, categorized by country.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
country_code | STRING |
stat_time_day | DATE |
objective_type | STRING |
split_test | STRING |
campaign_budget | NUMERIC |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
result | STRING |
cost_per_result | STRING |
result_rate | STRING |
real_time_result | STRING |
real_time_cost_per_result | STRING |
real_time_result_rate | STRING |
currency | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
profile_visits | NUMERIC |
profile_visits_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
follows | NUMERIC |
clicks_on_music_disc | NUMERIC |
Campaign Report Hourly
Purpose: Provide hourly insights for the entire campaign, allowing for a more granular analysis of performance throughout the day.
Source API Documentation: TikTok API Documentation.
Fields
Field Name | Data Type |
---|---|
campaign_id | NUMERIC |
campaign_name | STRING |
stat_time_hour | DATETIME |
objective_type | STRING |
split_test | STRING |
campaign_budget | STRING |
campaign_dedicate_type | STRING |
app_promotion_type | STRING |
spend | NUMERIC |
cpc | NUMERIC |
cpm | NUMERIC |
impressions | NUMERIC |
gross_impressions | NUMERIC |
clicks | NUMERIC |
ctr | NUMERIC |
reach | NUMERIC |
cost_per_1000_reached | NUMERIC |
conversion | NUMERIC |
cost_per_conversion | NUMERIC |
conversion_rate | NUMERIC |
conversion_rate_v2 | NUMERIC |
real_time_conversion | NUMERIC |
real_time_cost_per_conversion | NUMERIC |
real_time_conversion_rate | NUMERIC |
real_time_conversion_rate_v2 | NUMERIC |
secondary_goal_result | STRING |
cost_per_secondary_goal_result | STRING |
secondary_goal_result_rate | STRING |
frequency | NUMERIC |
currency | STRING |
video_play_actions | NUMERIC |
video_watched_2s | NUMERIC |
video_watched_6s | NUMERIC |
average_video_play | NUMERIC |
average_video_play_per_user | NUMERIC |
video_views_p25 | NUMERIC |
video_views_p50 | NUMERIC |
video_views_p75 | NUMERIC |
video_views_p100 | NUMERIC |
engaged_view | NUMERIC |
engagements | NUMERIC |
engagement_rate | NUMERIC |
likes | NUMERIC |
comments | NUMERIC |
shares | NUMERIC |
clicks_on_music_disc | NUMERIC |
duet_clicks | NUMERIC |
stitch_clicks | NUMERIC |
sound_usage_clicks | NUMERIC |
anchor_clicks | NUMERIC |
anchor_click_rate | NUMERIC |
clicks_on_hashtag_challenge | NUMERIC |
ix_page_duration_avg | NUMERIC |
ix_page_viewrate_avg | NUMERIC |
ix_video_views | NUMERIC |
ix_video_views_p25 | NUMERIC |
ix_video_views_p50 | NUMERIC |
ix_video_views_p75 | NUMERIC |
ix_video_views_p100 | NUMERIC |
ix_average_video_play | NUMERIC |
interactive_add_on_impressions | NUMERIC |
interactive_add_on_destination_clicks | NUMERIC |
interactive_add_on_activity_clicks | NUMERIC |
interactive_add_on_option_a_clicks | NUMERIC |
interactive_add_on_option_b_clicks | NUMERIC |
countdown_sticker_recall_clicks | NUMERIC |
live_views | NUMERIC |
live_unique_views | NUMERIC |
live_effective_views | NUMERIC |
live_product_clicks | NUMERIC |
vta_app_install | NUMERIC |
cost_per_vta_app_install | NUMERIC |
vta_conversion | NUMERIC |
cost_per_vta_conversion | NUMERIC |
vta_registration | NUMERIC |
cost_per_vta_registration | NUMERIC |
vta_purchase | NUMERIC |
cost_per_vta_purchase | NUMERIC |
cta_app_install | NUMERIC |
cost_per_cta_app_install | NUMERIC |
cta_conversion | NUMERIC |
cost_per_cta_conversion | NUMERIC |
cta_registration | NUMERIC |
cost_per_cta_registration | NUMERIC |
cta_purchase | NUMERIC |
cost_per_cta_purchase | NUMERIC |