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

IDTypeNameDescriptionReport
acTEXTacGroup by networkac
account_idTEXTAccount IDThe TikTok Ads account IDAccount
account_nameTEXTAccount NameThe TikTok Ads account nameAccount
ad_formatTEXTAd FormatThe ad format. Enum values: SINGLE_IMAGE, SINGLE_VIDEO, LIVE_CONTENT, CAROUSEL_ADS, CATALOG_CAROUSEL.
ad_group_budget_modeTEXTAd Group Budget modeAd Group budget mode. If Campaign Budget Optimization is enabled, BUDGET_MODE_INFINITE will be returned.
ad_group_idTEXTAd Group IDAd group IDAd
ad_group_nameTEXTAd Group NameAd group nameAd
ad_group_operation_statusTEXTAd group operation statusAd Group operation status. Enum values: ENABLE, DISABLE, FROZEN.
ad_group_placement_typeTEXTAd Group Placement typeThe placement strategy that decides where your ads will be shown. Enum values: PLACEMENT_TYPE_AUTOMATIC (Automatic placement), PLACEMENT_TYPE_NORMAL (Select placement).
ad_idTEXTAd IDAd IDAd
ad_nameTEXTAd NameAd NameAd
ad_operation_statusTEXTAd operation statusAd operation status. Enum values: ENABLE, DISABLE, FROZEN.Ad
ad_playable_urlTEXTAd Playable URLPlayable material URL. Only supported by the interactive Playable Ad type.
ad_statusTEXTAd Status (tiktok)Ad statusAd
ad_textTEXTAd titleSupported at Ad level.
adgroup_statusTEXTAdgroup StatusAdgroup status
aeo_typeTEXTApp Event Optimization TypeSupported at Ad Group and Ad level.
ageTEXTAge RangeThe Age Range of the AudiencePerformance
app_event_add_to_cartNUMERICUnique Add to Cart events (app)The number of unique times a user added items to a shopping cart 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.)Performance
app_event_add_to_cart_rateNUMERICAdd to Cart Rate (app) (%)The percentage of unique add to cart events out of all app install events. (The total count is calculated based on the time each ad impression occurred.)Performance
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.)Performance
app_promotion_typeTEXTApp Promotion TypeSupported at Campaign, Ad Group and Ad level. Possible values: APP_INSTALL or APP_RETARGETING if objective type is APP_PROMOTION, otherwise UNSET.
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.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.Video
bidTEXTBidSupported at Ad Group and Ad level.
bid_strategyTEXTBid strategySupported at Ad Group and Ad level.
billing_eventTEXTBilling EventSupported at Ad Group and Ad level.Example: `Clicks`, `Impression`.
budgetNUMERICAd group budgetSupported at Ad Group and Ad level.
budget_optimize_switchTEXTBudget Optimize SwitchWhether Campaign Budget Optimization (CBO) is enabledCampaign
button_clickNUMERICButton click eventsThe number of button click events.Performance
call_to_actionTEXTCall To ActionCall-to-action (CTA)Ad
call_to_action_idTEXTCall To Action ID (deprecated)Call-to-action (CTA) IDAd
campaignTEXTCampaignThe Campaign NameCampaign
campaign_bid_typeTEXTCampaign Bid TypeBidding strategy on the campaign level.Campaign
campaign_budgetNUMERICCampaign BudgetCampaign budgetCampaign
campaign_budget_modeTEXTCampaign Budget modeCampaign budget modeCampaign
campaign_budget_typeTEXTCampaign Budget Type (deprecated)Campaign budget typeCampaign
campaign_creation_timeTIMESTAMPCampaign Creation TimeTime at which campaign was createdCampaign
campaign_deep_bid_typeTEXTCampaign Deep Bid TypeBidding strategy for in-app events. Campaign
campaign_idTEXTCampaign IDThe Campaign IDCampaign
campaign_modify_timeTIMESTAMPCampaign Modify Time (deprecated)Time at which campaign was modifiedCampaign
campaign_nameTEXTCampaign NameThe Campaign Name
campaign_optimize_goalTEXTCampaign Optimize Goal (Deprecated)Campaign Optimization goal. Returned only if Campaign Budget Optimization is enabled. This field isn't supported anymore, use optimization_goal (Adgroup Optimization goal) instead.Campaign
campaign_roas_bidTEXTROAS bidROAS goal for Value Optimization bid strategies (VO_*)Campaign
campaign_statusTEXTCampaign StatusCampaign statusCampaign
campaign_typeTEXTCampaign TypeCampaign objectiveCampaign
clicksNUMERICClicksThe Number of ClicksPerformance
commentsNUMERICCommentsThe number of comments your video creative received within 1 day of a user seeing a paid ad.Performance
complete_paymentNUMERICTotal Complete PaymentPage Event Metric. The number of complete payment events.Performance
complete_payment_rateNUMERICUnique Payment Completion Rate (%)Page Event Metric. The percentage of complete payment events out of all click events.Performance
conversionNUMERICConversionThe number of times your ad achieved an outcome, based on the secondary goal you selected. (Duplicate)Performance
conversion_ratePERCENTConversion RateThe number of conversions and divided by the number of total ad interactions that can be tracked to a conversion.Performance
conversion_rate_v2NUMERICCVR (Impressions)The percentage of conversions from all impressions on your ads.(The total count is calculated based on the time each ad impression occurred.)
conversionsNUMERICConversionsThe number of times your ad achieved an outcome, based on the secondary goal you selected.Performance
cost_per_app_event_add_to_cartNUMERICCost per Add to Cart (app)The average cost for each unique add to cart event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.)Performance
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.)Performance
cost_per_complete_paymentNUMERICAverage Cost per Complete PaymentPage Event Metric. The average cost of each complete payment event.Performance
cost_per_conversionNUMERICCost per conversionThe cost (Spend) divided by the conversions your ad generates(Conversions)Performance
cost_per_create_groupNUMERICCost per Unique Create Group The average cost for each unique create group event that is attributed toyour ads. (The total count is calculated based on the time each ad impression occurred.)Performance
cost_per_offline_complete_registration_eventNUMERICCost per Complete Registration (Offline)The average cost of each offline complete registration event attributed to your TikTok ads.Performance
cost_per_onsite_initiate_checkout_countNUMERICCost per checkout initiated (Shop)The average cost per TikTok Shop initiate checkout action attributed to your ads.Performance
cost_per_onsite_on_web_cartNUMERICCost per add to cart (Shop)The average cost per TikTok Shop add-to-cart action attributed to your ads.Performance
cost_per_onsite_on_web_detailNUMERICCost per product page view (Shop)The average cost per TikTok Shop product details page view attributed to your ads.Performance
cost_per_onsite_shoppingNUMERICCost per purchase (Shop)The average cost per TikTok Shop purchase attributed to your ads.Performance
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.)Performance
cost_per_total_app_event_add_to_cartNUMERICTotal Cost per Add to Cart (app)Cost per Add to Cart (The total count is based on when you were billed.)Performance
cost_per_total_create_groupNUMERICCost per Create Group Cost per Create Group (The total count is based on when you were billed.) Performance
cost_per_total_registrationNUMERICCost per RegistrationCost per Registration (The total count is based on when you were billed.)Performance
cost_per_user_registrationNUMERICCost per Complete RegistrationnThe average cost of each user registration event.Performance
cost_per_web_event_add_to_cartNUMERICCost per Add to Cart (page)The average cost of each add to cart event.Performance
countryCOUNTRYCountryThe code of Country of the Audience
country_codeCOUNTRYCountry CodeCountry CodeAudience
cpcNUMERICCPCThe cost (Spend) divided by the clicks your ad receives(Clicks)Performance
create_groupNUMERICCost per Unique Create GroupThe average cost for each unique create group event that is attributed toyour ads. (The total count is calculated based on the time each adimpression occurred.) Performance
create_group_rateNUMERICCreate Group Rate (%) The percentage of unique create group events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) Performance
ctrPERCENTCTRThe number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).Performance
currencyTEXTCurrencyThe currency code, e.g. USD.Account
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThe DateTime
day_of_monthTEXTDay of monthDay of the month
dpa_target_audience_typeTEXTTarget audience type for DPAThe Audience that DPA products target
duet_clicksNUMERICDuet ClicksThe number of clicks on the 'Duet' button.
engagement_ratePERCENTEngagement RateThe percentage of times people saw your ad and performed a click (all).Performance
engagementsNUMERICEngagementsThe sum of all clickable interactions on your ads, including clicks led to advertiser-specified destinations and non-destination clicks from social actions and interactive experiences.Performance
focused_view_15sNUMERIC15-Second Focused Video ViewsThe number of times your video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. Note: This metric is on the allowlist. If you would like access to it, please reach out to your TikTok representative.Video
focused_view_6sNUMERIC6-Second Focused Video ViewsThe number of times your video has been played at least 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks.Video
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.Performance
formNUMERICForm submissionsThe number of form submission events.Performance
frequencyNUMERICFrequencyThe average number of times each person saw your ad.(Conversions)Performance
genderTEXTGenderThe Gender of the Audience
gross_impressionsNUMERICGross Impressions (Includes Invalid Impressions)The number of times an ad was seen on screen, including invalid impressions.
identity_idTEXTIdentity IDTikTok identity ID used for creating the ad. Only available at Ad level.Ad
identity_typeTEXTIdentity type (Spark Ads)Identity type. Enum values: CUSTOMIZED_USER, AUTH_CODE, TT_USER, BC_AUTH_TT. Any value except for CUSTOMIZED_USER indicatesthat the ad is a Spark Ad.Only available at Ad level.Ad
image_modeTEXTFormatSupported at Campaign, Ad Group and Ad level.
impressionsNUMERICImpressionsThe Number of ImpressionsPerformance
initiate_checkoutNUMERICTotal Initiate CheckoutPage Event Metric. The number of initiate checkout events.Performance
is_automated_adTEXTIs Automated ADWhether the ad is automated.Ad
is_smart_creativeBOOLEANIs Smart Creative ad.Whether the ad is a Smart Creative ad.Ad
item_idTEXTTikTok post IDThe ID of the TikTok post that is used as Spark Ad. Only available at Ad level.Ad
landing_page_urlTEXTLanding page URLAd Landing page URL.Ad
languageTEXTLanguageThe Language of the AudienceAudience
likesNUMERICLikesThe number of likes your video creative received within 1 day of a user seeing a paid ad.Performance
mobile_app_idTEXTMobile App IDSupported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App.
monthTEXTMonthNumber of the month
objectiveTEXTObjectiveCampaign type (application or landing page).Campaign
objective_typeTEXTObjective TypeCampaign Advertising objective. Possible values: CONVERSIONS, TRAFFIC, REACH, APP_PROMOTION, WEB_CONVERSIONS, TOPVIEW_REACH, RF_REACH, LEAD_GENERATION, ENGAGEMENT, PRODUCT_SALES, VIDEO_VIEWS, SHOP_PURCHASES.Campaign
offline_complete_registration_event_ratePERCENTComplete Registration Rate (Offline)The percentage of offline complete registration events out of all click events attributed to your TikTok ads.Performance
offline_complete_registration_eventsNUMERICTotal Complete Registration (Offline)The number of offline complete registration events attributed to your TikTok ads.Performance
offline_complete_registration_events_valueNUMERICTotal Complete Registration Value (Offline)The total value returned from offline complete registration events attributed to your TikTok ads.Performance
on_web_orderNUMERICTotal Place an OrderPage Event Metric. The number of place an order events.Performance
onsite_formNUMERICForm submission (onsite)The number of onsite form submissions attributed to your ads.Performance
onsite_initiate_checkout_countNUMERICCheckouts initiated (Shop)The number of TikTok Shop initiate checkout actions attributed to your ads, such as clicks on "Buy now" and "Buy with coupon" buttons on your product pages.Performance
onsite_initiate_checkout_count_rateNUMERICCheckout initiation rate (Shop)The percentage of TikTok Shop initiate checkout actions from clicks on your adsPerformance
onsite_on_web_cartNUMERICAdd to cart (Shop)The number of TikTok Shop add to cart actions attributed to your ads.Performance
onsite_on_web_cart_rateNUMERICAdd to cart rate (Shop)The average value of TikTok Shop add-to-cart actions attributed to your ads. Performance
onsite_on_web_detailNUMERICProduct page views (Shop)The number of TikTok Shop product details page views attributed to your ads. Performance
onsite_on_web_detail_rateNUMERICProduct page view rate (Shop)The percentage of TikTok Shop product details page views from clicks on your ads.Performance
onsite_shoppingNUMERICPurchases (Shop)The number of TikTok Shop order submission actions attributed to your ads.Performance
onsite_shopping_rateNUMERICPurchase rate (Shop)The percentage of TikTok Shop purchases from clicks on your ads.Performance
onsite_shopping_roasNUMERICROAS - return on ad spend (Shop)The return on ad spend (ROAS) from TikTok Shop gross revenue attributed to your ads.Performance
opt_statusTEXTAutomated creative optimizationAutomated creative optimization
optimization_goalTEXTAdgroup Optimization goalOptimization goal. Only available at Adgroup level and when Campaign Budget Optimization is enabled.
placementTEXTPlacementThe Placement Location (e.g. TikTok). Supported at Ad Group and Ad level.
placement_typeTEXTPlacement type (Duplicate of Placement)The Placement type
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.Video
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.Video
play_first_quartileNUMERICVideo Views at 25%The number of times your video was played at 25% of its length. Replays will not be counted.Video
play_midpointNUMERICVideo Views at 50%The number of times your video was played at 50% of its length. Replays will not be counted.Video
play_overNUMERICVideo Views at 100%The number of times your video was played at 100% of its length. Replays will not be counted.Video
play_third_quartileNUMERICVideo Views at 75%The number of times your video was played at 75% of its length. Replays will not be counted.Video
profile_image_urlIMAGE_URLProfile Image URLProfile Image URL used for ad.
promotion_typeTEXTPromotion type (Optimization location)Promotion type (Optimization location). It can be app, website, or others.
province_idTEXTProvince IDProvince IDAudience
province_nameTEXTProvince NameProvince NameAudience
purchaseNUMERICUnique Purchases (app)In-app event metric. The number of unique purchases event occurred in your app that were recorded by your measurement partner. (The total count is calculated based on the time each ad impression occurred.)Performance
purchase_rateNUMERICPurchase Rate (%)In-app event metric. The percentage of unique purchase event out of all the app install event. (The total count is calculated based on the time each ad impression occurred.)Performance
reachNUMERICReachThe number of unique users who saw your ads at least onceReach
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.)Performance
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.)Performance
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.)Performance
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.)Performance
resultsNUMERICResultsNumber of times your ad resulted in an intended outcome based on your campaign objective and optimization goal.Performance
sales_leadNUMERICUnique leads generated (app)The number of unique app generate lead actions attributed to your ads.Performance
schedule_end_timeTEXTSchedule end timeAd delivery end time (UTC+0).
schedule_start_timeTEXTSchedule start timeAd delivery start time (UTC+0).
sharesNUMERICSharesThe number of shares your video creative received within 1 day of a user seeing a paid ad.Performance
skan_app_installNUMERICApp Installs (SKAN)The number of times your mobile app was installed that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_checkoutNUMERICUnique Checkout events (SKAN)The number of unique times a user made a checkout in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_conversionNUMERICConversions (SKAN)Conversions (SKAN)Performance (SKAN)
skan_conversion_rateNUMERICCVR (SKAN)Conversion rate (SKAN)Performance (SKAN)
skan_cost_per_conversionNUMERICCPA (SKAN)Cost per conversion (SKAN)Performance (SKAN)
skan_cost_per_purchaseNUMERICCost per Unique Purchase (SKAN)The average cost of each unique purchase that is attributed to your ads.Performance (SKAN)
skan_cost_per_resultNUMERICCost per result (SKAN)Average cost per each result from your ads.Performance (SKAN)
skan_purchaseNUMERICUnique Purchase events (SKAN)The number of unique purchases event occurred in your app that were recorded by your measurement partner.Performance (SKAN)
skan_registrationNUMERICUnique Registration Events (SKAN)The number of unique registrations in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_result_rateNUMERICResult rate (SKAN)Percentage of results that happened out of all impressions on your ads.Performance (SKAN)
skan_resultsNUMERICResults (SKAN)Number of times your ad resulted in an intended outcome based on your campaign objective and optimization goal.Performance (SKAN)
skan_sales_leadNUMERICUnique generate lead (SKAN)The number of unique leads generated in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_add_to_cartNUMERICTotal Add to cart events (SKAN)The number of times a user added items to a shopping cart in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_checkoutNUMERICTotal Checkout events (SKAN)The number of times a user made a checkout in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_purchaseNUMERICTotal Purchase events (SKAN)The number of purchases in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_registrationNUMERICTotal Registration Events (SKAN)The number of registrations in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_sales_leadNUMERICTotal generate lead events (SKAN)The number of leads generated in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
skan_total_view_contentNUMERICTotal View content events (SKAN)The number of times a user viewed content in your mobile app that were recorded as app events and attributed to your ads.Performance (SKAN)
smart_targetTEXTOptimization goalSupported at Ad Group and Ad level.
sound_usage_clicksNUMERICSound Usage Clicks The number of clicks on the 'Use this sound' button.
sourceTEXTSourceThe name of the Windsor connector returning the row
spendNUMERICspendThe Media SpendPerformance
split_testTEXTSplit Test StatusSupported at Campaign, Ad Group and Ad level.
stitch_clicksNUMERICStitch ClicksThe number of clicks on the 'Stitch' button.
todayDATETodayToday's date
total_app_event_add_to_cartNUMERICTotal Add to Cart events (app)The number of app add to cart actions attributed to your ads.Performance
total_app_event_add_to_cart_valueNUMERICTotal Add to Cart Value (app)Total Add to Cart Value (The total count is based on when you were billed.)Performance
total_checkoutNUMERICTotal CheckoutIn-app event metric. Checkout (Total No.) (The total count is based on when you were billed.)Performance
total_checkout_valueNUMERICTotal Checkout ValueIn-app event metric. Total Checkout Value (The total count is based on when you were billed.)Performance
total_complete_payment_rateNUMERICTotal Complete Payment ValuePage Event Metric. The total value returned from all Complete Payment events.Performance
total_complete_tutorialNUMERICTotal Complete TutorialThe number of complete tutorial events that are attributed to your ads.Performance
total_complete_tutorial_valueNUMERICTotal Complete Tutorial ValueThe total value returned from all complete tutorial events.Performance
total_create_groupNUMERICTotal Create GroupThe number of create group events that are attributed to your ads.Performance
total_create_group_valueNUMERICTotal Create Group ValueThe total value returned from all create group events.Performance
total_initiate_checkout_valueNUMERICTotal Initiate Checkout ValuePage Event Metric. The total value returned from initiate checkout events.Performance
total_on_web_order_valueNUMERICTotal Place an Order ValuePage Event Metric. The total value returned from all Place an Order events.Performance
total_onsite_initiate_checkout_count_valueNUMERICCheckout initiation value (Shop)The total value of TikTok Shop initiate checkout actions attributed to your ads.Performance
total_onsite_on_web_cart_valueNUMERICAdd to cart value (Shop)The total value of TikTok Shop add-to-cart actions attributed to your ads.Performance
total_onsite_on_web_detail_valueNUMERICProduct page view value (Shop)The total value of TikTok Shop product details page views attributed to your ads.Performance
total_onsite_shopping_valueNUMERICGross revenue (Shop)The gross revenue of TikTok Shop orders attributed to your ads. It's the amount people pay, plus any discounts provided to them by TikTok Shop platform.Performance
total_playNUMERICVideo Views (TikTok)The number of times your video starts to play. Replays will not be counted.Video
total_purchaseNUMERICTotal Purchases (app)The number of app purchase actions attributed to your ads.Performance
total_purchase_valueNUMERICTotal Purchase value (app)The total value of app purchase actions attributed to your ads.Performance
total_registrationNUMERICTotal RegistrationTotal Registration. The total count is based on when you were billed.Performance
total_sales_leadNUMERICTotal leads generated (app)The number of app generate lead actions attributed to your ads.Performance
total_user_registration_valueNUMERICTotal Complete Registration ValueThe total value returned from user registration events.Performance
total_view_contentNUMERICTotal View Content eventsThe number of app view content actions attributed to your ads.Performance
total_web_event_add_to_cart_valueNUMERICTotal Add to Cart Value (page)The total value returned from add to cart events.Performance
totalcostNUMERICTotal CostThe Media Spend (Duplicate)Performance
tt_app_idTEXTTikTok App ID TikTok App ID, the App ID you used when creating an Ad Group. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App.
tt_app_nameTEXTTikTok App NameThe name of your TikTok App. Supported at Ad Group and Ad level. Returned if thepromotion type of one Ad Group is App.
user_registrationNUMERICTotal Complete RegistrationThe number of user registration events.Performance
user_registration_ratePERCENTComplete Registration Rate (%)The percentage of user registration events out of all click events.Performance
value_per_offline_complete_registration_eventNUMERICValue per Complete Registration (Offline)The average value returned from each offline complete registration event attributed to your TikTok ads.Performance
value_per_onsite_initiate_checkout_countNUMERICValue per checkout initiated (Shop)The average value of TikTok Shop initiate checkout actions attributed to your ads.Performance
value_per_onsite_on_web_detailNUMERICValue per product page view (Shop)The average value of TikTok Shop product details page views attributed to your ads.Performance
value_per_onsite_shoppingNUMERICAverage order value (Shop)The average order value per TikTok Shop purchase attributed to your ads.Performance
value_per_total_app_event_add_to_cartNUMERICValue per Add to Cart (app)Value per Add to Cart (The total count is based on when you were billed.)Performance
value_per_total_create_groupNUMERICValue per Create Group Value per Create Group (The total count is based on when you were billed.) Performance
value_per_user_registrationNUMERICValue per Complete RegistrationThe average value returned from user registration events.Performance
value_per_web_event_add_to_cartNUMERICValue per Add to Cart (page)The average value returned from add to cart events.Performance
video_idTEXTAd Video IDThe ad's video ID.Ad
video_thumbnail_urlIMAGE_URLVideo Thumbnail URLThumbnail image URL for the video of ad. Only available at Ad level.Ad
web_event_add_to_cartNUMERICUnique Add to Cart events (page)The number of add to cart events.Performance
web_event_add_to_cart_rateNUMERICAdd to Cart Rate (page) (%)The percentage of add to cart events out of all click events.Performance
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20