Find the fields you need for your next report.
717 fields
| Field | Details |
|---|---|
2-Second Video Views The number of times your video played for at least 2 seconds. Replays will not be counted. | Field IDvideo_watched_2s |
6-Second Video Views The number of times your video played for at least 6 seconds, or completely played. Replays will not be counted. | Field IDvideo_watched_6s |
10-second LIVE views Number of times your LIVE was viewed for at least 10 seconds from an ad. Revisits are counted. | Field IDlive_effective_views |
15-second views (Focused view) The 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. | Field IDengaged_view_15s |
Account available balance Get the Account available balance(The unit is related to the advertiser's currency type currency). | Field IDadvertiser/balance |
Achieve Level (Total No.) Achieve Level (Total No.) (The total count is based on when you were billed.) | Field IDtotal_achieve_level |
Achieve Level Rate (%) The percentage of unique achieve level events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDachieve_level_rate |
Achieve Level Rate (%) (SKAN) The percentage of unique achieve level events out of all app install events. | Field IDskan_achieve_level_rate |
Ad delivery arrangement Ad delivery arrangement, in the format of a string that consists of 48 x 7 characters. Each character is mapped to a 30-minute timeframe from Monday to Sunday. Each character can be set to either 0 or 1. 1 represents delivery in the 30-minute timeframe, and 0 stands for non-delivery in the 30-minute timeframe. The first character is mapped to 0:01-0:30 of Monday; The second character is mapped to 0:31-1:00 of Monday, and the last character represents 23:31-0:00 Sunday.
Note
Not specified, all-0, or all-1 are considered as full-time delivery. | Field IDad_group/dayparting |
Ad delivery end time Get the Ad delivery end time (UTC+0). Format should be YYYY-MM-DD HH:MM:SS. | Field IDad_group/schedule_end_time |
Ad delivery start time Get the Ad delivery start time (UTC+0). Format should be YYYY-MM-DD HH:MM:SS. | Field IDad_group/schedule_start_time |
Ad group frequency cap Get the frequency, together with frequency_schedule, controls how often people see your ad (only available for REACH ads). For example, frequency = 2 frequency_schedule = 3 means "show ads no more than twice every 3 day". | Field IDad_group/frequency |
Ad group ID Get the Ad group ID. | Field IDad_group/adgroup_id |
Ad group Name Get the Ad group Name. | Field IDad_group/adgroup_name |
Ad group status Get the Ad group status. | Field IDad_group/status |
Ad ID Get the Ad ID. | Field IDad/ad_id |
Ad Is a new structure Whether the campaign is a new structure (for the same campaign, the structure of campaign, adgroups and ads are the same). | Field IDad/is_new_structure |
Ad Name Get the Ad Name. | Field IDad/ad_name |
Ad Operation status Get the Operation vstatus, optional values include: DISABLE (the ad is disabled), ENABLE (the ad is enabled), FROZEN (the ad is terminated and cannot be enabled). | Field IDad/opt_status |
Ad status Get the Ad status. | Field IDad/status |
Ad Text Get the ad text. It is shown to your audience as part of your ad creative, to deliver the message you intend to communicate to them. Keyword match type is exact match.. | Field IDad/ad_text |
ad_group/budget_mode Get the . | Field IDad_group/budget_mode |
Add Payment Info Rate (%) The percentage of unique add payment info events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDadd_payment_info_rate |
Add payment info value (website) The total value returned from add billing events. | Field IDtotal_add_billing_value |
Add to cart (Shop) The number of TikTok Shop add to cart actions attributed to your ads. Add-to-cart is reported based on the time each ad impression occurred. | Field IDonsite_on_web_cart |
Add to Cart (Website) The number of add to cart events. | Field IDweb_event_add_to_cart |
Add to Cart Rate (%) (Website) The percentage of add to cart events out of all click events. | Field IDweb_event_add_to_cart_rate |
Add to cart rate (Shop) (%) The percentage of TikTok Shop add-to-cart actions from clicks on your ads. Add-to-cart is reported based on the time each ad impression occurred. | Field IDonsite_on_web_cart_rate |
Add to cart value (Shop) The total value of TikTok Shop add-to-cart actions attributed to your ads. Add-to-cart is reported based on the time each ad impression occurred. | Field IDtotal_onsite_on_web_cart_value |
Add to Wishlist Rate (%) The percentage of unique add to wishlist events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDadd_to_wishlist_rate |
Add To Wishlist Rate (Website) The percentage of add to wishlist events out of all click events. | Field IDon_web_add_to_wishlist_per_click |
AdGroup Create Time Time at which the Ad Group was created. | Field IDad_group/create_time |
Adgroup Gender Get the Gender that you want to target. Enum: GENDER_FEMALE,GENDER_MALE,GENDER_UNLIMITED. | Field IDad_group/gender |
AdGroup Modify Time Get the Time at which the Ad Group was Modified. | Field IDad_group/modify_time |
AdGroup Optimization goal Get the Optimization goal. | Field IDad_group/optimize_goal |
Advertiser address information Get the Advertiser address information. | Field IDadvertiser/address |
Advertiser contact email, desensitised data Get the Advertiser contact email, desensitised data. | Field IDadvertiser/email |
Advertiser ID Get the Advertiser ID. | Field IDadvertiser/id |
Advertiser industry category Get the Advertiser industry category. | Field IDadvertiser/industry |
Advertiser Language Get the Language used by advertisers. | Field IDadvertiser/language |
Advertiser name Get the Advertiser name. | Field IDadvertiser/name |
Advertiser role Get the Advertiser role. | Field IDadvertiser/role |
Advertiser status Get the Advertiser status. | Field IDadvertiser/status |
Advertiser's company name Get the Advertiser's company name. | Field IDadvertiser/company |
Advertiser's create time Get the Advertiser's create time. | Field IDadvertiser/create_time |
Advertising objective Get the Advertising objective. | Field IDcampaign/objective_type |
Age The Age. | Field IDage |
App download link Get the App download link. | Field IDad_group/app_download_url |
App Install The 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.) | Field IDapp_install |
App Install (SKAN) The 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 events are returned through the SKAdNetwork API. There may be a delay between the actual conversion time and when the conversion is reported. | Field IDskan_app_install |
App Installs (SKAN Privacy Withheld) The number of unique app install events that are attributed to your ads, with withheld values due to Apple's privacy threshold. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_app_install_withheld |
App name Get the display name of app download ad. | Field IDad/app_name |
App retargeting audience type Get the App retargeting audience type. For enum values, see Enumeration - App Retargeting Audience Type.. | Field IDad_group/audience_type |
Application id Get the Application id of the promoted app. | Field IDad_group/app_id |
Audience minimum ios version Get the Audience minimum ios version. | Field IDad_group/ios_osv |
Audience Network The Audience Network. | Field IDac |
Avatar URL Get the Avatar URL. | Field IDad/profile_image |
Average order value (Shop) The average order value per TikTok Shop purchase attributed to your ads. Gross revenue and purchases are reported based on the time each ad impression occurred. | Field IDvalue_per_onsite_shopping |
Behavior Behavior. | Field IDbehavior_id |
Bid Get the CPC, CPM bidding, oCPM learning bidding. | Field IDad_group/bid |
Bid method Get the Bid method. | Field IDad_group/billing_event |
Bidding strategy Get the Bidding strategy on the campaign level. Return only when Campaign Budget Optimization is enabled. | Field IDcampaign/bid_type |
Bidding Strategy Get the Bidding Strategy. | Field IDad_group/bid_type |
Bidding strategy for in-app events Get the Bidding strategy for in-app events. | Field IDad_group/deep_bid_type |
Billing method of Reach & Frequency ad groups Get the Billing method of Reach & Frequency ad groups. For more details, see Enumeration - Reach & Frequency Buy Type. Returned when objective_type of the related campaign is RF_REACH. | Field IDad_group/rf_buy_type |
Brand description, i.e. promotional content Get the Brand description, i.e. promotional content. | Field IDadvertiser/description |
Brand safety partner Get the Brand safety partner. Available only when brand_safety is THIRD_PARTY. Enum values: IAS, OPEN_SLATE. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tools/regions/ endpoint. You need to pass in the brand safety type and brand safety partner. | Field IDad_group/brand_safety_partner |
Brand safety type Get the Brand safety type. Currently, the only supported value is THIRD_PARTY. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tools/regions/ endpoint. You need to pass in the brand safety type and brand safety partner. | Field IDad_group/brand_safety |
Budget mode Get the Budget mode. | Field IDad_group/budget |
Budget Optimize Switch Whether Campaign Budget Optimization is enabled. Return only when Campaign Budget Optimization is enabled. | Field IDcampaign/budget_optimize_switch |
Budget type Get the Budget type. | Field IDcampaign/budget_mode |
Call to action Get the Call to action. | Field IDad/call_to_action |
Call to action ID Get the ID of the CTA portfolio that you want to use in your ads. A CTA portfolio is a group of auto-optimized CTAs. If both this field and call_to_action are specified, this field will be used, and call_to_action will be ignored. | Field IDad/call_to_action_id |
Campaign Automation Type Get the Campaign Automation Type. | Field IDcampaign/campaign_automation_type |
Campaign budget Get the Campaign budget. | Field IDcampaign/budget |
Campaign Create Time Time at which the campaign was created. | Field IDcampaign/create_time |
Campaign ID Get the Campaign ID. | Field IDcampaign/campaign_id |
Campaign Is a new structure Whether the campaign is a new structure (for the same campaign, the structure of campaign, adgroups and ads are the same). | Field IDcampaign/is_new_structure |
Campaign Modify Time Get the Time at which the campaign was Modified. | Field IDcampaign/modify_time |
Campaign name Get the Campaign name. | Field IDcampaign/campaign_name |
Campaign Operation status Get the Operation status. Enum values: DISABLE, ENABLE. | Field IDcampaign/opt_status |
Campaign Optimization goal Get the Optimization goal. Return only when Campaign Budget Optimization is enabled. | Field IDcampaign/optimize_goal |
Campaign status Get the Campaign status(Secondary status). | Field IDcampaign/status |
Campaign type Get the Campaign type (application or landing page). Allowed values include: APP(application), LANDING_PAGE(Landing page). | Field IDcampaign/objective |
Campaign Type Get the Campaign Type, indicates the campaign is a regular campaign or iOS 14 campaign. Enum values: REGULAR_CAMPAIGN and IOS14_CAMPAIGN. | Field IDcampaign/campaign_type |
Card ID Get the Image card ID, gift code card ID, or premium badge ID. | Field IDad/card_id |
Catalog ID Get the Catalog ID。
Return when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad_group/catalog_id |
Catalog video template ID Get the Catalog video template ID. Return when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad/dpa_video_tpl_id |
Catalogue authorized in Business Center For catalogs in Business Center, this field returns the ID of the Business Center that a catalog belongs to. | Field IDad_group/catalog_authorized_bc |
Checkout initiation rate (Shop) (%) The percentage of TikTok Shop initiate checkout actions from clicks on your ads. Initiate checkout is reported based on the time each ad impression occurred. | Field IDonsite_initiate_checkout_count_rate |
Checkout initiation value (Shop) The total value of TikTok Shop initiate checkout actions attributed to your ads. Initiate checkout is reported based on the time each ad impression occurred. | Field IDtotal_onsite_initiate_checkout_count_value |
Checkouts 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. Initiate checkout is reported based on the time each ad impression occurred. | Field IDonsite_initiate_checkout_count |
Click Button (Website) The number of button click events. | Field IDbutton_click |
Click Button Rate (%) (Website) The percentage of button click events out of all click events. | Field IDbutton_click_rate |
Click monitoring URL Get the Click monitoring URL. | Field IDad/click_tracking_url |
Clicks (All) Number of clicks from your ads. This includes clicks that lead to destination as well as those for social and interaction purposes. | Field IDengagements |
Clicks (destination) The clicks | Field IDclicks |
Clicks on Hashtag Challenge Clicks on Hashtag Challenge | Field IDclicks_on_hashtag_challenge |
Clicks on music disc The number of clicks on the official music in your Boosted TikTok ad during the campaign. Available only if you are on the allowlist for the Boosted TikTok feature. | Field IDclicks_on_music_disc |
Complete Registration Rate (%) (Website) The percentage of user registration events out of all click events. | Field IDuser_registration_rate |
Complete Tutorial (Total No.) Complete Tutorial (Total No.) (The total count is based on when you were billed.) | Field IDtotal_complete_tutorial |
Complete Tutorial Rate (%) The percentage of unique complete tutorial events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDcomplete_tutorial_rate |
Contact Person Get the Contact Person. | Field IDadvertiser/contacter |
Contact Rate (%) (Website) The percentage of contact events out of all click events. | Field IDonline_consult_rate |
Conversion bid statistic type Get the conversion bid statistic type, bid for EVERYTIME (Each Purchase)/ NONE (Unique Purchase). | Field IDad_group/statistic_type |
Conversion Rate The conversion rate. | Field IDconversion_rate |
Conversion rate (SKAN, clicks) Percentage of conversions you received out of all destination clicks on your ads. | Field IDskan_conversion_rate |
Conversion rate (SKAN) Percentage of conversions you received out of all impressions on your ads. | Field IDskan_conversion_rate_v2 |
Conversion window Get the The time frame when you would like a conversion to happen after a user clicks on or views your ad. Your ad delivery will be optimized using the conversion data during the time frame you select. This setting will not impact your attribution data. | Field IDad_group/conversion_window |
Conversions The Conversions. | Field IDconversion |
Conversions (SKAN click time) The number of times your ad achieved an outcome based on the objective and settings you selected. Data may be partial due to SKAdNetwork(SKAN) limitations. | Field IDskan_click_time_conversion |
Conversions (SKAN) Number of times your ad resulted in an intended outcome based on your optimization event. | Field IDskan_conversion |
Cost Per 1000 Reached The cost per 1000 reached. | Field IDcost_per_1000_reached |
Cost per Achieve Level Cost per Achieve Level (The total count is based on when you were billed.) | Field IDcost_per_total_achieve_level |
Cost per Achieve Level (SKAN) The average cost for each achieve level event that is attributed to your ads. | Field IDskan_cost_per_total_achieve_level |
Cost per Add Payment Info Cost per Add Payment Info (The total count is based on when you were billed.) | Field IDcost_total_add_payment_info |
Cost per Add Payment Info (SKAN) The average cost for each add payment info event that is attributed to your ads. | Field IDskan_cost_total_add_payment_info |
Cost per Add to Cart Cost per Add to Cart (The total count is based on when you were billed.) | Field IDcost_per_total_app_event_add_to_cart |
Cost per add to cart (Shop) The average cost per TikTok Shop add-to-cart action attributed to your ads. Add-to-cart is reported based on the time each ad impression occurred. | Field IDcost_per_onsite_on_web_cart |
Cost per Add to Cart (SKAN) The average cost for each add to cart event that is attributed to your ads. | Field IDskan_cost_per_total_add_to_cart |
Cost per Add to Cart (Website) The average cost of each add to cart event. | Field IDcost_per_web_event_add_to_cart |
Cost per Add to Wishlist Cost per Add to Wishlist (The total count is based on when you were billed.) | Field IDcost_per_total_add_to_wishlist |
Cost per Add to Wishlist (SKAN) The average cost for each add to wishlist event that is attributed to your ads. | Field IDskan_cost_per_total_add_to_wishlist |
Cost per Add To Wishlist (Website) The average cost of each add to wishlist event. | Field IDcost_per_on_web_add_to_wishlist |
Cost per App Install The average cost for each app install event. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_app_install |
Cost per App Install (SKAN) The average cost for each app install event. The total count is based on when the events are returned through the SKAdNetwork API. There may be a delay between the actual conversion time and when the conversion is reported. | Field IDskan_cost_per_app_install |
Cost per Checkout Cost per Checkout (The total count is based on when you were billed.) | Field IDcost_per_total_checkout |
Cost per Checkout (SKAN) The average cost for each checkout event that is attributed to your ads. | Field IDskan_cost_per_total_checkout |
Cost per checkout initiated (Shop) The average cost per TikTok Shop initiate checkout action attributed to your ads. Initiate checkout is reported based on the time each ad impression occurred. | Field IDcost_per_onsite_initiate_checkout_count |
Cost per Click Button (Website) The average cost of each button click event. | Field IDcost_per_button_click |
Cost per Complete Registration (Website) The average cost of each user registration event. | Field IDcost_per_user_registration |
Cost per Complete Tutorial Cost per Complete Tutorial (The total count is based on when you were billed.) | Field IDcost_per_total_complete_tutorial |
Cost per Complete Tutorial (SKAN) The average cost for each complete tutorial event that is attributed to your ads. | Field IDskan_cost_per_total_complete_tutorial |
Cost per Contact (Website) The average cost of each contact event. | Field IDcost_per_online_consult |
Cost Per Conversion The cost per conversions. | Field IDcost_per_conversion |
Cost per conversion (SKAN) Average amount you spent on a conversion. | Field IDskan_cost_per_conversion |
Cost per Create Group Cost per Create Group (The total count is based on when you were billed.) | Field IDcost_per_total_create_group |
Cost per Create Group (SKAN) The average cost for each create group event that is attributed to your ads. | Field IDskan_cost_per_total_create_group |
Cost per Create Role Cost per Create Role (The total count is based on when you were billed.) | Field IDcost_per_total_create_gamerole |
Cost per Create Role (SKAN) The average cost for each create role event that is attributed to your ads. | Field IDskan_cost_per_total_create_gamerole |
Cost per CTA App Install The average cost per each app install event attributed to a click on your ad. | Field IDcost_per_cta_app_install |
Cost per CTA App Install (SKAN) The average cost per each app install event attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_cta_app_install |
Cost per CTA Conversion The average cost per each conversion event attributed to a click on your ad. | Field IDcost_per_cta_conversion |
Cost per CTA Conversion (SKAN) The average cost per each in-app conversion event attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_cta_conversion |
Cost per CTA purchase (app) Average cost per in-app purchase event attributed to a click on your ad. | Field IDcost_per_cta_purchase |
Cost per CTA Purchase (SKAN) The average cost per each in-app purchase event attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_cta_purchase |
Cost per CTA registration Average cost for an in-app registration event attributed to a click on your ad. | Field IDcost_per_cta_registration |
Cost per CTA Registration (SKAN) The average cost per each in-app registration event attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_cta_registration |
Cost Per Custom Event (App) The average cost per custom app event attributed to your ads. | Field IDcost_per_custom_app_event |
Cost Per Custom Page Event (Website) Average cost incurred per custom page event triggered. | Field IDcost_per_custom_page_event |
Cost per Day 1 Retention Cost per Day 1 Retention (The total count is based on when you were billed.) | Field IDcost_per_total_next_day_open |
Cost per Download (Website) The average cost of each download button click events. | Field IDcost_per_download_start |
Cost per EVTA App Install The average cost per each app install event attributed to an ad impression within the EVTA conversion window. | Field IDcost_per_evta_app_install |
Cost per EVTA Conversion The average cost per each conversion event attributed to an ad impression within the EVTA conversion window. | Field IDcost_per_engaged_view_through_conversion |
Cost per EVTA purchase (app) The average cost per in-app purchase action attributed to engaged views of your ad. | Field IDcost_per_evta_purchase |
Cost per EVTA purchase (website) The average cost per website purchase action attributed to engaged views of your ad. | Field IDcost_per_evta_payments_completed |
Cost per EVTA registration The average cost per registration action attributed to engaged views of your ad. | Field IDcost_per_evta_registration |
Cost per Generate Lead Cost per Generate Lead (The total count is based on when you were billed.) | Field IDcost_per_total_sales_lead |
Cost per Generate Lead (SKAN) The average cost for each generate lead event that is attributed to your ads. | Field IDskan_cost_per_total_sales_lead |
Cost per In-App Ad Click Cost per In-App Ad Click (The total count is based on when you were billed.) | Field IDcost_per_total_in_app_ad_click |
Cost per In-App Ad Click (SKAN) The average cost for each in-app ad click event that is attributed to your ads. | Field IDskan_cost_per_total_in_app_ad_click |
Cost per In-App Ad Impr Cost per In-App Ad Impr (The total count is based on when you were billed.) | Field IDcost_per_total_in_app_ad_impr |
Cost per In-App Ad Impression (SKAN) The average cost for each in-app ad impression event that is attributed to your ads. | Field IDskan_cost_per_total_in_app_ad_impr |
Cost per Initiate Checkout (Website) The average cost of each initiate checkout event. | Field IDcost_per_initiate_checkout |
Cost per Join Group Cost per Join Group (The total count is based on when you were billed.) | Field IDcost_per_total_join_group |
Cost per Join Group (SKAN) The average cost for each join group event that is attributed to your ads. | Field IDskan_cost_per_total_join_group |
Cost per Landing Page View The average cost of each landing page view event. | Field IDcost_per_landing_page_view |
Cost per Launch App Cost per Launch App (The total count is based on when you were billed.) | Field IDcost_per_total_launch_app |
Cost per Launch App (SKAN) The average cost for each launch app event that is attributed to your ads. | Field IDskan_cost_per_total_launch_app |
Cost per Loan Apply Cost per Loan Apply (The total count is based on when you were billed.) | Field IDcost_per_total_loan_apply |
Cost per Loan Apply (SKAN) The average cost for each loan apply event that is attributed to your ads. | Field IDskan_cost_per_total_loan_apply |
Cost per Loan Approval Cost per Loan Approval (The total count is based on when you were billed.) | Field IDcost_per_total_loan_credit |
Cost per Loan Approval (SKAN) The average cost for each loan approval event that is attributed to your ads. | Field IDskan_cost_per_total_loan_credit |
Cost per Loan Disbursement Cost per Loan Disbursement (The total count is based on when you were billed.) | Field IDcost_per_total_loan_disbursement |
Cost per Loan Disbursement (SKAN) The average cost for each loan disbursement event that is attributed to your ads. | Field IDskan_cost_per_total_loan_disbursement |
Cost per Login Cost per Login (The total count is based on when you were billed.) | Field IDcost_per_total_login |
Cost per Login (SKAN) The average cost for each login event that is attributed to your ads. | Field IDskan_cost_per_total_login |
Cost per Page Browse (Website) The average cost of each page browse event. | Field IDcost_per_page_browse_view |
Cost per Page View The average cost of each page browse event. | Field IDcost_per_pageview |
Cost per payment info added (website) The average cost of each add billing event. | Field IDcost_per_add_billing |
Cost per Place an Order (Website) The average cost of each place an order event. | Field IDcost_per_on_web_order |
Cost per product page view (Shop) The average cost per TikTok Shop product details page view attributed to your ads. Product details page views are reported based on the time each ad impression occurred. | Field IDcost_per_onsite_on_web_detail |
Cost per Purchase Cost per Purchase (The total count is based on when you were billed.) | Field IDcost_per_total_purchase |
Cost per purchase (Shop) The average cost per TikTok Shop purchase attributed to your ads. Purchases are reported based on the time each ad impression occurred. | Field IDcost_per_onsite_shopping |
Cost per Purchase (SKAN) The average cost for each purchase event that is attributed to your ads. | Field IDskan_cost_per_total_purchase |
Cost per Purchase (Website) The average cost of each Purchase event. | Field IDcost_per_complete_payment |
Cost per Rate Cost per Rate (The total count is based on when you were billed.) | Field IDcost_per_total_ratings |
Cost per Rate (SKAN) The average cost for each rate event that is attributed to your ads. | Field IDskan_cost_per_total_ratings |
Cost per Real-time App Install The average cost for each app install event. (The total count is based on when the conversion actually happened.) | Field IDreal_time_app_install_cost |
Cost per Registration Cost per Registration (The total count is based on when you were billed.) | Field IDcost_per_total_registration |
Cost per Registration (SKAN) The average cost for each registration event that is attributed to your ads. | Field IDskan_cost_per_total_registration |
Cost Per Result Get the cost per result. | Field IDcost_per_result |
Cost per result (SKAN) Average cost per each result from your ads. | Field IDskan_cost_per_result |
Cost per Search Cost per Search (The total count is based on when you were billed.) | Field IDcost_per_total_search |
Cost per Search (SKAN) The average cost for each search event that is attributed to your ads. | Field IDskan_cost_per_total_search |
Cost Per Secondary Goal Result Get the cost per secondary goal result. | Field IDcost_per_secondary_goal_result |
Cost per Spend Credit Cost per Spend Credit (The total count is based on when you were billed.) | Field IDcost_per_total_spend_credits |
Cost per Spend Credit (SKAN) The average cost for each spend credit event that is attributed to your ads. | Field IDskan_cost_per_total_spend_credits |
Cost per Start Trial Cost per Start Trial (The total count is based on when you were billed.) | Field IDcost_per_total_start_trial |
Cost per Start Trial (SKAN) The average cost for each start trial event that is attributed to your ads. | Field IDskan_cost_per_total_start_trial |
Cost per Submit Form (Website) The average cost of each form submission event. | Field IDcost_per_form |
Cost per Subscribe Cost per Subscribe (The total count is based on when you were billed.) | Field IDcost_per_total_subscribe |
Cost per Subscribe (SKAN) The average cost for each subscribe event that is attributed to your ads. | Field IDskan_cost_per_total_subscribe |
Cost per Unique Achieve Level The average cost for each unique achieve level event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_achieve_level |
Cost per Unique Achieve Level (SKAN) The average cost for each unique achieve level event that is attributed to your ads. | Field IDskan_cost_per_achieve_level |
Cost per Unique Add Payment Info The average cost for each unique add payment info event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_add_payment_info |
Cost per Unique Add Payment Info (SKAN) The average cost for each unique add payment info event that is attributed to your ads. | Field IDskan_cost_per_add_payment_info |
Cost per Unique Add to Cart 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.) | Field IDcost_per_app_event_add_to_cart |
Cost per Unique Add to Cart (SKAN) The average cost for each unique add to cart event that is attributed to your ads. | Field IDskan_cost_per_add_to_cart |
Cost per Unique Add to Wishlist The average cost for each unique add to wishlist event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_add_to_wishlist |
Cost per Unique Add to Wishlist (SKAN) The average cost for each unique add to wishlist event that is attributed to your ads. | Field IDskan_cost_per_add_to_wishlist |
Cost per Unique Checkout The average cost for each unique checkout event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_checkout |
Cost per Unique Checkout (SKAN) The average cost for each unique checkout event that is attributed to your ads. | Field IDskan_cost_per_checkout |
Cost per Unique Complete Tutorial The average cost for each unique complete tutorial event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_complete_tutorial |
Cost per Unique Complete Tutorial (SKAN) The average cost for each unique complete tutorial event that is attributed to your ads. | Field IDskan_cost_per_complete_tutorial |
Cost per Unique Create Group The average cost for each unique create group event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_create_group |
Cost per Unique Create Group (SKAN) The average cost for each unique create group event that is attributed to your ads. | Field IDskan_cost_per_create_group |
Cost per Unique Create Role The average cost for each unique create role event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_create_gamerole |
Cost per Unique Create Role (SKAN) The average cost for each unique create role event that is attributed to your ads. | Field IDskan_cost_per_create_gamerole |
Cost Per Unique Custom Event (App) The average cost per unique custom app event attributed to your ads. | Field IDcost_per_unique_custom_app_event |
Cost per Unique Day 1 Retention The average cost for each unique day 1 retention event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_next_day_open |
Cost per Unique Generate Lead The average cost for each unique generate lead event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_sales_lead |
Cost per Unique Generate Lead (SKAN) The average cost for each unique generate lead event that is attributed to your ads. | Field IDskan_cost_per_sales_lead |
Cost per Unique In-App Ad Click The average cost for each unique in-app ad click event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_in_app_ad_click |
Cost per Unique In-App Ad Click (SKAN) The average cost for each unique in-app ad click event that is attributed to your ads. | Field IDskan_cost_per_in_app_ad_click |
Cost per Unique In-App Ad Impr The average cost for each unique in-app ad impression event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_in_app_ad_impr |
Cost per Unique In-App Ad Impression (SKAN) The average cost for each unique in-app ad impression event that is attributed to your ads. | Field IDskan_cost_per_in_app_ad_impr |
Cost per Unique Join Group The average cost for each unique join group event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_join_group |
Cost per Unique Join Group (SKAN) The average cost for each unique join group event that is attributed to your ads. | Field IDskan_cost_per_join_group |
Cost per Unique Launch App The average cost for each unique launch app event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_launch_app |
Cost per Unique Launch App (SKAN) The average cost for each unique launch app event that is attributed to your ads. | Field IDskan_cost_per_launch_app |
Cost per Unique Loan Apply The average cost for each unique loan apply event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_loan_apply |
Cost per Unique Loan Apply (SKAN) The average cost for each unique loan apply event that is attributed to your ads. | Field IDskan_cost_per_loan_apply |
Cost per Unique Loan Approval The average cost for each unique loan approval event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_loan_credit |
Cost per Unique Loan Approval (SKAN) The average cost for each unique loan approval event that is attributed to your ads. | Field IDskan_cost_per_loan_credit |
Cost per Unique Loan Disbursement The average cost for each unique loan disbursal event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_loan_disbursement |
Cost per Unique Loan Disbursement (SKAN) The average cost for each unique loan disbursal event that is attributed to your ads. | Field IDskan_cost_per_loan_disbursement |
Cost per Unique Login The average cost for each unique login event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_login |
Cost per Unique Login (SKAN) The average cost for each unique login event that is attributed to your ads. | Field IDskan_cost_per_login |
Cost per Unique Purchase The average cost of each unique purchase. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_purchase |
Cost per Unique Purchase (SKAN) The average cost of each unique purchase that is attributed to your ads. | Field IDskan_cost_per_purchase |
Cost per Unique Rate The average cost for each unique rate event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_ratings |
Cost per Unique Rate (SKAN) The average cost for each unique rate event that is attributed to your ads. | Field IDskan_cost_per_ratings |
Cost per Unique Registration The 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.) | Field IDcost_per_registration |
Cost per Unique Registration (SKAN) The average cost for each unique registration event that is attributed to your ads. | Field IDskan_cost_per_registration |
Cost per Unique Search The average cost for each unique search event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_search |
Cost per Unique Search (SKAN) The average cost for each unique search event that is attributed to your ads. | Field IDskan_cost_per_search |
Cost per Unique Spend Credit The average cost for each unique spend credits event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_spend_credits |
Cost per Unique Spend Credit (SKAN) The average cost for each unique spend credit event that is attributed to your ads. | Field IDskan_cost_per_spend_credits |
Cost per Unique Start Trial The average cost for each unique start trial event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_start_trial |
Cost per Unique Start Trial (SKAN) The average cost for each unique start trial event that is attributed to your ads. | Field IDskan_cost_per_start_trial |
Cost per Unique Subscribe The average cost for each unique subscribe event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_subscribe |
Cost per Unique Subscribe (SKAN) The average cost for each unique subscribe event that is attributed to your ads. | Field IDskan_cost_per_subscribe |
Cost per Unique Unlock Achievement The average cost for each unique unlock achievement event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_unlock_achievement |
Cost per Unique Unlock Achievement (SKAN) The average cost for each unique unlock achievement event that is attributed to your ads. | Field IDskan_cost_per_unlock_achievement |
Cost per Unique View Content The average cost for each unique view content event that is attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDcost_per_view_content |
Cost per Unique View Content (SKAN) The average cost for each unique view content event that is attributed to your ads. | Field IDskan_cost_per_view_content |
Cost per Unlock Achievement Cost per Unlock Achievement (The total count is based on when you were billed.) | Field IDcost_per_total_unlock_achievement |
Cost per Unlock Achievement (SKAN) The average cost for each unlock achievement event that is attributed to your ads. | Field IDskan_cost_per_total_unlock_achievement |
Cost per View Content Cost per View Content (The total count is based on when you were billed.) | Field IDcost_per_total_view_content |
Cost per View Content (SKAN) The average cost for each view content event that is attributed to your ads. | Field IDskan_cost_per_total_view_content |
Cost per VTA App Install The average cost per each app install event attributed to an ad impression. | Field IDcost_per_vta_app_install |
Cost per VTA App Install (SKAN) The average cost per each app install event attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_vta_app_install |
Cost per VTA Conversion The average cost per each conversion event attributed to an ad impression. | Field IDcost_per_vta_conversion |
Cost per VTA Conversion (SKAN) The average cost per each conversion event attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_vta_conversion |
Cost per VTA purchase (app) Average cost per in-app purchase event attributed to an ad impression. | Field IDcost_per_vta_purchase |
Cost per VTA Purchase (SKAN) The average cost per each in-app purchase event attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_vta_purchase |
Cost per VTA purchase (website) Average cost of each website purchase event attributed to someone only viewing your ad. | Field IDcost_per_vta_payments_completed |
Cost per VTA registration Average cost per registration event attributed to an ad impression. | Field IDcost_per_vta_registration |
Cost per VTA Registration (SKAN) The average cost per each in-app registration event attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cost_per_vta_registration |
Country The Country. | Field IDcountry_name |
Country Code The Country code. | Field IDcountry_code |
CPA (SKAN click time) The average amount of money you've spent on a conversion. Data may be partial due to SKAdNetwork(SKAN) limitations. | Field IDskan_click_time_cost_per_conversionn |
CPC The CPC | Field IDcpc |
CPM The cpm | Field IDcpm |
Create Group (Total No.) Create Group (Total No.) (The total count is based on when you were billed.) | Field IDtotal_create_group |
Create 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.) | Field IDcreate_group_rate |
Create Role (Total No.) Create Role (Total No.) (The total count is based on when you were billed.) | Field IDtotal_create_gamerole |
Created time Get the Time at which the ad was created. | Field IDad/create_time |
Creative delivery mode Get the Creative delivery mode. Note: When you choose automated ad, your creative materials will automatically be combined for delivery. Tiktok Ads' smart optimization algorithm is applied and will be used to achieve the best ad performance during delivery. Enum values: CUSTOM(custom), DYNAMIC(automated). | Field IDad_group/creative_material_mode |
Creative type Get the creative type. Enum values: SINGLE_IMAGE, SINGLE_VIDEO, CAROUSEL. | Field IDad/ad_format |
CTA App Install The number of app install events attributed to a click on your ad. | Field IDcta_app_install |
CTA App Install (SKAN) The number of app install events attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cta_app_install |
CTA Conversion The number of conversion events attributed to a click on your ad. | Field IDcta_conversion |
CTA Conversion (SKAN) The number of in-app conversion events attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cta_conversion |
CTA Purchase (SKAN) The number of in-app purchase events attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cta_purchase |
CTA purchases (app) Number of in-app purchase events attributed to clicks on your ad based on information received from your measurement partner. | Field IDcta_purchase |
CTA Registration (SKAN) The number of in-app registration events attributed to a click on your ad. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_cta_registration |
CTA registrations Number of in-app registration events attributed to a click on your ad based on information received from your measurement partner. | Field IDcta_registration |
CTR (All) Percentage of impressions that resulted in a click out of all impressions. | Field IDengagement_rate |
CTR (destination) The ctr | Field IDctr |
Custom Event Rate (App) The percentage of custom app events from all app installs attributed to your ads. | Field IDcustom_app_event_rate |
Custom Event Value (App) The total value of custom app events attributed to your ads. | Field IDcustom_app_events_value |
Custom Events (App) The number of custom app events attributed to your ads. | Field IDcustom_app_events |
Custom Page Event Rate (Website) The rate at which the custom page event occurred relative to impressions or clicks. | Field IDcustom_page_event_rate |
Custom Page Events (Website) Number of times the custom page event was triggered. | Field IDcustom_page_events |
Custom Page Events Value (Website) Total value generated by all custom page events. | Field IDcustom_page_events_value |
CVR (SKAN click time, clicks) The percentage of conversions from all clicks of your ads. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_click_time_conversion_rate |
CVR (SKAN click time, impressions) The percentage of conversions from all impressions on your ads. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_click_time_conversion_rate_v2 |
Date Year, month, and day. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY |
Day 1 Retention (Total No.) Day 1 Retention (Total No.) (The total count is based on when you were billed.) | Field IDtotal_next_day_open |
Day 1 Retention Rate (%) The percentage of unique day 1 retention events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDnext_day_open_rate |
Day of the month Day of the year | Field ID_NORMALIZED_DATE_FIELD_DAY |
Day of the week Week of the year | Field ID_NORMALIZED_DATE_FIELD_DAY_OF_WEEK |
Deep bid Get the Deep bid. | Field IDad_group/deep_cpabid |
Deep External Action Get the Secondary-goal event when the optimize_goal is INSTALL or VALUE.. | Field IDad_group/deep_external_action |
Device Brand The Device Brand. | Field IDdevice_brand_id |
Device Platform The Device. | Field IDplatform |
Display monitoring URL Get the Display monitoring URL. | Field IDad/impression_tracking_url |
Display name Get the display name of landing page or pure exposure ad. | Field IDad/display_name |
DMA The DMA. | Field IDdma_id |
Download Rate (%) (Website) The percentage of download button click events out of all click events. | Field IDdownload_start_rate |
DPA fallback type In DPA scenario, the fallback behavior of deeplink evokes failed. Return when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad/dpa_fallback_type |
DPA open url type Indicates the source of the direct link used in the ad. This field is returned when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad/dpa_open_url_type |
DPA Target Audience Type Get the dpa target audience type. | Field IDdpa_target_audience_type |
Engaged views The number of engaged views. Engaged view means that people watch six seconds or longer of your video OR interact with the video (for example, Like/Share). Note: This feature is on the allowlist. If you would like access to it, please reach out to your TikTok representative. | Field IDengaged_view |
Estimated cost per mile reach Get the estimated cost per mile reach. Returned when objective_type of the related campaign is RF_REACH. | Field IDad_group/rf_predict_cpr |
Estimated show frequency Get the estimated show frequency. Returned when objective_type of the related campaign is RF_REACH. | Field IDad_group/rf_predict_frequency |
EVTA App Install The number of app install events attributed to an ad impression within the EVTA conversion window. | Field IDevta_app_install |
EVTA Conversions The number of conversion events attributed to an ad impression within the EVTA conversion window. | Field IDengaged_view_through_conversions |
EVTA purchases (app) The number of in-app purchase actions attributed to engaged views of your ad. | Field IDevta_purchase |
EVTA purchases (website) The number of website purchase actions attributed to engaged views of your ad. | Field IDevta_payments_completed |
EVTA registrations The number of registration actions attributed to engaged views of your ad. | Field IDevta_registration |
External Action Get the Conversion event for the ad group. | Field IDad_group/external_action |
Fallback Type Get the Fallback Type. If the audience do not have the app installed, you can have them fall back to install the app, or to view a specific web page. Not applicable for Deferred Deeplink. Allowed values: APP_INSTALL, WEBSITE, UNSET. If website is chosen, you need to specify the url via landing_page_url field. | Field IDad/fallback_type |
Frequency The average number of times each unique user saw your ads in the reporting period. This metric is estimated. | Field IDfrequency |
Frequency schedule Get the frequency, together with frequency, controls how often people see your ad (only available for REACH ads). | Field IDad_group/frequency_schedule |
Gender The Gender. | Field IDgender |
Generate Lead (Total No.) Generate Lead (Total No.) (The total count is based on when you were billed.) | Field IDtotal_sales_lead |
Generate Lead Rate (%) The percentage of unique generate lead events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDsales_lead_rate |
GMT Timezone Get the Ad account time zone including GMT offset. For example, "Etc/GMT". | Field IDadvertiser/timezone |
Gross 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. Gross revenue is reported based on the time each ad impression occurred. | Field IDtotal_onsite_shopping_value |
Hour of the day Hour of the day | Field ID_NORMALIZED_DATE_FIELD_HOUR |
Impressions The impressions | Field IDimpressions |
Impressions to be purchased Get the Impressions to be purchased. Returned when objective_type of the related campaign is RF_REACH. | Field IDad_group/buy_impression |
In-App Ad Click (Total No.) In-App Ad Click (Total No.) (The total count is based on when you were billed.) | Field IDtotal_in_app_ad_click |
In-App Ad Click Rate (%) The percentage of unique in-app ad click events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDin_app_ad_click_rate |
In-App Ad Impr (Total No.) In-App Ad Impr (Total No.) (The total count is based on when you were billed.) | Field IDtotal_in_app_ad_impr |
In-App Ad Impr Rate (%) The percentage of unique in-app ad impression events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDin_app_ad_impr_rate |
Initiate Checkout Rate (%) (Website) The percentage of initiate checkout events out of all click events. | Field IDinitiate_checkout_rate |
Instant Page ID Instant Page (InstantForm or Storefront Page) ID. | Field IDad/page_id |
Instant page type Get the Instant page type in your ad group. Currently, the only supported type is TIKTOK_NATIVE_PAGE, which stands for TikTok instant pages. null means no instant pages are used in the ad group. | Field IDad_group/promotion_website_type |
Interest Category first level Interest Category first level. | Field IDinterest_category |
Interest Category fourth level Interest Category fourth level | Field IDinterest_category_tier4 |
Interest Category second level Interest Category second level | Field IDinterest_category_tier2 |
Interest Category third level Interest Category third level | Field IDinterest_category_tier3 |
Interest Category V2 first level Interest Category V2 first level. | Field IDinterest_category_v2 |
Inventory filtering Get the Inventory filtering (filtering security videos, hides unsafe videos), valid only for the PLACEMENT_TIKTOK placement. Optional values are: true to filter, false not to filter.. | Field IDad_group/enable_inventory_filter |
IOS quota type Whether the campaign will be counted against the iOS 14 dedicated campaign quota. Enum: OCCUPIED, UNOCCUPIED. For non-R&F campaigns, when ios_target_device is IOS14_PLUS, this field is automatically set to OCCUPIED. | Field IDad_group/ios_quota_type |
IOS target devices The iOS devices that you want to target.
UNSET: This is the previous default value of the field.
IOS14_MINUS: Devices with iOS 14.4 or earlier version that are not affected by the iOS 14 privacy update. This is the default value for ad groups that are created after the introduction of this field.
IOS14_PLUS: Devices with iOS 14.5 and above. The iOS 14 privacy update has been enforced in this group of devices.. | Field IDad_group/ios_target_device |
Is Ad automated Whether the ad is an automated ad. Set to true for automated ad and false for non-automated ad. | Field IDad/is_aco |
Is comment disable Whether to allow comments on your ads on TikTok, Vigo, Helo. Enum values: 0 (allow), 1 (restrict). The default calue is allow. | Field IDad_group/is_comment_disable |
Is Creative authorized Whether you grant displaying some of your ads in our TikTok For Business Creative Center. Only valid for non-US advertisers, the default value is false. | Field IDad/is_creative_authorized |
Is HFSS Whether the promoted product is HFSS foods (foods that are high in fat, salt, or sugar). | Field IDad_group/is_hfss |
Is New Structure Whether the campaign is a new structure | Field IDad_group/is_new_structure |
Is promotional music disabled Whether to disable the promotional use of the music in the Spark Ad post. The default value is true. If you want to allow dueting and stitching for the Spark Ad post, you need to set this field to false. This field is only valid for Spark Ad posts. | Field IDad/promotional_music_disabled |
Item Duet Status Whether to enable dueting for the Spark Ad post. This field is valid only when promotional_music_disabled is set to false. Enum values: ENABLE, DISABLE. This field is only valid for Spark Ad posts. | Field IDad/item_duet_status |
Item stitch status Whether to enable stitching for the Spark Ad post. This field is valid only when promotional_music_disabled is set to false. Enum values: ENABLE, DISABLE. This field is only valid for Spark Ad posts. | Field IDad/item_stitch_status |
Join Group (Total No.) Join Group (Total No.) (The total count is based on when you were billed.) | Field IDtotal_join_group |
Join Group Rate (%) The percentage of unique join group events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDjoin_group_rate |
Land Page View Rate (%) The percentage of click events that are landing page view events. | Field IDlanding_page_view_rate |
Landing page URL Get the Landing page URL. | Field IDad/landing_page_url |
Language Language | Field IDlanguage |
Launch App (Total No.) Launch App (Total No.) (The total count is based on when you were billed.) | Field IDtotal_launch_app |
Launch App Rate (%) The percentage of unique launch app events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDlaunch_app_rate |
License number Get the License number. | Field IDadvertiser/license_no |
License URL Get the License preview address, the link is valid for an hour by default. | Field IDadvertiser/license_url |
LIVE Product Clicks Number of time viewers clicked a product and viewed its details page during your LIVE. | Field IDlive_product_clicks |
LIVE unique views Number of unique users who saw your LIVE at least once from an ad. | Field IDlive_unique_views |
LIVE views Number of times your LIVE was viewed from an ad. Revisits are counted. | Field IDlive_views |
Loan Apply (Total No.) Loan Apply (Total No.) (The total count is based on when you were billed.) | Field IDtotal_loan_apply |
Loan Apply Rate (%) The percentage of unique loan apply events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDloan_apply_rate |
Loan Approval (Total No.) Loan Approval (Total No.) (The total count is based on when you were billed.) | Field IDtotal_loan_credit |
Loan Approval Rate (%) The percentage of unique loan approval events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDloan_credit_rate |
Loan Disbursement (Total No.) Loan Disbursement (Total No.) (The total count is based on when you were billed.) | Field IDtotal_loan_disbursement |
Loan Disbursement Rate (%) The number of unique loan disbursals 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.) | Field IDloan_disbursement_rate |
Login (Total No.) Login (Total No.) (The total count is based on when you were billed.) | Field IDtotal_login |
Login Rate (%) The percentage of unique login events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDlogin_rate |
Minimum Android version Get the Minimum Android version. | Field IDad_group/android_osv |
Moat Viewability Verification Whether Moat Viewability Verification is enabled for the ad. TikTok has partnered with Moat to launch viewability measurement for Brand Auction and Reach & Frequency In-feed ads purchased on TikTok for Business. | Field IDad/vast_moat |
Mobile App Id Get the mobile app id. | Field IDmobile_app_id |
Modified time Get the Time at which the ad was Modified. | Field IDad/modify_time |
Month and day Month and day | Field ID_NORMALIZED_DATE_FIELD_MONTH_DAY |
Month of the year Month of the year | Field ID_NORMALIZED_DATE_FIELD_MONTH |
oCPM conversion bid Get the oCPM conversion bid. | Field IDad_group/conversion_bid |
Open URL Get the specific location where you want your audience to go if they have your app installed. See open_url_type for more. | Field IDad/open_url |
Open URL type Get the open URL type. Allowed values differs based on campaign objectives. Allowed values: NORMAL(supported in Traffic, Conversion & CatalogSales), DEFERRED_DEEPLINK(supported in AppInstall & Catalog Sales). | Field IDad/open_url_type |
Operational status Get the Operational status. Enum: DISABLE (ad group is disabled), ENABLE (ad group is enabled), FROZEN (terminated and cannot be used again). | Field IDad_group/opt_status |
Optimized video playback Get the Optimized video playback duration. Optional values include: SIX_SECONDS (video playback 6 seconds) and TWO_SECONDS (video playback 2 seconds). | Field IDad_group/cpv_video_duration |
Pacing Get the You can choose between PACING_MODE_SMOOTH and PACING_MODE_FAST. For PACING_MODE_SMOOTH, the budget is allocated evenly within the scheduled time. PACING_MODE_FAST would consume budget and produce results as soon as possible. When Campaign Budget Optimization (budget_optimize_switch) is on, your setting will be ignored and it will be set as PACING_MODE_SMOOTH. Otherwise, this field is required. | Field IDad_group/pacing |
Page Browse (Website) The number of page browse events. | Field IDpage_browse_view |
Page Browse Rate (%) (Website) The percentage of page browse events out of all click events. | Field IDpage_browse_view_rate |
Page View Rate (%) The percentage of page browse events out of all click events. | Field IDpageview_rate |
Paid Comments The number of comments your video creative received within 1 day of a user seeing a paid ad. | Field IDcomments |
Paid Engagement The sum of Paid Likes, Paid Shares and Paid Comments. | Field IDpaid_engagements |
Paid Followers The number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Boosted TikToks. | Field IDfollows |
Paid Likes The number of likes your video creative received within 1 day of a user seeing a paid ad. | Field IDlikes |
Paid Shares The number of shares your video creative received within 1 day of a user seeing a paid ad. | Field IDshares |
Payment info added (website) The number of add billing events. | Field IDadd_billing |
Phone Number Get the Contact mobile number, desensitised data. | Field IDadvertiser/phonenumber |
Pixel ID Get the Pixel ID. Only application for landing pages. | Field IDad_group/pixel_id |
Place an Order Rate (%) (Website) The percentage of place an order events out of all click events. | Field IDon_web_order_rate |
Placement The Placement. | Field IDplacement |
Placement type Get the Placement type. Allowed values: PLACEMENT_TYPE_AUTOMATIC (automatic placement), PLACEMENT_TYPE_NORMAL (manual placement). | Field IDad_group/placement_type |
Playable material url Get the Playable material url. | Field IDad/playable_url |
Product Details Page Browse (Website) The number of product details page browse events. | Field IDproduct_details_page_browse |
Product Details Page Browse Cost (Website) The average cost of each product details page browse event. | Field IDcost_per_product_details_page_browse |
Product Details Page Browse Rate (%) (Website) The percentage of product details page browse events out of all click events. | Field IDproduct_details_page_browse_rate |
Product page view rate (Shop) (%) The percentage of TikTok Shop product details page views from clicks on your ads. Product details page views are reported based on the time each ad impression occurred. | Field IDonsite_on_web_detail_rate |
Product page view value (Shop) The total value of TikTok Shop product details page views attributed to your ads. Product details page views are reported based on the time each ad impression occurred. | Field IDtotal_onsite_on_web_detail_value |
Product page views (Shop) The number of TikTok Shop product details page views attributed to your ads. Product details page views are reported based on the time each ad impression occurred. | Field IDonsite_on_web_detail |
ProductSet ID Get the ProductSet ID of the catalog. 0 means selecting all product sets.
Return when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad_group/product_set_id |
Profile Visit The number of profile visits the ad drove during the campaign. This metric is only for Boosted TikToks. | Field IDprofile_visits |
Profile Visit Rate The rate of profile visits per impression the paid ad drove during the campaign. This metric is only for Boosted TikToks. | Field IDprofile_visits_rate |
Promotion type Get the Promotion type. | Field IDad_group/external_type |
Promotion Type Get the promotion type. | Field IDpromotion_type |
Province The Province. | Field IDprovince |
Purchase (Total No.) Purchase (Total No.) (The total count is based on when you were billed.) | Field IDtotal_purchase |
Purchase Rate (%) 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.) | Field IDpurchase_rate |
Purchase Rate (%) (Website) The percentage of Purchase events out of all click events. | Field IDcomplete_payment_rate |
Purchase rate (Shop) (%) The percentage of TikTok Shop purchases from clicks on your ads. Purchases are reported based on the time each ad impression occurred. | Field IDonsite_shopping_rate |
Purchase ROAS Return on ad spend (ROAS) from purchase events. (The total count is based on when you were billed.) | Field IDtotal_active_pay_roas |
Purchase ROAS (SKAN) The total return on ad spend (ROAS) from purchase events. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_total_repetitive_active_pay_roas |
Purchase ROAS (Website) The total return on ad spend (ROAS) from Purchase events that are attributed to your ads. | Field IDcomplete_payment_roas |
Purchased user reach Get the Purchased user reach. Returned when objective_type of the related campaign is RF_REACH. | Field IDad_group/buy_reach |
Purchases (Shop) The number of TikTok Shop order submission actions attributed to your ads. Purchases are reported based on the time each ad impression occurred. | Field IDonsite_shopping |
Quarter of the year Quarter of the year | Field ID_NORMALIZED_DATE_FIELD_QUARTER |
Rate (Total No.) Rate (Total No.) (The total count is based on when you were billed.) | Field IDtotal_ratings |
Rate Rate (%) The percentage of unique rate events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDratings_rate |
Reach The Reach | Field IDreach |
Real Time Conversion The real time conversion | Field IDreal_time_conversion |
Real Time Conversion Rate The reat time conversion rate | Field IDreal_time_conversion_rate |
Real Time Cost Per Conversion The real time cost per conversion | Field IDreal_time_cost_per_conversion |
Real Time Cost Per Result Get the real time cost per result. | Field IDreal_time_cost_per_result |
Real Time Result Get the real time result. | Field IDreal_time_result |
Real Time Result rate Get the real time result rate. | Field IDreal_time_result_rate |
Real-time App Install The 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.) | Field IDreal_time_app_install |
Reason for rejection Get the Reason for rejection. | Field IDadvertiser/reason |
Registration 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.) | Field IDregistration_rate |
Result Get the result. | Field IDresult |
Result Rate Get the result rate. | Field IDresult_rate |
Result rate (SKAN) Percentage of results that happened out of all impressions on your ads. | Field IDskan_result_rate |
Results (SKAN) Number of times your ad resulted in an intended outcome based on your campaign objective and optimization goal. | Field IDskan_result |
ROAS (Shop) The return on ad spend (ROAS) from TikTok Shop gross revenue attributed to your ads. Gross revenue is reported based on the time each ad impression occurred. | Field IDonsite_shopping_roas |
ROAS goal for Value Optimization Get the ROAS goal for Value Optimization. | Field IDad_group/roas_bid |
Schedule type The schedule type can be either SCHEDULE_START_END or SCHEDULE_FROM_NOW. If you choose SCHEDULE_START_END, you need to specify a start time and an end time. If you choose SCHEDULE_FROM_NOW, you only need to specify a start time. | Field IDad_group/schedule_type |
Search (Website) The number of search events. | Field IDpage_event_search |
Search Cost (Website) The average cost of each search event. | Field IDcost_per_page_event_search |
Search Rate (%) The percentage of unique search events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDsearch_rate |
Search Rate (%) (Website) The percentage of search events out of all click events. | Field IDpage_event_search_rate |
Secondary Gal Result Rate Get the secondary goal result rate. | Field IDsecondary_goal_result_rate |
Secondary Goal Result Get the secondary goal result. | Field IDsecondary_goal_result |
Skip learning phase Whether to skip the learning stage. Optional values include: 0 (not skip), 1 (skip). | Field IDad_group/skip_learning_phase |
Spend The spend | Field IDspend |
Spend Credit (Total No.) Spend Credit (Total No.) (The total count is based on when you were billed.) | Field IDtotal_spend_credits |
Spend Credit Rate (%) The percentage of unique spend credits events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDspend_credits_rate |
Spend Credit Rate (%) (SKAN) The percentage of unique spend credit events out of all app install events. | Field IDskan_spend_credits_rate |
Split Test variables Get the Split Test variables. Optional values: TARGETING, BIDDING_OPTIMIZATION , CREATIVE. Null means that the campaign will not be a Split Test Campaign. | Field IDcampaign/split_test_variable |
Start Trial (Total No.) Start Trial (Total No.) (The total count is based on when you were billed.) | Field IDtotal_start_trial |
Start Trial Rate (%) The percentage of unique start trial events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDstart_trial_rate |
Submit Form Rate (%) (Website) The percentage of form submission events out of all click events. | Field IDform_rate |
Subscribe (Total No.) Subscribe (Total No.) (The total count is based on when you were billed.) | Field IDtotal_subscribe |
Subscribe Cost (Website) The average cost of each subscribe event. | Field IDcost_per_on_web_subscribe |
Subscribe Rate (%) The percentage of unique subscribe events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDsubscribe_rate |
Subscribe Rate (%) (Website) The percentage of subscribe events out of all click events. | Field IDon_web_subscribe_per_click |
The advertiser's country Get the The advertiser's country. | Field IDadvertiser/country |
TikTok item ID Get the ID of the TikTok post to be used as an ad. It can be obtained from Get Spark Ad post endpoint. | Field IDad/tiktok_item_id |
Timezone Get the Timezone name in the format of "Region/City" (based on the TZ database name conventions. For example, "Europe/London". | Field IDadvertiser/display_timezone |
Total Achieve Level (SKAN) The number of times a user achieved a level in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_achieve_level |
Total Achieve Level Value Total Achieve Level Value (The total count is based on when you were billed.) | Field IDtotal_achieve_level_value |
Total Achieve Level Value (SKAN) The value of achieve level events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_achieve_level_value |
Total Add Payment Info Total Add Payment Info. The total count is based on when you were billed. | Field IDtotal_add_payment_info |
Total Add Payment Info (SKAN) The number of times a user added payment info in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_add_payment_info |
Total Add to Cart Add to Cart (Total No.) (The total count is based on when you were billed.) | Field IDtotal_app_event_add_to_cart |
Total Add to Cart (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. | Field IDskan_total_add_to_cart |
Total Add to Cart Value Total Add to Cart Value (The total count is based on when you were billed.) | Field IDtotal_app_event_add_to_cart_value |
Total Add to Cart Value (SKAN) The value of add to cart events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_add_to_cart_value |
Total Add to Cart Value (Website) The total value returned from add to cart events. | Field IDtotal_web_event_add_to_cart_value |
Total Add to Wishlist Add to Wishlist (Total No.) (The total count is based on when you were billed.) | Field IDtotal_add_to_wishlist |
Total Add to Wishlist (SKAN) The number of times users added items to a wishlist in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_add_to_wishlist |
Total Add to Wishlist (Website) The number of add to wishlist events that are attributed to your ads. | Field IDon_web_add_to_wishlist |
Total Add to Wishlist Value Total Add to Wishlist Value (The total count is based on when you were billed.) | Field IDtotal_add_to_wishlist_value |
Total Add to Wishlist Value (SKAN) The value of add to wishlist events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_add_to_wishlist_value |
Total Add To Wishlist Value (Website) The total value returned from all add to wishlist events. | Field IDtotal_on_web_add_to_wishlist_value |
Total Checkout Checkout (Total No.) (The total count is based on when you were billed.) | Field IDtotal_checkout |
Total Checkout (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. | Field IDskan_total_checkout |
Total Checkout Value Total Checkout Value (The total count is based on when you were billed.) | Field IDtotal_checkout_value |
Total Checkout Value (SKAN) The value of checkout events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_checkout_value |
Total Click Button Value (Website) The total value returned from button click events. | Field IDtotal_button_click_value |
Total Complete Registration (Website) The number of user registration events. | Field IDuser_registration |
Total Complete Registration Value (Website) The total value returned from user registration events. | Field IDtotal_user_registration_value |
Total Complete Tutorial (SKAN) The number of times a user completed a tutorial in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_complete_tutorial |
Total Complete Tutorial Value Total Complete Tutorial Value (The total count is based on when you were billed.) | Field IDtotal_complete_tutorial_value |
Total Complete Tutorial Value (SKAN) The value of complete tutorial events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_complete_tutorial_value |
Total Contact (Website) The number of contact events. | Field IDonline_consult |
Total Contact Value (Website) The total value returned from contact events. | Field IDtotal_online_consult_value |
Total Create Group (SKAN) The number of groups created in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_create_group |
Total Create Group Value Total Create Group Value (The total count is based on when you were billed.) | Field IDtotal_create_group_value |
Total Create Group Value (SKAN) The value of create group events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_create_group_value |
Total Create Role (SKAN) The number of times a user created a character or role in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_total_create_gamerole |
Total Create Role Value Total Create Role Value (The total count is based on when you were billed.) | Field IDtotal_create_gamerole_value |
Total Create Role Value (SKAN) The value of create role events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_create_gamerole_value |
Total Download (Website) The number of download button click events. | Field IDdownload_start |
Total Download Value (Website) The total value returned from download button click events. | Field IDtotal_download_start_value |
Total Generate Lead (SKAN) The number of leads generated in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_sales_lead |
Total Generate Lead Value Total Generate Lead Value (The total count is based on when you were billed.) | Field IDtotal_sales_lead_value |
Total Generate Lead Value (SKAN) The value of generate lead events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_sales_lead_value |
Total In-App Ad Click (SKAN) The number of in-app ad click events that occurred in your mobile app and are attributed to your ads. | Field IDskan_total_in_app_ad_click |
Total In-App Ad Click Value Total In-App Ad Click Value (The total count is based on when you were billed.) | Field IDtotal_in_app_ad_click_value |
Total In-App Ad Click Value (SKAN) The value of in-app ad click events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_in_app_ad_click_value |
Total In-App Ad Impr Value Total In-App Ad Impr Value (The total count is based on when you were billed.) | Field IDtotal_in_app_ad_impr_value |
Total In-App Ad Impression (SKAN) The number of in-app ad impression events that occurred in your mobile app and are attributed to your ads. | Field IDskan_total_in_app_ad_impr |
Total In-App Ad Impression Value (SKAN) The value of in-app ad impression events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_in_app_ad_impr_value |
Total Initiate Checkout (Website) The number of initiate checkout events. | Field IDinitiate_checkout |
Total Initiate Checkout Value (Website) The total value returned from initiate checkout events. | Field IDtotal_initiate_checkout_value |
Total Join Group (SKAN) The number of times a user joined a group in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_total_join_group |
Total Join Group Value Total Join Group Value (The total count is based on when you were billed.) | Field IDtotal_join_group_value |
Total Join Group Value (SKAN) The value of join group events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_join_group_value |
Total Landing Page View The number of landing page view events from your ads. | Field IDtotal_landing_page_view |
Total Launch App (SKAN) The number of times a user launched your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_launch_app |
Total Loan Apply (SKAN) The number of times a user applied for a loan in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_loan_apply |
Total Loan Approval (SKAN) The number of times a user was approved for a loan in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_loan_credit |
Total Loan Disbursement (SKAN) The number of loan disbursals in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_loan_disbursement |
Total Login (SKAN) The number of logins in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_login |
Total Page Browse Value (Website) The total value returned from page browse events. | Field IDvalue_per_page_browse_view |
Total Page View The total number of page browse events.The total count is calculated based on the time each ad impression occurred. | Field IDtotal_pageview |
Total Page View Value The total value returned from page browse events. | Field IDtotal_value_per_pageview |
Total Place an Order (Website) The number of place an order events. | Field IDon_web_order |
Total Place an Order Value (Website) The total value returned from place an order events. | Field IDtotal_on_web_order_value |
Total Product Details Page Browse Value (Website) The total value returned from product details page browse events. | Field IDtotal_product_details_page_browse_value |
Total Purchase (SKAN) The number of purchases in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_purchase |
Total Purchase (Website) The number of Purchase events. | Field IDcomplete_payment |
Total Purchase Value Total Purchase Value (The total count is based on when you were billed.) | Field IDtotal_purchase_value |
Total Purchase Value (SKAN) The total value of purchase events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_purchase_value |
Total Purchase Value (Website) The total value returned from Purchase events. | Field IDtotal_complete_payment_rate |
Total Rate (SKAN) The number of ratings in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_ratings |
Total Rate Value Total Rate Value (The total count is based on when you were billed.) | Field IDtotal_ratings_value |
Total Rate Value (SKAN) The value of rate events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_ratings_value |
Total Registration Total Registration. The total count is based on when you were billed. | Field IDtotal_registration |
Total Registration (SKAN) The number of registrations in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_registration |
Total Search Total search (The total count is based on when you were billed.) | Field IDtotal_search |
Total Search (SKAN) The number of searches in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_search |
Total Search Value (Website) The total value returned from search events. | Field IDtotal_page_event_search_value |
Total Spend Credit (SKAN) The number of times a user spent credit in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_total_spend_credits |
Total Spend Credit Value Total Spend Credit Value (The total count is based on when you were billed.) | Field IDtotal_spend_credits_value |
Total Spend Credit Value (SKAN) The value of spend credit events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_spend_credits_value |
Total Start Trial (SKAN) The number of times a user started a trial in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_start_trial |
Total Submit Form (Website) The number of form submission events. | Field IDform |
Total Submit Form Value (Website) The total value returned from form submission events. | Field IDtotal_form_value |
Total Subscribe (SKAN) The number of subscriptions in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_subscribe |
Total Subscribe (Website) The number of subscribe events that are attributed to your ads. | Field IDon_web_subscribe |
Total Subscribe Value Total Subscribe Value (The total count is based on when you were billed.) | Field IDtotal_subscribe_value |
Total Subscribe Value (SKAN) The value of subscribe events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_subscribe_value |
Total Subscribe Value (Website) The total value returned from all subscribe events. | Field IDtotal_on_web_subscribe_value |
Total Unlock Achievement (SKAN) The number of times that a user unlocked an achievement in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_total_unlock_achievement |
Total Unlock Achievement Value Total Unlock Achievement Value (The total count is based on when you were billed.) | Field IDtotal_unlock_achievement_value |
Total Unlock Achievement Value (SKAN) The value of unlock achievement events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_unlock_achievement_value |
Total View Content Total View Content. The total count is based on when you were billed. | Field IDtotal_view_content |
Total View Content (SKAN) The number of times a user viewed content in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_view_content |
Total View Content Value Total View Content Value (The total count is based on when you were billed.) | Field IDtotal_view_content_value |
Total View Content Value (SKAN) The value of view content events in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_total_view_content_value |
TT App Id Get the tt app id. | Field IDtt_app_id |
TT App Name Get the tt app name. | Field IDtt_app_name |
Type of currency used by advertisers Get the Type of currency used by advertisers. | Field IDadvertiser/currency |
Types of ad redirection in the catalog Get the types of ad redirection in the catalog. Returned when the corresponding campaign objective_type is CATALOG_SALES. | Field IDad_group/dpa_retargeting_type |
Unique Achieve Level The number of unique times a user achieved a level 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.) | Field IDachieve_level |
Unique Achieve Level (SKAN) The number of unique times a user achieved a level in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_achieve_level |
Unique Add Payment Info The number of unique times a user added payment info 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.) | Field IDadd_payment_info |
Unique Add Payment Info (SKAN) The number of unique times a user added payment info in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_add_payment_info |
Unique Add Payment Info Rate (%) (SKAN) The percentage of unique add payment info events out of all app install events. | Field IDskan_add_payment_info_rate |
Unique Add to Cart 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.) | Field IDapp_event_add_to_cart |
Unique Add to Cart (SKAN) 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. | Field IDskan_add_to_cart |
Unique Add to Cart Rate (%) 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.) | Field IDapp_event_add_to_cart_rate |
Unique Add to Cart Rate (%) (SKAN) The percentage of unique add to cart events out of all app install events. | Field IDskan_add_to_cart_rate |
Unique Add to Wishlist The number of unique times users added items to a wishlist 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.) | Field IDadd_to_wishlist |
Unique Add to Wishlist (SKAN) The number of unique times users added items to a wishlist in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_add_to_wishlist |
Unique Add to Wishlist Rate (%) (SKAN) The percentage of unique add to wishlist events out of all app install events. | Field IDskan_add_to_wishlist_rate |
Unique Checkout 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. (The total count is calculated based on the time each ad impression occurred.) | Field IDcheckout |
Unique Checkout (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. | Field IDskan_checkout |
Unique Checkout Rate (%) The percentage of unique checkout events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDcheckout_rate |
Unique Checkout Rate (%) (SKAN) The percentage of unique checkout events out of all app install events. | Field IDskan_checkout_rate |
Unique Complete Tutorial The number of unique times a user completed a tutorial 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.) | Field IDcomplete_tutorial |
Unique Complete Tutorial (SKAN) The number of unique times a user completed a tutorial in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_complete_tutorial |
Unique Complete Tutorial Rate (%) (SKAN) The percentage of unique complete tutorial events out of all app install events. | Field IDskan_complete_tutorial_rate |
Unique Create Group The number of unique times a user created a group in your mobile game 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.) | Field IDcreate_group |
Unique Create Group (SKAN) The number of unique times a user created a group in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_create_group |
Unique Create Group Rate (%) (SKAN) The percentage of unique create group events out of all app install events. | Field IDskan_create_group_rate |
Unique Create Role The number of unique times a user created a character or role in your mobile game 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.) | Field IDcreate_gamerole |
Unique Create Role (SKAN) The number of unique times a user created a character or role in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_create_gamerole |
Unique Create Role Rate (%) The percentage of unique create role events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDcreate_gamerole_rate |
Unique Create Role Rate (%) (SKAN) The percentage of unique create role events out of all app install events. | Field IDskan_create_gamerole_rate |
Unique Custom Events (App) The number of unique custom app events attributed to your ads. | Field IDunique_custom_app_events |
Unique Day 1 Retention The number of unique day 1 retentions 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.) | Field IDnext_day_open |
Unique Generate Lead The number of unique leads generated 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.) | Field IDsales_lead |
Unique Generate Lead (SKAN) The number of unique leads generated in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_sales_lead |
Unique Generate Lead Rate (%) (SKAN) The percentage of unique generate lead events out of all app install events. | Field IDskan_sales_lead_rate |
Unique In-App Ad Click The number of unique in-app ad click events that occurred in your mobile app and are attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDin_app_ad_click |
Unique In-App Ad Click (SKAN) The number of unique in-app ad click events that occurred in your mobile app and are attributed to your ads. | Field IDskan_in_app_ad_click |
Unique In-App Ad Click Rate (%) (SKAN) The percentage of unique in-app ad click events out of all app install events. | Field IDskan_in_app_ad_click_rate |
Unique In-App Ad Impr The number of unique in-app ad impression events that occurred in your mobile app and are attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) | Field IDin_app_ad_impr |
Unique In-App Ad Impression (SKAN) The number of unique in-app ad impression events that occurred in your mobile app and are attributed to your ads. | Field IDskan_in_app_ad_impr |
Unique In-App Ad Impression Rate (%) (SKAN) The percentage of unique in-app ad impression events out of all app install events. | Field IDskan_in_app_ad_impr_rate |
Unique Join Group The number of unique times a user joined a group in your mobile game 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.) | Field IDjoin_group |
Unique Join Group (SKAN) The number of unique times a user joined a group in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_join_group |
Unique Join Group Rate (%) (SKAN) The percentage of unique join group events out of all app install events. | Field IDskan_join_group_rate |
Unique Launch App The number of unique times a user launched 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.) | Field IDlaunch_app |
Unique Launch App (SKAN) The number of unique times a user launched your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_launch_app |
Unique Launch App Rate (%) (SKAN) The percentage of unique launch app events out of all app install events. | Field IDskan_launch_app_rate |
Unique Loan Apply The number of unique times a user applied for a loan 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.) | Field IDloan_apply |
Unique Loan Apply (SKAN) The number of unique times a user applied for a loan in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_loan_apply |
Unique Loan Apply Rate (%) (SKAN) The percentage of unique loan apply events out of all app install events. | Field IDskan_loan_apply_rate |
Unique Loan Approval The number of unique times a user was approved a loan 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.) | Field IDloan_credit |
Unique Loan Approval (SKAN) The number of unique times a user was approved for a loan in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_loan_credit |
Unique Loan Approval Rate (%) (SKAN) The percentage of unique loan approval events out of all app install events. | Field IDskan_loan_credit_rate |
Unique Loan Disbursement The number of unique loan disbursal 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.) | Field IDloan_disbursement |
Unique Loan Disbursement (SKAN) The number of unique loan disbursals in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_loan_disbursement |
Unique Loan Disbursement Rate (%) (SKAN) The percentage of unique loan disbursals in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_loan_disbursement_rate |
Unique Login The number of unique logins 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.) | Field IDlogin |
Unique Login (SKAN) The number of unique logins in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_login |
Unique Login Rate (%) (SKAN) The percentage of unique login events out of all app install events. | Field IDskan_login_rate |
Unique payment info added rate (%) (website) The percentage of add billing events out of all click events. | Field IDadd_billing_rate |
Unique Purchase 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.) | Field IDpurchase |
Unique Purchase (SKAN) The number of unique purchases that occurred in your app and were recorded by your measurement partner. | Field IDskan_purchase |
Unique Purchase Rate (%) (SKAN) The percentage of unique purchase events out of all app install events. | Field IDskan_purchase_rate |
Unique Rate The number of unique ratings 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.) | Field IDratings |
Unique Rate (SKAN) The number of unique ratings in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_ratings |
Unique Rate Rate (%) (SKAN) The percentage of unique rate events out of all app install events. | Field IDskan_ratings_rate |
Unique Registration The 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.) | Field IDregistration |
Unique Registration (SKAN) The number of unique registrations in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_registration |
Unique Registration Rate (SKAN) The percentage of unique registration events out of all app install events. | Field IDskan_registration_rate |
Unique Search The number of unique searches 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.) | Field IDsearch |
Unique Search (SKAN) The number of unique searches in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_search |
Unique Search Rate (%) (SKAN) The percentage of unique search events out of all app install events. | Field IDskan_search_rate |
Unique Spend Credit The number of unique times a user spent credit in your mobile game 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.) | Field IDspend_credits |
Unique Spend Credit (SKAN) The number of unique times a user spent credit in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_spend_credits |
Unique Start Trial The number of unique times a user started a trial 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.) | Field IDstart_trial |
Unique Start Trial (SKAN) The number of unique times a user started a trial in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_start_trial |
Unique Start Trial Rate (%) (SKAN) The percentage of unique start trial events out of all app install events. | Field IDskan_start_trial_rate |
Unique Subscribe The number of unique subscriptions 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.) | Field IDsubscribe |
Unique Subscribe (SKAN) The number of unique subscriptions in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_subscribe |
Unique Subscribe Rate (%) (SKAN) The percentage of unique subscribe events out of all app install events. | Field IDskan_subscribe_rate |
Unique Unlock Achievement The number of unique times that a user unlocked an achievement in your mobile game 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.) | Field IDunlock_achievement |
Unique Unlock Achievement (SKAN) The number of unique times that a user unlocked an achievement in your mobile game app that were recorded as app events and attributed to your ads. | Field IDskan_unlock_achievement |
Unique Unlock Achievement Rate (%) (SKAN) The percentage of unique unlock achievement events out of all app install events. | Field IDskan_unlock_achievement_rate |
Unique View Content The number of unique times a user viewed content 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.) | Field IDview_content |
Unique View Content (SKAN) The number of unique times a user viewed content in your mobile app that were recorded as app events and attributed to your ads. | Field IDskan_view_content |
Unique View Content Rate (%) (SKAN) The percentage of unique view content events out of all app install events. | Field IDskan_view_content_rate |
Unlock Achievement (Total No.) Unlock Achievement (Total No.) (The total count is based on when you were billed.) | Field IDtotal_unlock_achievement |
Unlock Achievement Rate (%) The percentage of unique unlock achievement events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDunlock_achievement_rate |
Value per Achieve Level Value per Achieve Level (The total count is based on when you were billed.) | Field IDvalue_per_total_achieve_level |
Value per Add to Cart Value per Add to Cart (The total count is based on when you were billed.) | Field IDvalue_per_total_app_event_add_to_cart |
Value per add to cart (Shop) The average value of TikTok Shop add-to-cart actions attributed to your ads. Add-to-cart is reported based on the time each ad impression occurred. | Field IDvalue_per_onsite_on_web_cart |
Value per Add to Cart (Website) The average value returned from add to cart events. | Field IDvalue_per_web_event_add_to_cart |
Value per Add to Wishlist Value per Add to Wishlist (The total count is based on when you were billed.) | Field IDvalue_per_total_add_to_wishlist |
Value per Add To Wishlist (Website) The average value returned from each add to wishlist event. | Field IDvalue_per_on_web_add_to_wishlist |
Value per Checkout Value per Checkout (The total count is based on when you were billed.) | Field IDvalue_per_checkout |
Value per checkout initiated (Shop) The average value of TikTok Shop initiate checkout actions attributed to your ads. Initiate checkout is reported based on the time each ad impression occurred. | Field IDvalue_per_onsite_initiate_checkout_count |
Value per Click Button (Website) The average value returned from button click events. | Field IDvalue_per_button_click |
Value per Complete Registration (Website) The average value returned from user registration events. | Field IDvalue_per_user_registration |
Value per Complete Tutorial Value per Complete Tutorial (The total count is based on when you were billed.) | Field IDvalue_per_total_complete_tutorial |
Value per Contact (Website) The average value returned from contact events. | Field IDvalue_per_online_consult |
Value per Create Group Value per Create Group (The total count is based on when you were billed.) | Field IDvalue_per_total_create_group |
Value per Create Role Value per Create Role (The total count is based on when you were billed.) | Field IDvalue_per_total_create_gamerole |
Value Per Custom Event (App) The average value per custom app event attributed to your ads. | Field IDvalue_per_custom_app_event |
Value Per Custom Page Event (Website) Monetary value associated with each custom page event. | Field IDvalue_per_custom_page_event |
Value per Download (Website) The average value returned from download button click events. | Field IDvalue_per_download_start |
Value per Generate Lead Value per Generate Lead (The total count is based on when you were billed.) | Field IDvalue_per_total_sales_lead |
Value per In-App Ad Click Value per In-App Ad Click (The total count is based on when you were billed.) | Field IDvalue_per_total_in_app_ad_click |
Value per In-App Ad Impr Value per In-App Ad Impr (The total count is based on when you were billed.) | Field IDvalue_per_total_in_app_ad_impr |
Value per Initiate Checkout (Website) The average value returned from initiate checkout events. | Field IDvalue_per_initiate_checkout |
Value per Join Group Value per Join Group (The total count is based on when you were billed.) | Field IDvalue_per_total_join_group |
Value per Page Browse (Website) The average value returned from page browse events. | Field IDtotal_page_browse_view_value |
Value per Page View The average value returned from page browse events. | Field IDavg_value_per_pageview |
Value per payment info added (website) The average value returned from add billing events. | Field IDvalue_per_add_billing |
Value per Place an Order (Website) The average value returned from place an order events. | Field IDvalue_per_on_web_order |
Value per Product Details Page Browse (Website) The average value returned from product details page browse events. | Field IDvalue_per_product_details_page_browse |
Value per product page view (Shop) The average value of TikTok Shop product details page views attributed to your ads. Product details page views are reported based on the time each ad impression occurred. | Field IDvalue_per_onsite_on_web_detail |
Value per Purchase Value per Purchase (The total count is based on when you were billed.) | Field IDvalue_per_total_purchase |
Value per Purchase (Website) The average value returned from Purchase events. | Field IDvalue_per_complete_payment |
Value per Rate Value per Rate (The total count is based on when you were billed.) | Field IDvalue_per_total_ratings |
Value per Search (Website) The average value returned from search events. | Field IDvalue_per_page_event_search |
Value per Spend Credit Value per Spend Credit (The total count is based on when you were billed.) | Field IDvalue_per_total_spend_credits |
Value per Submit Form (Website) The average value returned from form submission events. | Field IDvalue_per_form |
Value per Subscribe Value per Subscribe (The total count is based on when you were billed.) | Field IDvalue_per_total_subscribe |
Value per Subscribe (Website) The average value returned from each subscribe event. | Field IDvalue_per_on_web_subscribe |
Value per Unlock Achievement Value per Unlock Achievement (The total count is based on when you were billed.) | Field IDvalue_per_total_unlock_achievement |
Value per View Content Value per View Content (The total count is based on when you were billed.) | Field IDvalue_per_total_view_content |
Video Average Watch Time Per Person The average time your video was played per person, including any time spent replaying the video. This metric is estimated. | Field IDaverage_video_play_per_user |
Video Average Watch Time Per Video View The average time your video was played per single video view, including any time spent replaying the video. | Field IDaverage_video_play |
Video Cover URL COVER URL for video creative. | Field IDvideo/video_cover_url |
Video Download Whether users can download your video ads on TikTok. Allowed values: ALLOW_DOWNLOAD ,PREVENT_DOWNLOAD Default: ALLOW_DOWNLOAD. | Field IDad_group/video_download |
Video ID Get the video ID. When TikTok posts are used as ads, video_id is invalid. You can get the the ID of a TikTok post via the tiktok_item_id field. | Field IDad/video_id |
Video Preview URL Preview URL for video creative. | Field IDvideo/preview_url |
Video Views The number of times your video starts to play. Replays will not be counted. | Field IDvideo_play_actions |
Video Views at 25% The number of times your video was played at 25% of its length. Replays will not be counted. | Field IDvideo_views_p25 |
Video Views at 50% The number of times your video was played at 50% of its length. Replays will not be counted. | Field IDvideo_views_p50 |
Video Views at 75% The number of times your video was played at 75% of its length. Replays will not be counted. | Field IDvideo_views_p75 |
Video Views at 100% The number of times your video was played at 100% of its length. Replays will not be counted. | Field IDvideo_views_p100 |
View Content Rate (%) The percentage of unique view content events out of all app install events. (The total count is calculated based on the time each ad impression occurred.) | Field IDview_content_rate |
VTA App Install The number of app install events attributed to an ad impression. | Field IDvta_app_install |
VTA App Install (SKAN) The number of app install events attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_vta_app_install |
VTA Conversion The number of conversion events attributed to an ad impression. | Field IDvta_conversion |
VTA Conversion (SKAN) The number of conversion events attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_vta_conversion |
VTA Purchase (SKAN) The number of in-app purchase events attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_vta_purchase |
VTA purchase ROAS Return on ad spend (ROAS) from purchase events attributed to someone only viewing your ad. | Field IDvta_complete_payment_roas |
VTA purchase value Total value of purchase events attributed to someone only viewing your ad. | Field IDvta_complete_payment_value |
VTA purchases (app) Number of in-app purchase events attributed to an ad impression based on information received from your measurement partner. | Field IDvta_purchase |
VTA purchases (website) Website purchase events attributed to someone only viewing your ad. | Field IDvta_complete_payment |
VTA Registration (SKAN) The number of in-app registration events attributed to an ad impression. Data may be incomplete due to SKAdNetwork (SKAN) limitations. | Field IDskan_vta_registration |
VTA registrations Number of registration events attributed to an ad impression based on information received from your measurement partner. | Field IDvta_registration |
Week of the year Week of the year | Field ID_NORMALIZED_DATE_FIELD_WEEK |
Week of the year (start Sunday) Week of the year | Field ID_NORMALIZED_DATE_FIELD_WEEK_START_SUNDAY |
Year Year such as 2017. | Field ID_NORMALIZED_DATE_FIELD_YEAR |
Year month Year and month. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH |
Year month day hour Year, month, day, and hour. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY_HOUR |
Year Quarter Year and quarter. | Field ID_NORMALIZED_DATE_FIELD_YEAR_QUARTER |
Year week Year and week. | Field ID_NORMALIZED_DATE_FIELD_YEAR_WEEK |
Try another search or reset your filters.