TikTok Ads Field Reference

Sample

 

https://connectors.windsor.ai/tiktok?api_key=[your API key]&date_preset=last_7d&fields=campaign,clicks,spend,impressions,date,source&_renderer=csv


Fields

IDTypeNameDescription
acTEXTACGroup by network
account_idTEXTAccount IDThe TikTok Ads account ID
account_nameTEXTAccount NameThe TikTok Ads account name
ad_group_idTEXTAd Group IDAd group ID
ad_group_nameTEXTAd Group NameAd group name
ad_idTEXTAd IDAd ID
ad_nameTEXTAd NameAd Name
ageTEXTAge RangeThe Age Range of the Audience
app_installNUMERICApp InstallThe number of times your mobile app was installed that were recorded as app events and attributed to your ads. (The total count is calculated based on the time each ad impression occurred.)
average_video_playNUMERICVideo Average Watch Time Per Video ViewThe average time your video was played per single video view, including any time spent replaying the video.
average_video_play_per_userNUMERICVideo Average Watch Time Per PersonThe average time your video was played per person, including any time spent replaying the video. This metric is estimated.
budget_optimize_switchTEXTBudget Optimize SwitchWhether Campaign Budget Optimization (CBO) is enabled
call_to_actionTEXTCall To ActionCall-to-action (CTA)
call_to_action_idTEXTCall To Action IDCall-to-action (CTA) ID
campaignTEXTCampaignThe Campaign Name
campaign_bid_typeTEXTCampaign Bid TypeBidding strategy on the campaign level.
campaign_budgetNUMERICCampaign BudgetCampaign budget
campaign_budget_typeTEXTCampaign Budget TypeCampaign budget type
campaign_creation_timeTEXTCampaign Creation TimeTime at which campaign was created
campaign_deep_bid_typeTEXTCampaign Deep Bid TypeBidding strategy for in-app events.
campaign_idTEXTCampaign IDThe Campaign ID
campaign_modify_timeTEXTCampaign Modify TimeTime at which campaign was modified
campaign_optimize_goalTEXTCampaign Optimize GoalOptimization goal. Returned only if Campaign Busget Optimization is enabled.
campaign_roas_bidTEXTROAS bidROAS goal for Value Optimization bid strategies (VO_*)
campaign_typeTEXTCampaign TypeCampaign objective
clicksNUMERICClicksThe Number of Clicks
commentsNUMERIClikesThe number of comments your video creative received within 1 day of a user seeing a paid ad.
complete_paymentNUMERICTotal Complete PaymentThe number of complete payment events.
conversion_ratePERCENTConversion RateThe number of conversions and divided by the number of total ad interactions that can be tracked to a conversion.
conversionsNUMERICConversionsThe number of times your ad achieved an outcome, based on the secondary goal you selected.
cost_per_app_installNUMERICCost per App InstallThe average cost for each app install event. (The total count is calculated based on the time each ad impression occurred.)
cost_per_conversionNUMERICCost per conversionThe cost (Spend) divided by the conversions your ad generates(Conversions)
cost_per_registrationNUMERICCost per Unique RegistrationThe average cost for each unique registration that is attributed to your ad. (The total count is calculated based on the time each ad impression occurred.)
cost_per_total_registrationNUMERICCost per RegistrationCost per Registration (The total count is based on when you were billed.)
countryCOUNTRYCountryThe Country of the Audience
cpcNUMERICCPCThe cost (Spend) divided by the clicks your ad receives(Clicks)
ctrPERCENTCTRThe number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
currencyTEXTCurrencyThe currency code, e.g. USD.
dateDATEDateThe Date
followsNUMERICFollowsThe number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Boosted TikToks.
genderTEXTGenderThe Gender of the Audience
impressionsNUMERICImpressionsThe Number of Impressions
is_automated_adTEXTIs Automated ADWhether the ad is automated.
languageTEXTLanguageThe Language of the Audience
likesNUMERIClikesThe number of likes your video creative received within 1 day of a user seeing a paid ad.
objectiveTEXTObjectiveCampaign type. Possible values: APP, LANDING_PAGE
objective_typeTEXTObjective TypeAdvertising objective
placementTEXTPlacementThe Placement Name
platformTEXTPlatformThe Operating System of the Audience
play_duration_2sNUMERIC2-Second Video ViewsThe number of times your video played for at least 2 seconds. Replays will not be counted.
play_duration_6sNUMERIC6-Second Video ViewsThe number of times your video played for at least 6 seconds, or completely played. Replays will not be counted.
play_first_quartileNUMERICVideo Views at 25%The number of times your video was played at 25% of its length. Replays will not be counted.
play_midpointNUMERICVideo Views at 50%The number of times your video was played at 50% of its length. Replays will not be counted.
play_overNUMERICVideo Views at 100%The number of times your video was played at 100% of its length. Replays will not be counted.
play_third_quartileNUMERICVideo Views at 75%The number of times your video was played at 75% of its length. Replays will not be counted.
reachNUMERICReachThe number of unique users who saw your ads at least once
real_time_app_installNUMERICReal-time App InstallThe number of times your mobile app was installed that were recorded as app events and attributed to your ads. (The total count is based on when the conversion actually happened.)
real_time_app_install_costNUMERICCost per Real-time App InstallThe average cost for each app install event. (The total count is based on when the conversion actually happened.)
registrationNUMERICUnique RegistrationThe number of unique registrations in your mobile app that were recorded as app events and attributed to your ads. (The total count is calculated based on the time each ad impression occurred.)
registration_rateNUMERICRegistration Rate (%)The percentage of unique registration events out of all app install events. (The total count is calculated based on the time each ad impression occurred.)
sharesNUMERICSharesThe number of shares your video creative received within 1 day of a user seeing a paid ad.
spendNUMERICspendThe Media Spend
total_checkoutNUMERICTotal CheckoutThe number of checkout events that are attributed to your ads.
total_checkout_valueNUMERICTotal Checkout ValueThe total value returned from all checkout events.
total_complete_payment_rateNUMERICTotal Complete Payment ValueThe total value returned from all Complete Payment events.
total_complete_tutorialNUMERICTotal Complete TutorialThe number of complete tutorial events that are attributed to your ads.
total_complete_tutorial_valueNUMERICTotal Complete Tutorial ValueTThe total value returned from all complete tutorial events.
total_create_groupNUMERICTotal Create GroupThe number of create group events that are attributed to your ads.
total_create_group_valueNUMERICTotal Create Group ValueThe total value returned from all create group events.
total_playNUMERICVideo ViewsThe number of times your video starts to play. Replays will not be counted.
total_registrationNUMERICTotal RegistrationTotal Registration. The total count is based on when you were billed.
totalcostNUMERICTotal CostThe Media Spend (Duplicate)