Skip to content
Book a demo

Connect documentation

All documentation
Documentation

TikTok Ads: Most-used fields

The table below gives information about most-used fields that you can import from TikTok Ads. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

FieldAdverity UI nameType
10_second_live_viewsMetric

The number of views where a live stream ad was watched for at least 10 seconds.

App IDDimension

A unique identifier generated in TikTok Ads Manager to confirm app ownership and enable tracking of app events via SDK and Events API.

AudienceDimension

The targeted audience for the ad campaign.

ChannelDimension

The advertising channel where the ad is displayed, such as TikTok or other supported placements.

Creative MessagingDimension

The main text content or message of the ad creative.

Creative Size LengthDimension

The length dimension (e.g., in pixels or ratio) of an ad creative's visual asset.

DateDimension

The specific date for which the data is reported.

DayofWeekDimension

The day of the week when the ad data was recorded.

FormatDimension

The format of the ad creative, such as vertical video or square image.

MonthDimension

The number representing the month.

Month-YearDimension

The year and month for which data is reported, in a format like '2024|3'.

PlatformDimension

The advertising platform where the ad was displayed, such as TikTok.

SourceDimension

The origin or channel from which the ad data is collected (e.g., TikTok Ads Manager).

TargetingDimension

The set of audience criteria, demographics, interests, and behaviors used to define who sees the advertisements.

TimeDimension

The time dimension used for reporting, often representing a specific date or period for which data is collected.

WeekAsDateDimension

The starting date of the week for which the report data is aggregated, often used as a dimension in reports.

WeekNumMetric

The sequential number of the week within a year for which the report data is aggregated.

YearDimension

The year for which data is reported.

YearMonthMetric

The year and month for which data is reported, in a format like '2024|3'.

account_idDimension

The unique identifier for the ad account.

account_nameDimension

The name of the ad account.

achieve_levelMetric

The number of times a specific achievement level was reached by users.

achieve_level_rateMetric

The rate at which users achieve a specific level, calculated as achievement level completions divided by relevant impressions or clicks.

actionsMetric

The total number of user actions or engagements with the ad.

ad_adgroup_idDimension

The unique identifier of the ad group to which the ad belongs.

ad_adgroup_nameDimension

The name of the ad group to which the ad belongs.

ad_advertiser_idDimension

The ID of the advertiser account that owns the ad.

ad_app_nameDimension

The name of the application associated with the ad, relevant for app promotion campaigns.

ad_call_to_actionDimension

The call-to-action text displayed on the ad.

ad_call_to_action_idMetric

The unique identifier for the call to action button used in the ad.

ad_campaign_automation_typeDimension

The type of automation applied to an ad campaign, influencing how it runs and optimizes its performance.

ad_campaign_idDimension

The unique identifier of the campaign to which the ad belongs.

ad_campaign_nameDimension

The name of the campaign to which the ad belongs.

ad_card_idDimension

The ID of the card creative used in the ad.

ad_click_rateMetric

The rate at which users click on an ad after viewing it, also known as Click-Through Rate (CTR).

ad_click_tracking_urlDimension

The URL used to track clicks on the ad.

ad_conversion_rateMetric

The rate at which users complete a desired action (conversion) after interacting with a specific ad.

ad_create_timeDimension

The timestamp when the ad was created.

ad_creative_authorizedDimension

Indicates whether permission is granted to display ads in the TikTok For Business Creative Center.

ad_creative_image_formatDimension

The file format of the image creative used in the ad (e.g., JPG, PNG).

ad_creative_image_heightMetric

The height of the image creative used in the ad, in pixels.

ad_creative_image_sizeDimension

The file size of the image creative used in the ad, in bytes.

ad_creative_image_urlDimension

The URL of the image used in the ad creative.

ad_creative_image_widthMetric

The width of the image creative used in the ad, in pixels.

ad_creative_video_bit_rateMetric

The bit rate of the video creative used in the ad.

ad_creative_video_durationMetric

The duration of the video creative used in the ad.

ad_creative_video_formatDimension

The file format of the video creative used in the ad (e.g., MP4, MOV).

ad_creative_video_heightMetric

The height of the video creative used in the ad, in pixels.

ad_creative_video_preview_urlDimension

The URL for a preview of the video creative used in the ad.

ad_creative_video_sizeMetric

The file size of the video creative used in the ad, in bytes.

ad_creative_video_video_cover_urlDimension

The URL of the cover image for the video creative used in the ad.

ad_creative_video_widthMetric

The width of the video creative used in the ad, in pixels.

ad_deeplinkDimension

The deep link URL configured for the ad, used to direct users to specific content within an app.

ad_deeplink_typeDimension

The type of deep link configured for the ad.

ad_display_nameDimension

The display name of the ad.

ad_external_actionDimension

The name of the shallow external action conversion event.

ad_formatDimension

The format of the ad creative (e.g., image, video, carousel).

ad_group_idDimension

The unique identifier for the ad group.

ad_group_nameDimension

The name of the ad group.

ad_idDimension

The unique identifier for the ad.

ad_id_v2Dimension

The unique identifier for an ad, representing a specific ad creative and its settings.

ad_identity_idDimension

The unique identifier for an individual ad.

ad_identity_typeDimension

The type of identity used for the ad, such as a TikTok account or business profile.

ad_image_idsDimension

A list of identifiers for images associated with the ad creative.

ad_impression_tracking_urlDimension

The URL used to track impressions of the ad.

ad_invalid_impressionsMetric

The number of ad impressions that are identified as invalid, often due to non-human traffic, fraudulent activity, or other quality control measures.

ad_invalid_spendMetric

The portion of ad spend attributed to invalid impressions or clicks for a specific ad.

ad_is_acoDimension

Indicates if the ad utilizes Automated Creative Optimization (ACO) to generate multiple creative variations.

ad_landing_page_urlDimension

The primary landing page URL for the ad.

ad_landing_page_urlsDimension

A list of URLs to which users are directed after clicking on the ad.

ad_modify_timeDimension

The timestamp when the ad was last modified.

ad_nameDimension

The name of the ad.

ad_operation_statusDimension

The current operational status of the ad, such as active, paused, or deleted.

ad_page_idDimension

The unique identifier of the page associated with the ad.

ad_pixel_idDimension

The ID of the TikTok pixel used to track events for the ad.

ad_playable_urlDimension

The URL for the playable ad creative.

ad_profile_imageMetric

The URL or identifier of the profile image associated with the ad's identity.

ad_profile_image_urlDimension

The URL of the profile image displayed with the ad.

ad_secondary_statusDimension

The secondary status of the ad, providing more granular information beyond the primary status.

ad_statusDimension

The current operational status of the ad, indicating whether it is active, paused, or otherwise.

ad_textDimension

The main text content of the ad.

ad_textsDimension

A list of text elements used in the ad creative.

ad_tiktok_item_idMetric

The unique identifier for the specific TikTok content item (e.g., video, post) used in the ad.

ad_typeDimension

The type of ad creative (e.g., single image, video, carousel).

ad_urlDimension

The destination URL associated with the ad.

ad_valid_impressionsMetric

The number of legitimate ad impressions for a specific ad, excluding any impressions identified as invalid.

ad_valid_spendMetric

The portion of ad spend attributed to valid impressions or clicks for a specific ad.

ad_video_idDimension

The ID of the video creative used in the ad.

ad_video_view_rate_2sMetric

The percentage of times an ad's video creative is viewed for at least 2 seconds.

ad_video_view_rate_6sMetric

The percentage of times an ad's video creative is viewed for at least 6 seconds.

ad_video_view_rate_p100Metric

The percentage of times an ad's video creative is viewed to 100% completion.

ad_video_view_rate_p25Metric

The percentage of times an ad's video creative is viewed to at least 25% completion.

ad_video_view_rate_p50Metric

The percentage of times an ad's video creative is viewed to at least 50% completion.

ad_video_view_rate_p75Metric

The percentage of times an ad's video creative is viewed to at least 75% completion.

add_billingMetric

The number of times users initiated adding billing information, such as credit card details.

add_billing_rateMetric

The percentage of add payment info actions on your website from all clicks attributed to your ads.

add_payment_infoMetric

The number of unique 'add payment info' actions attributed to your ads.

add_payment_info_rateMetric

The rate at which users added payment information after interacting with your ads.

add_to_wishlistMetric

The number of unique 'add to wishlist' actions attributed to your ads.

add_to_wishlist_rateMetric

The rate at which users add items to a wishlist.

adgroup_advertiser_idDimension

The unique identifier of the advertiser account that owns the ad group.

adgroup_ageDimension

The age demographic targeted by the ad group.

adgroup_age_groupsDimension

The age ranges used in targeting for your ad group.

adgroup_app_download_urlDimension

The URL where users are directed to download the app after interacting with an ad in this ad group.

adgroup_app_idDimension

The application ID associated with the ad group, primarily for app promotion campaigns.

adgroup_app_profile_page_stateDimension

The state of the app profile page associated with the ad group.

adgroup_app_typeDimension

The type of mobile application targeted by the ad group (e.g., iOS, Android).

adgroup_audienceDimension

The audience segments targeted by the ad group.

adgroup_audience_idsDimension

The unique identifiers for audience lists targeted by the ad group.

adgroup_bidMetric

The bid amount set for the ad group.

adgroup_bid_priceDimension

The bid price set for the ad group.

adgroup_bid_typeDimension

The bidding strategy or type configured for the ad group.

adgroup_billing_eventDimension

The billing event type selected for the ad group (e.g., CPM, CPC).

adgroup_brand_safetyDimension

The brand safety settings applied to the ad group.

adgroup_brand_safety_typeDimension

This field specifies the brand safety solution applied to an ad group, determining the content suitability for ad placements (e.g., no brand safety, standard inventory for most brands, limited inventory for sensitive themes, or third-party solutions).

adgroup_budgetMetric

The budget allocated to the ad group.

adgroup_budget_modeDimension

The budget pacing strategy for the ad group, indicating how the budget is allocated over time (e.g., daily or total).

adgroup_campaign_idDimension

The unique identifier of the campaign to which the ad group belongs.

adgroup_carriersDimension

The mobile carriers targeted by the ad group.

adgroup_categoryDimension

The category assigned to the ad group.

adgroup_click_attribution_windowDimension

The time frame after a click within which a conversion is attributed to the ad group.

adgroup_comment_disabledDimension

Indicates whether comments are disabled for ads within this ad group.

adgroup_conversion_bid_priceMetric

The bid amount set for a conversion event at the ad group level.

adgroup_conversion_idDimension

The identifier of the conversion event that the ad group is optimized for.

adgroup_conversion_windowDimension

The time window after an ad interaction during which a conversion is attributed to the ad group.

adgroup_create_timeDimension

The timestamp when the ad group was created.

adgroup_creative_material_modeDimension

The creative material mode setting for the ad group, indicating the type of ad creative format used (e.g., single video, image).

adgroup_daypartingMetric

The scheduling settings that define specific times of day or days of the week for ad delivery within the ad group.

adgroup_deep_bid_typeDimension

The bidding strategy for deep conversions or in-app events within the ad group.

adgroup_deep_cpa_bidMetric

The Cost Per Action (CPA) bid specifically for deep conversion events within the ad group.

adgroup_device_price_rangesDimension

This field specifies the targeted device price ranges for an ad group, allowing advertisers to reach users with devices within certain price brackets.

adgroup_download_urlDimension

The URL for downloading an app or visiting a website associated with the ad group.

adgroup_excluded_audience_idsDimension

A list of audience identifiers that are excluded from targeting for this ad group.

adgroup_frequencyMetric

The frequency cap setting for the ad group, controlling how often a user sees an ad.

adgroup_frequency_scheduleMetric

The frequency capping schedule configured for the ad group.

adgroup_genderDimension

The genders targeted for your ad group, or the genders of people who engaged with your ad.

adgroup_idDimension

The unique identifier for the ad group.

adgroup_included_custom_actionsDimension

A list of custom actions that are included for optimization within the ad group.

adgroup_interest_category_idsDimension

The IDs of interest categories targeted by the ad group.

adgroup_inventory_filter_enabledDimension

Indicates if inventory filtering is enabled for the ad group to control ad placement.

adgroup_ios14_quota_typeDimension

The iOS 14 quota type for the ad group, related to SKAdNetwork campaign limitations.

adgroup_is_new_structureDimension

Indicates whether the ad group is configured with the new campaign structure.

adgroup_keywordsDimension

The keywords used for targeting within the ad group.

adgroup_languagesDimension

The languages targeted by the ad group.

adgroup_locationDimension

The geographical location(s) targeted by the ad group.

adgroup_location_idsDimension

The geographic region IDs targeted by the ad group.

adgroup_modify_timeDimension

The timestamp when the ad group was last modified.

adgroup_nameDimension

The name of the ad group.

adgroup_network_typesDimension

The network types (e.g., Wi-Fi, mobile data) targeted by the ad group.

adgroup_operating_systemsDimension

The operating systems targeted by the ad group.

adgroup_operation_statusDimension

The current operational status of the ad group, indicating whether it is running, paused, or completed.

adgroup_opt_statusDimension

The optimization status of the ad group.

adgroup_optimization_eventDimension

The specific event the ad group is optimized for (e.g., app install, purchase).

adgroup_optimization_goalDimension

The overall goal for optimization set for the ad group.

adgroup_optimize_goalDimension

The optimization goal set for the ad group (e.g., conversions, clicks).

adgroup_pacingDimension

The pacing strategy for the ad group's budget, controlling daily spend distribution.

adgroup_pixel_idDimension

The Pixel ID used by the ad group for tracking website events.

adgroup_placement_typeDimension

The placement type where the ad group's ads will appear.

adgroup_product_sourceDimension

The source of the products advertised in the ad group, such as a product catalog.

adgroup_promotion_typeDimension

The type of promotion or objective for the ad group.

adgroup_purchased_impressionMetric

The number of impressions purchased for the ad group.

adgroup_purchased_reachDimension

The number of unique users reached for the ad group based on purchased media.

adgroup_rf_estimated_cprMetric

The estimated cost per reach for a Reach and Frequency (RF) ad group.

adgroup_rf_estimated_frequencyMetric

The estimated average number of times a user sees an ad from the reservation campaign within the ad group.

adgroup_rf_purchased_typeDimension

The purchased type for a Reach and Frequency (RF) ad group.

adgroup_schedule_end_timeDimension

The scheduled end time for the ad group to run.

adgroup_schedule_start_timeDimension

The scheduled start time for the ad group to run.

adgroup_schedule_typeDimension

The type of schedule applied to the ad group, e.g., always-on or specific hours.

adgroup_scheduled_budgetMetric

The total budget allocated for the ad group over its scheduled duration.

adgroup_secondary_optimization_eventDimension

A secondary conversion event defined for the ad group, used for optimization alongside the primary optimization event.

adgroup_secondary_statusDimension

A secondary status indicator for the ad group, providing more detail than the primary status.

adgroup_share_disabledDimension

Indicates whether sharing to third-party platforms is disabled for ads within this ad group.

adgroup_skip_learning_phaseDimension

Indicates whether the learning phase for the ad group was skipped, which is a period where the ad platform optimizes ad delivery.

adgroup_split_test_adgroup_idsDimension

Identifiers of ad groups that are part of a split test along with the current ad group.

adgroup_statistic_typeDimension

The statistical type or method used for reporting metrics at the ad group level.

adgroup_statusDimension

The current operational status of the ad group (e.g., enabled, paused).

adgroup_video_download_disabledDimension

Indicates whether the option to download videos from ads within the ad group is disabled.

adgroup_view_attribution_windowDimension

The time window during which a view of an ad group's ad can be attributed to a conversion.

ads_impression_eventsMetric

The total number of ad impression events from your mobile app counted as app events and attributed to your ads.

adset_invalid_impressionsMetric

The number of ad impressions at the ad group level that are identified as invalid.

adset_invalid_spendMetric

The portion of ad spend attributed to invalid impressions or clicks for a specific ad group.

adset_nameDimension

The name or identifier of the ad group (also known as an adset).

adset_statusDimension

The current operational status of the ad group (adset), indicating whether it is active, paused, or otherwise.

adset_valid_impressionsMetric

The number of legitimate ad impressions for a specific ad group, excluding any impressions identified as invalid.

adset_valid_spendMetric

The portion of ad spend attributed to valid impressions or clicks for a specific ad group.

advertiser_account_typeDimension

The type of the advertiser account on the TikTok Ads platform.

advertiser_addressDimension

The physical address of the advertiser.

advertiser_balanceMetric

The available balance in the advertiser's account.

advertiser_brandDimension

The brand name associated with the advertiser.

advertiser_companyDimension

The name of the advertiser's company.

advertiser_countryDimension

The country where the advertiser is located.

advertiser_create_timeDimension

The timestamp when the advertiser account was created.

advertiser_currencyDimension

The currency used by the advertiser's account.

advertiser_descriptionDimension

A description of the advertiser or their business.

advertiser_display_timezoneDimension

The display timezone configured for the advertiser's account.

advertiser_idDimension

The unique identifier for the advertiser account.

advertiser_industryMetric

The industry of the advertiser.

advertiser_languageDimension

The language set for the advertiser's account.

advertiser_license_provinceDimension

The province where the advertiser's business license is registered.

advertiser_nameDimension

The name of the advertiser.

advertiser_owner_bc_idDimension

The unique identifier of the Business Center that owns the advertiser account.

advertiser_promotion_center_provinceDimension

The province associated with the advertiser's promotion center or primary business location.

advertiser_rejection_reasonDimension

The specific reason provided for the rejection of an ad by the advertiser or the platform.

advertiser_statusDimension

The current status of the advertiser account.

advertiser_timezoneDimension

The timezone configured for the advertiser account.

aeo_typeMetric

The type of App Event Optimization used for the ad group or campaign.

ageDimension

The age of the targeted audience or users who engaged with the ad.

age_groupsDimension

A list of age groups targeted by the ad.

anchor_click_rateMetric

Percentage of anchor clicks out of all impressions on your ads.

anchor_clicksMetric

The number of clicks on anchors within video ads.

app_download_urlDimension

The URL where the application can be downloaded.

app_event_add_to_cartMetric

The number of add to cart events that occurred within an app, attributed to your ads.

app_event_add_to_cart_rateMetric

The rate at which users add items to their cart within an app.

app_idDimension

The unique identifier for the application associated with the ad.

app_installMetric

The number of app installs attributed to the ad campaign.

app_nameDimension

The display name of the promoted application.

app_promotion_typeDimension

The type of app promotion, such as app install or deep link.

app_typeDimension

The type of application (e.g., iOS, Android).

attribution_event_countDimension

The total count of events attributed to an ad.

audience_idsDimension

The unique identifiers for the audience segments targeted.

audience_nameDimension

The name or identifier of the audience targeted by the ad.

audience_ruleDimension

The defined criteria or rules used to target a specific audience for ad delivery.

audience_typeDimension

The type of audience used for targeting, such as custom audience or lookalike audience.

auto_targeting_enabledDimension

A setting that indicates whether automatic targeting expansion is enabled for an ad group or campaign, allowing the system to find a broader relevant audience.

avatar_icon_web_uriDimension

The web URI for the avatar icon used in the ad.

average_video_playMetric

The average duration a video ad was played.

average_video_play_per_userMetric

The average time your video was played per unique user, including any time spent replaying the video.

avg_value_per_pageviewMetric

The average monetary value generated for each page view event on your website or app, attributed to your ads.

balanceMetric

The current financial balance or remaining credit in the advertiser's account.

bc_companyDimension

The company associated with the Business Center in TikTok Ads.

bc_currencyDimension

The currency code used for the Business Center and advertiser account, such as USD.

bc_nameDimension

The name of the Business Center account.

bc_registered_areaDimension

The geographical area where the Business Center account is registered or operates.

bc_statusDimension

The operational status of the Business Center in TikTok Ads.

bc_timezoneDimension

The time zone set for the Business Center or ad account. This affects all time-related functions like data reporting and ad scheduling and cannot be changed after registration.

bc_typeDimension

The classification or category of the Business Center account (e.g., Advertiser, Agency).

bidMetric

The bid amount set for the ad group or campaign.

bid_display_modeDimension

The display mode for bids set at the ad group level.

bid_priceMetric

The specific bid price set for optimization goals.

bid_secondary_goalMetric

The bid set for a secondary optimization goal in an ad campaign.

bid_strategyDimension

The bidding strategy employed for the ad group or campaign (e.g., lowest cost, cost cap).

bid_typeDimension

The type of bidding strategy used, such as CPC, CPM, or oCPC.

billed_costMetric

The actual cost incurred for the ads, which has been billed.

billing_eventDimension

The event type on which billing is based (e.g., clicks, impressions).

brand_safety_partnerDimension

The third-party brand safety partner integrated with the campaign to ensure ads appear in appropriate contexts (e.g., IAS, DoubleVerify).

brand_safety_postbid_partnerDimension

The third-party partner used for post-bid brand safety measurement.

brand_safety_typeDimension

The type of brand safety applied to the ad group.

brand_safety_vast_urlDimension

The VAST URL used by a post-bid third-party partner to measure brand safety.

branded_content_disabledDimension

Indicates whether branded content features are disabled for the ad or account, impacting content disclosure and monetization.

budgetMetric

The allocated budget for a campaign or ad group.

budget_modeDimension

The mode in which the budget is managed (e.g., daily, lifetime, infinite).

budget_optimize_onDimension

Indicates whether budget optimization is enabled for a campaign or ad group. This is conceptually similar to 'Budget Optimize Switch' at the campaign level.

button_clickMetric

The number of clicks on a button within the ad creative.

button_click_rateMetric

The rate at which users click on buttons within ads.

buying_typeDimension

Refers to the method of buying ads, such as auction or reservation.

call_to_actionDimension

The call-to-action text displayed on the ad, prompting users to take a specific action.

call_to_action_idMetric

The unique identifier for the specific call-to-action button used in the ad.

campaignDimension

The name or identifier of the advertising campaign.

campaign_app_profile_page_stateDimension

The state of the app profile page associated with the campaign.

campaign_automation_typeDimension

The automation type configured for the campaign.

campaign_budgetMetric

The budget allocated to the campaign.

campaign_budget_modeDimension

The budget mode for the campaign (e.g., daily, total).

campaign_budget_optimize_onDimension

Indicates whether Campaign Budget Optimization (CBO) is enabled for the campaign. This is similar to 'Budget Optimize Switch'.

campaign_create_timeDimension

The timestamp when the campaign was created.

campaign_dedicate_typeMetric

The specific type or objective of an advertising campaign, such as an iOS14 Dedicated Campaign.

campaign_deep_bid_typeDimension

The bidding strategy used for deep conversions or in-app events at the campaign level.

campaign_idDimension

The unique identifier for the campaign.

campaign_invalid_impressionsMetric

The number of ad impressions at the campaign level that are identified as invalid.

campaign_invalid_spendMetric

The portion of ad spend attributed to invalid impressions or clicks for a specific campaign.

campaign_is_new_structureDimension

Indicates if the campaign belongs to a new advertising structure or system.

campaign_is_smart_performance_campaignDimension

Indicates if the campaign is a Smart Performance Campaign, utilizing automated optimization.

campaign_modify_timeDimension

The timestamp when the campaign was last modified.

campaign_nameDimension

The name of the campaign.

campaign_objectiveDimension

The marketing objective of the campaign (e.g., Reach, Traffic, Conversions).

campaign_objective_typeDimension

The primary objective of the advertising campaign, such as reach, traffic, or conversions.

campaign_operation_statusDimension

The current operational status of the campaign, indicating whether it is running, paused, or completed.

campaign_optimization_goalDimension

The goal for optimization set for the campaign.

campaign_product_sourceDimension

The source of the products advertised in the campaign, such as a product catalog.

campaign_rf_campaign_typeDimension

The type of reach and frequency (RF) campaign.

campaign_roas_bidMetric

The target Return On Ad Spend (ROAS) bid set for the campaign.

campaign_secondary_statusDimension

The secondary status of the campaign, providing more granular information beyond the primary status.

campaign_special_industriesDimension

Specifies if the campaign targets or is associated with special industries like Housing, Employment, or Credit.

campaign_statusDimension

The current operational status of the campaign (e.g., active, paused, deleted).

campaign_typeDimension

The type of the campaign.

campaign_valid_impressionsMetric

The number of legitimate ad impressions for a specific campaign, excluding any impressions identified as invalid.

campaign_valid_spendMetric

The portion of ad spend attributed to valid impressions or clicks for a specific campaign.

card_idMetric

The unique identifier for the card creative used in the ad.

carousel_image_indexDimension

The index of an image within a carousel ad.

carrier_idsDimension

A list of mobile carrier IDs targeted by the ad group for more precise audience reach.

cash_spendMetric

The total cash amount spent on the ad campaign.

catalog_authorized_bc_idDimension

The business center ID authorized to manage the product catalog.

catalog_enabledDimension

Indicates if a product catalog is enabled for the campaign.

catalog_idDimension

The unique identifier for a product catalog used in shopping ads.

catalog_nameDimension

The name of the product catalog associated with the ad.

category_exclusion_idsDimension

A list of content category IDs that are excluded from ad placements to enhance brand suitability and avoid undesirable content adjacencies.

checkoutMetric

The number of checkout events attributed to the ad.

checkout_rateMetric

The rate at which users initiated or completed a checkout process after interacting with your ads.

click_attribution_windowDimension

The time window during which a click can be attributed to a conversion event.

click_tracking_urlDimension

The URL used to track clicks on the ad.

clicksMetric

The total number of clicks on an ad.

clicks_on_hashtag_challengeMetric

The total number of clicks on the hashtag challenge associated with an ad during its campaign.

clicks_on_music_discMetric

The number of clicks on the music disc icon within a Spark Ad.

comment_disabledDimension

Indicates whether comments are allowed on ads for this ad group on platforms like TikTok, Vigo, and Helo.

commentsMetric

The number of comments on an ad.

complete_paymentMetric

The number of complete payment events attributed to ads.

complete_payment_rateMetric

The rate of complete payment events attributed to ads.

complete_payment_roasMetric

The Return on Ad Spend (ROAS) specifically for complete payment events.

complete_tutorialMetric

The number of times users have completed a tutorial.

complete_tutorial_rateMetric

The rate at which users complete a tutorial after interacting with an ad.

consultationMetric

The number of consultation events.

contextual_tag_idsDimension

A list of IDs for contextual tags used for targeting. This relates to the 'Contextual Tag' field.

conversionMetric

The total number of conversion events attributed to the ad.

conversion_bid_priceMetric

The bid price specifically set for conversion optimization.

conversion_rateMetric

The percentage of users who clicked on your ad and completed a desired action.

conversion_rate_v2Metric

The rate at which ad interactions lead to a desired conversion event, version 2.

conversionsMetric

The total number of conversions attributed to the ad.

costMetric

The total amount of money spent on advertising.

cost_per_1000_reachedMetric

The cost incurred for every 1000 unique users reached by the ad.

cost_per_10_second_live_viewMetric

The average cost incurred for each 10-second view of a live stream ad.

cost_per_achieve_levelMetric

The average cost for each time a user achieved a specific level within your app, attributed to your ads.

cost_per_add_billingMetric

The average cost for each 'add payment info' action on your website attributed to your ads.

cost_per_add_payment_infoMetric

The average cost for each event where a user added payment information after interacting with your ads.

cost_per_add_to_wishlistMetric

The average cost for each time a user added an item to a wishlist after interacting with your ads.

cost_per_app_event_add_to_cartMetric

The average cost incurred for each in-app 'add to cart' event.

cost_per_app_installMetric

The average cost incurred for each app install.

cost_per_button_clickMetric

The average cost incurred for each button click on an ad.

cost_per_button_click_consultationMetric

The average cost incurred for each button click event related to a consultation, within a TikTok-owned property.

cost_per_checkoutMetric

The average cost for each checkout event initiated or completed by users after interacting with your ads.

cost_per_complete_paymentMetric

The average cost incurred for each completed payment.

cost_per_complete_tutorialMetric

The average cost for each time a user completed a tutorial within your app, attributed to your ads.

cost_per_considerationMetric

The average cost incurred for each consideration event, where consideration signifies user engagement or interest in the ad.

cost_per_consultationMetric

The average cost incurred for each consultation event attributed to an ad.

cost_per_conversionMetric

The average cost incurred for each conversion attributed to your ads.

cost_per_create_gameroleMetric

The average cost for each time a user created a gamerole within your app, attributed to your ads.

cost_per_create_groupMetric

The average cost for each time a user created a group within your app, attributed to your ads.

cost_per_cta_app_installMetric

The average cost incurred for each app install resulting from a Call To Action (CTA).

cost_per_cta_conversionMetric

The average cost incurred for each conversion resulting from a Call To Action (CTA).

cost_per_cta_purchaseMetric

The average cost for each payment event attributed to clicks on a Call-to-Action.

cost_per_cta_registrationMetric

The average cost incurred for each registration resulting from a Call To Action (CTA).

cost_per_custom_app_eventMetric

The average cost incurred for each custom in-app event.

cost_per_custom_page_eventMetric

The average cost incurred for each custom page event on a website.

cost_per_download_buttonMetric

The average cost for each click on a download button on the advertiser's website.

cost_per_download_detailMetric

The average cost incurred for each instance where a user views the detailed information related to a download, prior to initiating the download.

cost_per_download_startMetric

The average cost for each time a user initiated an app download after interacting with your ads.

cost_per_engaged_view_through_conversionMetric

The average cost incurred for each conversion attributed to an engaged view-through.

cost_per_formMetric

The average cost incurred for each form submission.

cost_per_form_buttonMetric

The average cost incurred for each click on a form submission button, leading to a lead generation or information capture.

cost_per_form_detailMetric

The average cost incurred for each instance where a user views detailed information on a form, typically before completing or submitting it.

cost_per_in_app_ad_clickMetric

The average cost for each click on an ad displayed within your mobile app, attributed to your ads.

cost_per_in_app_ad_imprMetric

The average cost for each impression of an ad displayed within your mobile app, attributed to your ads.

cost_per_initiate_checkoutMetric

The average cost for each time a user initiated the checkout process after interacting with your ads.

cost_per_ix_button_click_countMetric

The average cost incurred for each button click within an Instant Experience (IX) ad format. Instant Experience ads are full-screen, interactive landing pages on TikTok.

cost_per_ix_page_view_countMetric

The average cost incurred for each page view within an Instant Experience (IX) ad format. Instant Experience ads are full-screen, interactive landing pages on TikTok.

cost_per_ix_product_click_countMetric

The average cost incurred for each product click within an Instant Experience (IX) ad format, indicating user engagement with products showcased in the IX.

cost_per_join_groupMetric

The average cost for each time a user joined a group within your app, attributed to your ads.

cost_per_landing_page_viewMetric

The average cost incurred for each landing page view.

cost_per_launch_appMetric

The average cost for each time a user launched your app after interacting with your ads.

cost_per_live_viewMetric

The average cost incurred for each view of a live stream ad.

cost_per_loan_applyMetric

The average cost for each time a user applied for a loan after interacting with your ads.

cost_per_loan_creditMetric

The average cost for each time a user received loan credit after interacting with your ads.

cost_per_loan_disbursementMetric

The average cost for each time a loan was disbursed to a user after they interacted with your ads.

cost_per_loginMetric

The average cost for each time a user logged into your app or service after interacting with your ads.

cost_per_next_day_openMetric

The average cost incurred for each app open on the day following installation.

cost_per_offline_add_payment_info_eventMetric

The average cost incurred for each offline 'Add Payment Info' event, attributed to your ads.

cost_per_offline_add_to_cart_eventMetric

The average cost for each offline 'add to cart' event, attributed to ad campaigns.

cost_per_offline_add_to_wishlist_eventMetric

The average cost for each offline 'add to wishlist' event, attributed to ad campaigns.

cost_per_offline_click_button_eventMetric

The average cost for each offline 'click button' event, attributed to ad campaigns.

cost_per_offline_complete_registration_eventMetric

The average cost for each offline 'complete registration' event, attributed to ad campaigns.

cost_per_offline_contact_eventMetric

The average cost for each offline 'contact' event, attributed to ad campaigns.

cost_per_offline_download_eventMetric

The average cost for each offline 'download' event, attributed to ad campaigns.

cost_per_offline_form_eventMetric

The average cost incurred for each offline 'form submission' event.

cost_per_offline_initiate_checkout_eventMetric

The average cost for each offline 'initiate checkout' event, attributed to ad campaigns.

cost_per_offline_place_order_eventMetric

The average cost for each offline 'place order' event, attributed to ad campaigns.

cost_per_offline_search_eventMetric

The average cost for each offline 'search' event, attributed to ad campaigns.

cost_per_offline_shopping_eventMetric

The average cost for each offline 'shopping' event, attributed to ad campaigns.

cost_per_offline_subscribe_eventMetric

The average cost incurred for each offline 'subscribe' event.

cost_per_offline_view_content_eventMetric

The average cost for each offline 'view content' event, attributed to ad campaigns.

cost_per_on_web_add_to_wishlistMetric

The average cost incurred for each 'add to wishlist' event that occurred on the website.

cost_per_on_web_orderMetric

The average cost incurred for each order placed on a website.

cost_per_on_web_subscribeMetric

The average cost incurred for each 'subscribe' event that occurred on the website.

cost_per_online_consultMetric

The average cost for each online consultation event attributed to your ads.

cost_per_onsite_add_billingMetric

The average cost for each 'add billing information' event that occurs directly on the advertiser's website after an ad interaction.

cost_per_onsite_add_to_wishlistMetric

The average cost for each 'add to wishlist' event that occurs directly on the advertiser's website after an ad interaction.

cost_per_onsite_destination_visitMetric

The average cost incurred for each visit to a specific destination page on the advertiser's website, initiated by an ad click.

cost_per_onsite_download_startMetric

The average cost for each 'download start' event that occurs directly on the advertiser's website after an ad interaction.

cost_per_onsite_formMetric

The average cost incurred for each form submission event on the advertiser's website.

cost_per_onsite_initiate_checkout_countDimension

The average cost incurred for each 'initiate checkout' event that occurred on the advertiser's website.

cost_per_onsite_on_web_cartDimension

The average cost for each 'add to cart' event that occurs directly on the advertiser's website after an ad interaction.

cost_per_onsite_on_web_detailMetric

The average cost for each 'view product detail' event that occurs directly on the advertiser's website after an ad interaction.

cost_per_onsite_shoppingDimension

The average cost associated with a shopping-related event (e.g., product view, add to cart) occurring on the advertiser's website after an ad interaction.

cost_per_orderMetric

The average cost incurred for each order.

cost_per_page_browse_consultationMetric

The average cost incurred for a user browsing or viewing a page specifically related to a consultation, attributed to an ad.

cost_per_page_browse_viewMetric

The average cost for each page browse or view event on your website or app, attributed to your ads.

cost_per_page_content_view_eventMetric

The average cost incurred for each instance where a user views the content of a page, typically tracked as a specific event.

cost_per_page_event_searchMetric

The average cost incurred for each search event on a landing page.

cost_per_pageviewMetric

The average cost incurred for each page view attributed to the ad.

cost_per_product_details_page_browseMetric

The average cost for each view of a product details page on your website or app, attributed to your ads.

cost_per_purchaseMetric

The average cost incurred for each purchase.

cost_per_ratingsMetric

The average cost for each time a user submitted a rating after interacting with your ads.

cost_per_registrationMetric

The average cost for each new user registration attributed to your ads.

cost_per_resultMetric

The average cost incurred for each desired result (e.g., conversion, click) achieved by your ads.

cost_per_sales_leadMetric

The average cost incurred for generating a sales lead, attributed to your ads.

cost_per_searchMetric

The average cost incurred for each search action.

cost_per_secondary_goal_resultDimension

The average cost incurred for each achievement of a secondary goal result, attributed to your ads.

cost_per_spend_creditsMetric

The average cost for each time a user spent credits within your app or service, attributed to your ads.

cost_per_start_trialMetric

The average cost for each time a user started a trial for your service or product, attributed to your ads.

cost_per_subscribeMetric

The average cost incurred for each subscription event, attributed to your ads.

cost_per_total_achieve_levelMetric

The total average cost for all times a user achieved a specific level within your app, attributed to your ads.

cost_per_total_add_to_wishlistMetric

The total average cost for all times a user added an item to a wishlist after interacting with your ads.

cost_per_total_app_event_add_to_cartMetric

The average cost incurred for each 'add to cart' app event.

cost_per_total_checkoutMetric

The average cost incurred for each total checkout completion event attributed to your ads.

cost_per_total_complete_tutorialMetric

The total average cost for all times a user completed a tutorial within your app, attributed to your ads.

cost_per_total_create_gameroleMetric

The total average cost for all times a user created a gamerole within your app, attributed to your ads.

cost_per_total_create_groupMetric

The total average cost for all times a user created a group within your app, attributed to your ads.

cost_per_total_in_app_ad_clickMetric

The total average cost for all clicks on ads displayed within your mobile app, attributed to your ads.

cost_per_total_in_app_ad_imprMetric

The total average cost for all impressions of ads displayed within your mobile app, attributed to your ads.

cost_per_total_join_groupMetric

The total average cost for all times a user joined a group within your app, attributed to your ads.

cost_per_total_launch_appMetric

The total average cost for all times a user launched your app after interacting with your ads.

cost_per_total_loan_applyMetric

The total average cost for all times a user applied for a loan after interacting with your ads.

cost_per_total_loan_creditMetric

The total average cost for all times a user received loan credit after interacting with your ads.

cost_per_total_loan_disbursementMetric

The total average cost for all loan disbursements to users after they interacted with your ads.

cost_per_total_loginMetric

The total average cost for all times a user logged into your app or service after interacting with your ads.

cost_per_total_next_day_openMetric

The average cost for each Day 1 retention (unique next-day open) of your app attributed to your ads.

cost_per_total_purchaseMetric

The average cost for each purchase event attributed to your ads, encompassing all purchases.

cost_per_total_ratingsMetric

The total average cost for all user ratings submitted after interacting with your ads.

cost_per_total_registrationMetric

The total average cost for all new user registrations attributed to your ads.

cost_per_total_sales_leadMetric

The average cost incurred for each total sales lead generated, attributed to your ads.

cost_per_total_searchMetric

The average cost incurred for all search actions.

cost_per_total_spend_creditsMetric

The total cost incurred for all instances where users spent credits, attributed to an ad.

cost_per_total_start_trialMetric

The average cost incurred for each instance where a user initiates a trial period for a product or service after interacting with an ad.

cost_per_total_subscribeMetric

The average cost incurred for each total subscription event, attributed to your ads.

cost_per_total_unlock_achievementMetric

The average cost incurred for each instance where a user unlocks an achievement within an application or game after engaging with an ad.

cost_per_total_view_contentMetric

The average cost incurred for all content view events.

cost_per_unique_ad_impression_eventMetric

The average cost incurred for each unique ad impression event.

cost_per_unique_custom_app_eventMetric

The cost incurred per unique custom app event.

cost_per_unlock_achievementMetric

The average cost incurred for each instance where a user unlocked an achievement, attributed to an ad.

cost_per_user_registrationMetric

The average cost incurred for each new user registration attributed to an ad.

cost_per_view_contentMetric

The average cost incurred for each view content event.

cost_per_vta_app_installMetric

The average cost for each app installation attributed via view-through attribution (VTA), meaning the user saw an ad but did not click it before installing.

cost_per_vta_conversionMetric

The average cost incurred for a conversion that is attributed to an ad view (View-Through Attribution), where the user saw the ad but did not click.

cost_per_vta_purchaseMetric

The average cost incurred for a purchase that is attributed to an ad view (View-Through Attribution), where the user saw the ad but did not click.

cost_per_vta_registrationMetric

The average cost incurred for a user registration that is attributed to an ad view (View-Through Attribution), where the user saw the ad but did not click.

cost_per_web_event_add_to_cartMetric

The average cost incurred for each 'add to cart' web event.

cost_pre_ad_impression_eventMetric

The average cost incurred for each ad impression event. This represents the cost of showing an ad to a user.

cost_total_add_payment_infoMetric

The total cost incurred for users initiating adding payment information, attributed to the ad.

cost_usdMetric

The total cost incurred in United States Dollars (USD) for the advertising entity.

countdown_sticker_recall_clicksMetric

Number of clicks on a reminder from the countdown sticker to a specified destination.

countryDimension

The country associated with the ad account or targeted by the ad.

country_codeDimension

The two-letter ISO 3166-1 code for the country associated with the advertiser or targeted by the ad.

cpcMetric

Cost Per Click, the average cost for each click on your ad.

cpmMetric

Cost Per Mille, the average cost for 1000 impressions of your ad.

cpv_video_durationDimension

The video duration threshold for Cost Per View (CPV) billing at the ad group level.

create_gameroleMetric

The number of unique app create role actions attributed to your ads.

create_gamerole_rateMetric

The rate at which users create a game role within an application.

create_groupMetric

The number of unique app create group actions attributed to your ads.

create_group_rateMetric

The rate at which users create a group within an application or platform.

create_timeDimension

The timestamp when the object (e.g., campaign, ad group) was created.

creative_authorizedDimension

Indicates if the creative is authorized for use or display in the TikTok Creative Center.

creative_delivery_statusDimension

The current status of an ad creative, indicating its approval, rejection, or delivery state.

creative_material_modeDimension

The mode or type of creative material used in the ad.

creative_preview_final_urlDimension

The URL for a preview of the ad creative or its final landing page.

creative_typeDimension

The format or type of the ad creative, such as single image, video, or carousel.

cta_app_installMetric

The number of app installs triggered by a Call To Action (CTA).

cta_conversionMetric

The number of conversions triggered by a Call To Action (CTA).

cta_purchaseMetric

The number of purchases attributed to clicks on a Call-to-Action button.

cta_registrationMetric

The number of registrations triggered by a Call To Action (CTA).

ctrMetric

Click-Through Rate, the percentage of users who click on your ad after seeing it.

currencyDimension

The currency in which the financial data is reported.

custom_app_event_rateMetric

The rate at which users complete custom in-app events.

custom_app_eventsMetric

The total number of custom events that occurred within an app, attributed to ads.

custom_app_events_valueMetric

The total monetary value associated with custom in-app events.

custom_event_typeDimension

The user-defined type or name of a custom event tracked for conversion or action monitoring.

custom_page_event_rateMetric

The rate at which users complete custom page events on a website.

custom_page_eventsMetric

The total number of custom events that occurred on a webpage, attributed to ads.

custom_page_events_valueMetric

The total monetary value associated with custom webpage events.

customized_ad_impression_event_rateMetric

The rate at which a specific, customized ad impression event occurs, calculated as the number of customized impression events divided by total impressions.

dark_post_statusDimension

The status of a 'dark post' ad, which is an unpublished post used for advertising.

dateDimension

The date for which the data is reported.

daypartingMetric

The schedule for displaying ads during specific times of the day or certain days of the week.

deep_bid_typeDimension

The bidding strategy used for in-app events. This is similar to 'Campaign Deep Bid Type'.

deep_cpa_bidMetric

A bidding strategy focused on optimizing for a specific cost-per-action (CPA) for 'deep' conversion events, which occur further down the conversion funnel.

deeplinkDimension

The deeplink URL that directs users to specific content within an app.

deeplink_format_typeDimension

Specifies the format type of the deep link used in the ad.

deeplink_typeDimension

The type of deeplink used for the ad.

deeplink_utm_paramsDimension

A list of UTM parameters appended to deep links for tracking campaign performance.

delivery_modeDimension

The delivery mode for an ad group, affecting how ads are served.

descriptionDimension

The main text content that provides details about the ad or advertised product/service.

deviceDimension

The type of device on which the ad was displayed (e.g., mobile, tablet).

device_brand_idDimension

The identifier for the brand of the device on which the ad was displayed.

device_brand_nameDimension

The name of the brand of the device on which the ad was displayed.

device_categoryDimension

The category of device (e.g., mobile, desktop) on which the ad was displayed.

device_model_idsDimension

The IDs of specific device models targeted by the campaign or ad group.

device_price_rangesDimension

Defines the price ranges of user devices that are targeted for ad delivery.

device_typeDimension

The specific type or brand of device used by the audience viewing the ad.

disable_skan_campaignDimension

Indicates whether SKAdNetwork (SKAN) attribution, Apple's conversion attribution solution for iOS campaigns, is disabled for the campaign. This is similar to 'Campaign Disable SKAN'.

disclaimer_clickable_textsDimension

A list of clickable text elements and their corresponding URLs for disclaimers in the ad.

disclaimer_textDimension

The text content of a standard disclaimer displayed in the ad, with a maximum of 90 characters.

disclaimer_typeDimension

The type of disclaimer used in the ad, such as standard, clickable, or AI-generated content.

discount_amountDimension

The total monetary value of discounts applied to TikTok Shop orders attributed to ads.

discount_percentageDimension

The percentage of the discount applied to ad charges, often part of an advertiser incentive or coupon program.

discount_typeDimension

The type of discount offered, such as a percentage off or a fixed amount (e.g., Discount Coupon, Ladder Coupon).

display_nameDimension

The user-friendly name for a field or entity.

display_timezoneDimension

The timezone used for displaying report data.

dma_idDimension

The identifier for the Designated Market Area (DMA) where the ad was shown.

dma_nameDimension

The name of the Designated Market Area (DMA) where the ad was shown.

download_buttonMetric

The number of clicks on a download button in the ad.

download_startMetric

The number of times a download initiated after ad interaction.

download_start_rateMetric

The rate at which users initiate a download after interacting with an ad.

dpa_target_audience_typeMetric

The target audience type for Dynamic Product Ads (DPA).

duet_clicksMetric

The number of clicks on the 'Duet' button associated with an ad.

durationMetric

The duration of the video or audio creative in seconds.

dynamic_destinationDimension

The dynamic destination setting for ads, which can include dynamic landing pages.

dynamic_formatDimension

The dynamic format used for ad creatives, often for dynamic product ads.

engaged_viewMetric

The number of engaged views on a video ad.

engaged_view_15sMetric

The number of times a video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad.

engaged_view_attribution_windowDimension

The time window during which an engaged view can be attributed to a conversion.

engaged_view_through_conversionsMetric

The number of conversions attributed to users who saw an ad and engaged with it without clicking, within the attribution window.

engagement_rateMetric

The percentage of engagements (likes, comments, shares, follows, clicks) an ad receives relative to its impressions.

engagementsMetric

The total number of engagements with the ad (e.g., likes, comments, shares).

event_nameDimension

The name of a specific event tracked by the TikTok Ads platform.

eventsMetric

The total number of occurrences for a specific event.

excluded_audience_idsDimension

The IDs of audience segments that are explicitly excluded from targeting.

excluded_custom_actionsDimension

A list of custom actions or events that are explicitly excluded from being tracked or used for audience targeting and optimization within an ad group.

fallback_typeDimension

The fallback mechanism or type used when a primary ad action or destination fails.

feed_typeDimension

The type of feed associated with the ad group.

followsMetric

The number of new followers gained due to the ad.

formMetric

The number of form submission events.

form_buttonMetric

The number of times users clicked a form button, attributed to your ads.

form_detailMetric

The number of details page browse events from forms.

form_fillsMetric

The total number of form submissions attributed to ad interactions.

form_rateMetric

The percentage of website lead actions from all clicks attributed to your ads.

frequencyMetric

The average number of times an ad was shown to a unique user.

frequency_lifetimeMetric

The average number of times each unique user saw your ads over the entire lifetime of the campaign.

frequency_mtdMetric

The average number of times a unique user has seen your ad, measured from the beginning of the month to the current date.

frequency_scheduleMetric

The schedule configured for the ad group that controls how often a user sees an ad within a specified period (frequency capping).

genderDimension

The gender of the targeted audience or users who engaged with the ad.

gross_impressionsMetric

The total number of times an ad was shown.

gross_revenueMetric

The total revenue generated before any deductions.

household_incomeDimension

The estimated household income of the audience reached by the ads, used for targeting or reporting.

identity_authorized_bc_idMetric

The ID of the Business Center authorized for the ad's identity.

identity_idDimension

The unique identifier for the identity (e.g., brand profile) associated with the ad.

identity_typeDimension

The type of identity (e.g., TikTok account, business profile) used to represent the advertiser in the ad.

image_idDimension

The unique identifier for an image creative used in an ad.

image_idsDimension

A list of unique identifiers for images used in the ad creative.

impression_tracking_urlDimension

The URL used to track impressions for the ad.

impressionsMetric

The total number of times an ad was shown.

in_app_ad_clickMetric

The number of clicks on an ad within an application.

in_app_ad_click_rateMetric

The rate at which users click on an ad displayed within an application.

in_app_ad_imprMetric

The number of unique in-app ad impression events attributed to your ads.

in_app_ad_impr_rateMetric

The rate at which in-app ad impressions occur.

included_custom_actionsDimension

A list of custom actions or events that are specifically included for tracking, audience targeting, or optimization purposes within an ad group.

industryMetric

The primary business sector or vertical to which the advertiser belongs or the ad relates.

initiate_checkoutMetric

The number of times a user started the checkout process after interacting with an ad.

initiate_checkout_rateMetric

The rate at which users initiated a checkout process, attributed to your ads.

interactive_add_on_activity_clicksMetric

The number of clicks on interactive add-ons within the ad, such as polls, quizzes, or other engagement features.

interactive_add_on_destination_clicksMetric

The number of clicks on destinations linked from interactive add-ons within the ad.

interactive_add_on_impressionsMetric

The number of impressions for interactive add-ons in an ad.

interactive_add_on_option_a_clicksMetric

The number of clicks on option A of an interactive add-on in an ad.

interactive_add_on_option_b_clicksMetric

The number of clicks on option B of an interactive add-on in an ad.

interest_categoryMetric

The broad category of user interests targeted by the ad group.

interest_category_idsDimension

The IDs of interest categories targeted by the campaign or ad group.

interest_category_nameDimension

The name of the interest category targeted.

interest_category_tier2Metric

A second-tier category for audience interest targeting.

interest_category_tier3Metric

The third-level category representing user interests targeted by ad campaigns.

interest_category_tier4Metric

The fourth-level category representing user interests targeted by ad campaigns.

interest_keyword_idsDimension

A list of unique identifiers for specific interests or keywords used to target audiences.

inventory_filter_enabledDimension

Indicates if inventory filtering is enabled, allowing advertisers to control the type of content next to which their ads appear.

ios14_quota_typeDimension

A field related to the campaign's measurement and attribution settings in the context of iOS 14 privacy changes, affecting ad performance tracking.

ios14_targetingDimension

Indicates whether targeting specific to iOS 14 privacy settings is enabled or configured.

is_acoDimension

Indicates whether Automated Creative Optimization (ACO) is enabled for the ad.

is_advanced_dedicated_campaignDimension

Indicates whether the campaign is an Advanced Dedicated Campaign, leveraging advanced delivery models.

is_new_structureDimension

Indicates if the campaign uses the new campaign structure.

is_search_campaignDimension

Indicates whether the campaign is a Search Campaign.

is_smart_creativeDimension

Indicates whether the ad is a Smart Creative ad.

is_smart_performance_campaignDimension

Indicates whether the campaign is an automated campaign type.

isp_idsDimension

A list of Internet Service Provider (ISP) IDs targeted by the ad group.

item_duet_statusDimension

The duet status of the TikTok item used in the ad creative.

item_group_idDimension

The identifier for a group of items within a product catalog.

item_group_idsDimension

A list of identifiers used to group product variants, helping to optimize ad recommendations.

item_idDimension

A unique identifier for an item, typically referring to a product within an ad catalog.

item_stitch_statusDimension

The stitch status of the TikTok item used in the ad creative.

ix_average_video_playMetric

The average duration of video playback.

ix_button_click_countMetric

The total number of clicks on buttons within an Instant Experience ad.

ix_button_click_count_rateMetric

The rate of button clicks within an Instant Experience (IX) ad, calculated as the number of IX button clicks divided by relevant impressions or views.

ix_page_duration_avgMetric

Average duration users spent on a webpage after interacting with an ad. This is a page event metric.

ix_page_view_countMetric

The total number of page views within an Instant Experience ad.

ix_page_view_count_rateMetric

The rate of page views within an Instant Experience (IX) ad, calculated as the number of IX page views divided by relevant impressions or views.

ix_page_viewrate_avgMetric

The average page view rate for Instant Experience (IX) ads, indicating how often users view pages within the IX after engaging with the ad.

ix_product_click_countMetric

The total number of clicks on products displayed within an Instant Experience (IX) ad, showing user interest in specific products.

ix_product_click_count_rateMetric

The rate of product clicks within an Instant Experience (IX) ad, calculated as the number of IX product clicks divided by relevant impressions or views.

ix_video_viewsMetric

The number of video views within an Instant Experience ad.

ix_video_views_p100Metric

The number of interactive video views completed 100%.

ix_video_views_p25Metric

The number of interactive video views completed 25%.

ix_video_views_p50Metric

The number of interactive video views completed 50%.

ix_video_views_p75Metric

The number of interactive video views completed 75%.

join_groupMetric

The number of times users joined a group or community after interacting with an ad.

join_group_rateMetric

The rate at which users join a group within an application or platform.

landing_page_urlDimension

The URL of the landing page where users are directed after clicking the ad.

landing_page_view_rateMetric

The percentage of users who viewed the landing page after interacting with an ad.

languageDimension

The primary language of the advertiser or the ad.

languagesDimension

A list of languages targeted by the ad or campaign.

launch_appMetric

The number of times users launched the app, attributed to your ads.

launch_app_rateMetric

The rate at which users launched the app, attributed to your ads.

likesMetric

The number of likes on an ad.

live_effective_viewsMetric

The number of times viewers visited your LIVE for more than 10 seconds. Revisits are counted.

live_followsMetric

The number of new followers gained during live stream ads.

live_nameDimension

The name or title of a live stream event or live shopping campaign.

live_product_clicksMetric

The number of times viewers clicked a product and viewed its details page during a LIVE ad.

live_statusDimension

The current operational status of a live stream event or live shopping campaign (e.g., live, ended).

live_unique_viewsMetric

The number of unique viewers who entered your LIVE stream.

live_viewsMetric

The total number of times viewers visited your LIVE stream. Revisits are counted.

loan_applyMetric

The number of unique app loan application actions attributed to your ads.

loan_apply_rateMetric

The rate at which users submit a loan application after interacting with an ad.

loan_creditMetric

The number of unique app loan approval actions attributed to your ads.

loan_credit_rateMetric

The rate at which users are granted credit or a loan after interacting with an ad, often representing a deeper conversion event.

loan_disbursementMetric

The number of unique app loan disbursal actions attributed to your ads.

loan_disbursement_rateMetric

The rate at which loan funds are successfully disbursed to users who applied through an ad campaign.

location_idsDimension

The IDs of geographic locations targeted by the campaign or ad group.

loginMetric

The number of times users have logged into an application or service.

login_rateMetric

The rate at which users log into a service or application after interacting with an ad.

material_idMetric

The unique identifier for an ad creative asset, such as an image or video, used in a campaign.

max_delivery_budgetMetric

The maximum budget allowed for ad delivery.

media_channelDimension

The advertising channel where the ad is displayed, such as TikTok or other supported placements.

media_channel_groupDimension

A grouping of different media channels where ads are displayed, such as social media or search.

min_android_versionDimension

The minimum Android operating system version targeted.

min_ios_versionDimension

The minimum iOS operating system version targeted.

mobile_app_idMetric

The unique identifier of the mobile application.

modify_timeDimension

The timestamp indicating when the ad, ad group, or campaign was last modified.

music_idMetric

The unique identifier for the music or audio track used in the ad creative.

nameDimension

The name of the campaign, ad group, or ad.

net_costMetric

The total advertising cost after any deductions or adjustments.

network_typesDimension

The network types (e.g., Wi-Fi, mobile data) targeted by the campaign.

next_day_openMetric

The number of unique Day 1 retentions attributed to your ads.

next_day_open_rateMetric

The percentage of users who open an app or revisit a website on the day following their initial interaction with an ad, measuring retention.

next_day_retentionDimension

The number of unique Day 1 retentions attributed to your ads. This refers to users who launch the app again the day after installing.

objectiveDimension

The primary advertising objective for the campaign or ad group (e.g., reach, conversions).

objective_typeDimension

The type of objective set for the campaign or ad group.

offline_add_payment_info_event_rateMetric

The rate at which offline 'Add Payment Info' events occur, calculated as the number of such events divided by relevant impressions or clicks.

offline_add_payment_info_eventsMetric

The total number of offline 'Add Payment Info' events attributed to your ads.

offline_add_payment_info_events_valueMetric

The total monetary value generated from offline 'add payment info' events attributed to ad interactions.

offline_add_to_cart_event_rateMetric

The rate at which offline 'add to cart' events occur, attributed to ad campaigns.

offline_add_to_cart_eventsMetric

The number of offline add to cart events attributed to your ads.

offline_add_to_cart_events_valueMetric

The total value of offline add to cart events attributed to your ads.

offline_add_to_wishlist_event_rateMetric

The rate at which offline 'add to wishlist' events occur, attributed to ad campaigns.

offline_add_to_wishlist_eventsMetric

The total number of offline 'add to wishlist' events, attributed to ad campaigns.

offline_add_to_wishlist_events_valueMetric

The total monetary value generated from offline 'add to wishlist' events attributed to ad interactions.

offline_click_button_event_rateMetric

The rate at which offline 'click button' events occur, attributed to ad campaigns.

offline_click_button_eventsMetric

The total number of offline 'click button' events, attributed to ad campaigns.

offline_click_button_events_valueMetric

The total monetary value generated from offline 'click button' events attributed to ad interactions.

offline_complete_registration_event_rateMetric

The rate at which offline 'complete registration' events occur, attributed to ad campaigns.

offline_complete_registration_eventsMetric

The number of complete registration events recorded offline, attributed to ad interactions.

offline_complete_registration_events_valueMetric

The total monetary value generated from offline 'complete registration' events attributed to ad interactions.

offline_contact_event_rateMetric

The rate at which offline 'contact' events occur, attributed to ad campaigns.

offline_contact_eventsMetric

The number of contact events (e.g., phone calls, messages) recorded offline, attributed to ad interactions.

offline_contact_events_valueMetric

The total monetary value generated from offline 'contact' events attributed to ad interactions.

offline_cost_per_custom_eventMetric

The average cost for each custom event that occurs offline, attributed to ad campaigns.

offline_custom_event_rateMetric

The rate at which custom events occur offline, attributed to ad campaigns.

offline_download_event_rateMetric

The rate at which offline 'download' events occur, attributed to ad campaigns.

offline_download_eventsMetric

The number of offline download events attributed to your ads.

offline_download_events_valueMetric

The total monetary value generated from offline 'download' events attributed to ad interactions.

offline_form_event_rateMetric

The rate at which offline 'form submission' events occur, attributed to ad interactions.

offline_form_eventsMetric

The number of form submission events recorded offline, attributed to ad interactions.

offline_form_events_valueMetric

The total monetary value generated from offline 'form submission' events attributed to ad interactions.

offline_initiate_checkout_event_rateMetric

The rate at which offline 'Initiate Checkout' events occur, calculated as the number of such events divided by relevant impressions or clicks.

offline_initiate_checkout_eventsMetric

The number of 'initiate checkout' events recorded offline, attributed to ad interactions.

offline_initiate_checkout_events_valueMetric

The total monetary value generated from offline 'initiate checkout' events attributed to ad interactions.

offline_place_order_event_rateMetric

The rate at which offline 'place order' events occur, attributed to ad campaigns.

offline_place_order_eventsMetric

The number of 'place order' events recorded offline, attributed to ad interactions.

offline_place_order_events_valueMetric

The total monetary value generated from offline 'place order' events attributed to ad interactions.

offline_search_event_rateMetric

The rate at which offline 'search' events occur, attributed to ad campaigns.

offline_search_eventsMetric

The number of offline search events attributed to the ad campaign.

offline_search_events_valueMetric

The total value generated from offline search events.

offline_shopping_event_rateMetric

The rate at which offline 'shopping' events occur, attributed to ad campaigns.

offline_shopping_eventsMetric

The number of offline shopping events attributed to your ads.

offline_shopping_events_roasMetric

The Return On Ad Spend (ROAS) generated from offline shopping events.

offline_shopping_events_valueMetric

The total value of offline shopping events attributed to your ads.

offline_subscribe_event_rateMetric

The rate at which offline 'subscribe' events occur, attributed to ad interactions.

offline_subscribe_eventsMetric

The number of 'subscribe' events recorded offline, attributed to ad interactions.

offline_subscribe_events_valueMetric

The total monetary value generated from offline 'subscribe' events attributed to ad interactions.

offline_total_custom_event_valueMetric

The total monetary value generated from all custom offline events attributed to ad interactions.

offline_total_custom_eventsMetric

The total count of custom events that occur offline, attributed to ad campaigns.

offline_view_content_event_rateMetric

The rate at which offline 'view content' events occur, attributed to ad campaigns.

offline_view_content_eventsMetric

The number of times users viewed content offline that can be attributed to TikTok ads. This includes actions like viewing product details in a physical store or other offline content interactions tracked through the TikTok Offline Events API.

offline_view_content_events_valueMetric

The total monetary value generated from offline 'view content' events attributed to ad interactions.

on_web_add_to_wishlistMetric

The number of 'add to wishlist' events that occurred on the website, attributed to ads.

on_web_add_to_wishlist_per_clickMetric

The number of 'add to wishlist' web events per click.

on_web_orderMetric

The number of order completion events that occurred on the website, attributed to ads.

on_web_order_rateMetric

The rate of orders placed on the website, attributed to your ads.

on_web_subscribeMetric

The number of subscription events that occurred on the website, attributed to ads.

on_web_subscribe_per_clickMetric

The percentage of website subscribe actions from all clicks attributed to your ads.

online_consultMetric

The number of online consultation events.

online_consult_rateMetric

The rate at which users initiate an online consultation service after engaging with an ad.

onsite_add_billingMetric

The number of onsite add billing events.

onsite_add_billing_rateMetric

The rate at which users add billing information on the advertiser's website after engaging with an ad.

onsite_add_to_cart_rateMetric

The rate at which users add items to their shopping cart on the advertiser's website or app.

onsite_add_to_wishlistMetric

The number of onsite add to wishlist events.

onsite_add_to_wishlist_rateMetric

The rate at which users add items to their wishlist on the advertiser's website after engaging with an ad.

onsite_cost_per_add_to_cartMetric

The average cost for each instance of a user adding an item to their shopping cart on the advertiser's website or app.

onsite_cost_per_checkout_initiationMetric

The average cost incurred for each time a user initiates the checkout process on the advertiser's website after engaging with an ad.

onsite_cost_per_product_details_page_viewMetric

The average cost incurred for each view of a product details page on the advertiser's website after engaging with an ad.

onsite_cost_per_purchaseMetric

The average cost incurred for each purchase completed on the advertiser's website, attributed to ad interactions.

onsite_destination_visit_rateMetric

The percentage of users who visited an onsite destination (e.g., Instant Page) after interacting with an ad.

onsite_download_startMetric

The number of times an onsite download was initiated.

onsite_download_start_rateMetric

The rate at which users initiate a download on the advertiser's website after engaging with an ad.

onsite_formMetric

The number of onsite form submission events.

onsite_form_rateMetric

The rate at which form submission events occur on the advertiser's website, attributed to ad interactions.

onsite_initiate_checkout_countMetric

The number of times users initiated a checkout process directly on the platform (onsite).

onsite_initiate_checkout_count_rateDimension

The rate at which users initiated a checkout process on the advertiser's website, attributed to ad interactions.

onsite_on_web_cartMetric

The number of onsite add to cart events.

onsite_on_web_cart_rateDimension

The rate at which users add items to their shopping cart on the advertiser's website after engaging with an ad.

onsite_on_web_detailMetric

The number of onsite product detail page views.

onsite_on_web_detail_rateMetric

The rate at which users view product details on the advertiser's website after engaging with an ad.

onsite_product_details_page_view_rateMetric

The rate at which users view product details pages on the advertiser's website after engaging with an ad.

onsite_purchase_rateMetric

The rate at which users make purchases on the advertiser's site after engaging with an ad.

onsite_purchases_roasMetric

The return on ad spend generated from purchases made on the advertiser's site.

onsite_shoppingMetric

The number of user shopping behaviors that occur on your website or app.

onsite_shopping_rateDimension

The rate at which users engage in shopping-related activities (e.g., product views, add to cart, purchases) on the advertiser's website after ad interaction.

onsite_shopping_roasMetric

The Return On Ad Spend (ROAS) generated from shopping activities directly on the platform (onsite).

onsite_total_add_to_cartMetric

The total number of "add to cart" actions performed on TikTok-owned properties, attributed to your ads.

onsite_total_add_to_cart_valueMetric

The total monetary value of 'add to cart' events that occurred on the advertiser's website, attributed to ad interactions.

onsite_total_checkout_initiationMetric

The total number of times users initiated a checkout process on the advertiser's website, attributed to ad interactions.

onsite_total_checkout_initiation_valueMetric

The total monetary value associated with all checkout initiation events occurring on the advertiser's website after ad interactions.

onsite_total_product_details_page_viewMetric

The total number of product details page views occurring on the advertiser's website after ad interactions.

onsite_total_purchaseMetric

The total number of purchases completed on the advertiser's website.

onsite_total_purchase_valueMetric

The total monetary value generated from purchases on the advertiser's website.

onsite_value_per_add_to_cartMetric

The average monetary value generated for each instance of a user adding an item to their shopping cart on the advertiser's website or app.

onsite_value_per_checkout_initiationMetric

The average monetary value generated for each checkout initiation event on the advertiser's website after ad interactions.

onsite_value_per_product_details_page_viewMetric

The average monetary value generated for each product details page view on the advertiser's website after ad interactions.

onsite_value_per_purchaseMetric

The average value generated per purchase made on the advertiser's site.

operating_systemsDimension

The operating systems targeted by the campaign.

operation_statusDimension

The operational status of the entity (e.g., campaign, ad group, ad), such as active, paused, or deleted.

opt_statusMetric

The status of automated creative optimization for the ad group.

optimization_eventDimension

The primary conversion event that the ad group is optimized for.

optimization_goalDimension

The primary goal for ad delivery optimization (e.g., conversions, clicks, reach).

ordersMetric

The total number of orders placed.

owner_bc_idDimension

The Business Center ID of the owner associated with the ad account or advertiser.

pacingDimension

The budget delivery strategy for an ad group, determining how spend is distributed over time.

page_browse_consultationMetric

The number of page browse events leading to a consultation, attributed to your ads.

page_browse_viewMetric

The number of page browse events.

page_browse_view_rateMetric

The rate at which users browse or view pages on a website after engaging with an ad.

page_content_view_event_rateMetric

The percentage of website view content actions from all clicks attributed to your ads.

page_content_view_eventsMetric

The number of page content view events triggered by ad interactions.

page_event_searchMetric

The number of search events that occurred on a webpage, attributed to ads.

page_event_search_rateMetric

The rate at which users perform a search action on a landing page.

page_idDimension

The unique identifier for a business page or profile associated with the ad.

pageview_rateMetric

The rate at which users view pages on a website after interacting with an ad.

paid_engaged_viewMetric

The number of times a video ad was played for at least 6 seconds or received at least 1 engagement within one day of a user seeing the ad.

paid_engaged_view_15sMetric

The number of times a video ad was played for at least 15 seconds or received at least 1 engagement within one day of a user seeing the ad.

paid_engagement_engaged_viewMetric

A view that signifies a certain level of engagement with a paid ad.

paid_engagement_engaged_view_15sMetric

The number of paid engagements where a video ad was viewed for at least 15 seconds.

pixel_idDimension

The unique identifier of the TikTok pixel used for event tracking.

placementDimension

The specific location or platform where the ad is displayed.

placement_typeMetric

The type of placement where the ad is displayed.

placementsDimension

The locations or platforms where the ads are displayed.

platformDimension

The operating system or environment where the ad was displayed (e.g., iOS, Android).

platform_nameDimension

The name of the advertising platform where the ad campaign is running.

playable_urlDimension

The URL for interactive playable ad creatives.

postback_window_modeDimension

The mode that determines which SKAN 4.0 postback (attribution window) is secured for the campaign.

predict_impressionDimension

The predicted number of impressions an ad or campaign is expected to receive.

product_click_rateMetric

The rate at which users click on a specific product displayed within an advertisement.

product_clicksDimension

The total number of clicks on a specific product displayed within an advertisement.

product_details_page_browseMetric

The number of times viewers clicked a product and viewed its details page.

product_details_page_browse_rateMetric

The rate at which users browse or view product details pages on a website after engaging with an ad.

product_image_urlDimension

The URL of the image for a product.

product_impressionsMetric

The total number of times a specific product displayed within an advertisement was viewed.

product_nameDimension

The name of the product being advertised.

product_set_idDimension

The unique identifier for a product set within a catalog.

product_sourceDimension

The source of products for promotion, such as Catalog, TikTok Shop, or Showcase. This can apply at campaign or ad group level.

product_specific_typeDimension

The specific type or category of product being promoted, relevant for shopping ads and catalog management.

product_statusDimension

The current status of the product in the catalog (e.g., active, out of stock).

profile_imageDimension

The profile image used for the ad. This refers to 'Ad Profile image' or 'Profile Image URL'.

profile_image_urlDimension

The URL of the profile image displayed with the ad.

profile_visitsMetric

The number of profile visits attributed to the ad.

profile_visits_rateMetric

The rate of profile visits per impression driven by a paid ad, applicable only to Spark Ads.

promotion_target_typeDimension

The type of objective or goal set for a promotion, such as driving traffic to an app, website, or specific in-app events.

promotion_typeDimension

The type of promotion used in a campaign, such as for GMV Max campaigns.

promotion_website_typeDimension

The type of website or landing page used as the destination for a promotion, categorizing the nature of the promotional destination.

promotional_music_disabledDimension

Indicates whether the use of music for promotional content is restricted to only commercial music library tracks or if other music is allowed.

province_idDimension

The geographical ID of the province targeted by the ad.

province_nameDimension

The name of the province targeted by the ad.

purchaseMetric

The number of purchase events attributed to the ad.

purchase_intention_keyword_idsDimension

A list of IDs for keywords related to user purchase intention used for targeting. This relates to the 'Purchase Intention' field.

purchase_rateMetric

The rate at which users make a purchase after interacting with an ad.

purchased_impressionMetric

The number of impressions that were purchased or guaranteed, especially relevant for reservation campaigns.

purchased_reachMetric

The number of unique users reached through purchased ad placements.

purchasesMetric

The total number of purchases attributed to the ad.

ratingsMetric

The number of ratings given by users.

ratings_rateMetric

The rate at which users provide ratings for products or content.

reachMetric

The number of unique users who saw the ad.

reach_lifetimeMetric

The number of unique users who saw your ads at least once over the entire lifetime of the campaign.

reach_mtdMetric

The number of unique users who saw your ad at least once, measured from the beginning of the month to the current date.

real_time_app_installMetric

The number of app installs reported in near real-time.

real_time_app_install_costMetric

The real-time cost associated with app installations, attributed to your ads.

real_time_conversionMetric

The number of times your ad achieved an outcome, based on the objective and settings you selected, with count based on when the conversion actually happened.

real_time_conversion_rateMetric

The percentage of real-time conversions received out of all clicks on your ads, calculated based on when the conversion actually happened.

real_time_conversion_rate_v2Metric

The real-time rate at which users complete a desired action (conversion) after interacting with an ad, calculated using an updated methodology (version 2).

real_time_cost_per_conversionMetric

The average amount of money spent on a real-time conversion (Real-time CPA), calculated based on when the conversion actually happened.

real_time_cost_per_resultMetric

The average cost for each real-time result from your ads, calculated based on when the conversion actually happened.

real_time_resultMetric

The number of times your ad achieved an outcome based on the optimization goal selected, with count based on when the conversion actually happened.

real_time_result_rateMetric

The percentage of real-time results achieved out of all views/clicks on your ads, calculated based on when the conversion actually happened.

regionDimension

The geographical region targeted by the advertising.

registrationMetric

The number of registration events attributed to the ad.

registration_rateMetric

The rate at which users complete a registration after interacting with an ad.

rejection_reasonDimension

The reason why an ad, ad group, or campaign was rejected.

resultMetric

The number of times your ad achieved an outcome, based on the optimization goal you selected.

result_rateMetric

The rate at which the campaign achieves its specified result.

revenue_eventsMetric

The number of events that generated revenue, attributed to ad interactions.

rf_campaign_typeMetric

The type of Reach and Frequency (RF) campaign.

rf_estimated_cprDimension

The estimated cost per reach for a Reach and Frequency (RF) campaign.

rf_estimated_frequencyDimension

The estimated average number of times a user sees an ad from a reservation campaign.

rf_purchased_typeDimension

The purchased type for a Reach and Frequency (RF) campaign.

roas_bidMetric

The target Return On Ad Spend (ROAS) bid.

roiDimension

The Return On Investment (ROI) from advertising efforts.

rta_bid_enabledDimension

Indicates whether Realtime API (RTA) bid is enabled for the campaign. This is similar to 'Campaign RTA Bid Enabled'.

rta_idDimension

The Realtime API (RTA) ID, which is the identifier for the RTA strategy used. This is similar to 'Campaign RTA ID'.

rta_product_selection_enabledDimension

Indicates whether Realtime API (RTA) is enabled to automatically select products for the campaign. This is similar to 'Campaign RTA Product Selection Enabled'.

sales_destinationDimension

The destination where users are directed to complete a sale or conversion.

sales_leadMetric

The number of sales leads generated by the ad campaign.

sales_lead_rateMetric

The percentage of unique generate lead events resulting from ad interactions.

saved_audience_idDimension

The ID of a saved audience segment.

schedule_end_timeDimension

The scheduled end date and time for an ad entity (e.g., campaign, ad group).

schedule_infosDimension

Contains detailed information about the ad's delivery schedule, such as start and end times or daily delivery windows.

schedule_start_timeDimension

The scheduled start date and time for an ad entity (e.g., campaign, ad group).

schedule_typeDimension

The type of scheduling applied to an ad entity, such as continuous or specific dates.

scheduled_budgetMetric

The budget allocated for an ad campaign or ad group for a specific scheduled period.

searchMetric

The number of search events that are attributed to your ads.

search_rateMetric

The rate at which users perform a search action.

search_result_enabledDimension

A setting that indicates whether an ad is enabled to appear within TikTok's organic search results.

search_termsMetric

The keywords or phrases users searched for that triggered the display of an advertisement, or the terms defined for a search ad campaign.

secondary_goal_resultDimension

The number of times your ad achieved an outcome based on the secondary goal selected.

secondary_goal_result_rateDimension

The rate at which secondary goal results were achieved, attributed to your ads.

secondary_optimization_eventDimension

The secondary event chosen for campaign optimization.

secondary_statusDimension

A secondary status for an ad group, providing more granular information beyond the primary status.

share_disabledDimension

Indicates whether sharing to third-party platforms is disabled for the ad.

sharesMetric

The number of times an ad was shared.

shop_gross_revenue_by_order_submissionDimension

The total gross revenue generated from shop orders that are attributed to ad interactions.

shop_total_items_purchasedDimension

The total number of items purchased from a shop, attributed to ads.

shopping_ads_deeplink_typeDimension

The type of deeplink used specifically for shopping ads.

shopping_ads_fallback_typeDimension

The fallback type used for shopping ads when the primary destination is unavailable.

shopping_ads_retargeting_typeDimension

The specific type of retargeting strategy employed for shopping ads, such as retargeting based on website visits, app activity, or cart abandonment.

shopping_ads_typeDimension

The specific format or classification of shopping ads, such as Video Shopping Ads, LIVE Shopping Ads, or Product Shopping Ads.

shopping_ads_video_package_idDimension

The identifier for a video package specifically used in shopping ads.

showcase_productsDimension

A list of products designated to be featured in a creator's or advertiser's showcase.

skan_achieve_levelMetric

The number of times the "achieve level" event occurred, as reported via SKAdNetwork.

skan_add_payment_infoMetric

The number of times the "add payment info" event occurred, as reported via SKAdNetwork.

skan_add_payment_info_rateMetric

The rate at which 'Add Payment Info' events are attributed via SKAdNetwork, calculated as the number of SKAN-attributed events divided by relevant impressions or clicks.

skan_add_to_cartMetric

The number of 'add to cart' events reported via SKAdNetwork (SKAN) for iOS app campaigns.

skan_add_to_cart_rateMetric

The rate at which the "add to cart" event occurred, as reported via SKAdNetwork.

skan_add_to_wishlistMetric

The number of times the "add to wishlist" event occurred, as reported via SKAdNetwork.

skan_app_installMetric

The number of app installs reported via SKAdNetwork (SKAN) for iOS app campaigns.

skan_checkoutMetric

The number of 'checkout' events reported via SKAdNetwork (SKAN) for iOS app campaigns.

skan_click_time_conversion_rateMetric

The conversion rate attributed to clicks measured through Apple's SKAdNetwork, indicating the percentage of users who completed a conversion event after clicking an ad.

skan_click_time_cost_per_conversionMetric

The average cost incurred for each conversion event attributed through Apple's SKAdNetwork, based on click-time attribution.

skan_complete_tutorialMetric

The number of times the "complete tutorial" event occurred, as reported via SKAdNetwork.

skan_complete_tutorial_rateMetric

The rate at which users complete a tutorial within an application or game, with attribution measured through Apple's SKAdNetwork.

skan_conversionMetric

The total number of conversion events reported via SKAdNetwork (SKAN) for iOS app campaigns.

skan_cost_per_achieve_levelMetric

The average cost incurred for each unique 'achieve level' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_add_payment_infoMetric

The average cost incurred for each 'Add Payment Info' event attributed via SKAdNetwork.

skan_cost_per_add_to_cartMetric

The average cost incurred for each 'add to cart' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_add_to_wishlistMetric

The average cost incurred for each 'add to wishlist' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_app_installMetric

The average cost for each app install attributed through Apple's SKAdNetwork framework.

skan_cost_per_checkoutMetric

The average cost incurred for each 'checkout initiated' or 'complete checkout' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_complete_tutorialMetric

The average cost incurred for each 'complete tutorial' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_conversionMetric

The average cost incurred for any conversion event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_create_gameroleMetric

The average cost incurred for each 'create gamerole' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_create_groupMetric

The average cost incurred for each 'create group' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_in_app_ad_clickMetric

The average cost incurred for each unique in-app ad click event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_in_app_ad_imprMetric

The average cost incurred for each in-app ad impression, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_join_groupMetric

The average cost incurred for each 'join group' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_launch_appMetric

The average cost incurred for each 'launch app' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_loan_applyMetric

The average cost incurred for each 'loan apply' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_loan_creditMetric

The average cost incurred for each 'loan credit' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_loan_disbursementMetric

The average cost incurred for each 'loan disbursement' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_loginMetric

The average cost incurred for each 'login' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_purchaseMetric

The average cost incurred for each purchase event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_ratingsMetric

The average cost incurred for each 'rating submitted' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_registrationMetric

The average cost incurred for each user registration event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_resultMetric

The average cost incurred per result (conversion) as reported via SKAdNetwork.

skan_cost_per_sales_leadMetric

The average cost for each sales lead attributed through Apple's SKAdNetwork framework.

skan_cost_per_searchMetric

The average cost incurred for each 'search' event within the app, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_spend_creditsMetric

The average cost incurred for each 'spend credits' event within the app, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_start_trialMetric

The average cost incurred for each 'start trial' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_subscribeMetric

The average cost incurred for each 'subscribe' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_achieve_levelMetric

The total cost incurred for all 'achieve level' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_add_to_cartMetric

The total cost incurred for all 'add to cart' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_add_to_wishlistMetric

The total cost incurred for all 'add to wishlist' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_checkoutMetric

The total cost incurred for all 'checkout initiated' or 'complete checkout' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_complete_tutorialMetric

The total cost incurred for all 'complete tutorial' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_create_gameroleMetric

The total cost incurred for all 'create gamerole' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_create_groupMetric

The total cost incurred for all 'create group' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_in_app_ad_clickMetric

The total cost incurred for all unique in-app ad click events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_in_app_ad_imprMetric

The total cost incurred for all in-app ad impression events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_join_groupMetric

The total cost incurred for all 'join group' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_launch_appMetric

The total cost incurred for all 'launch app' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_loan_applyMetric

The total cost incurred for all 'loan apply' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_loan_creditMetric

The total cost incurred for all 'loan credit' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_loan_disbursementMetric

The total cost incurred for all 'loan disbursement' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_loginMetric

The total cost incurred for all 'login' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_purchaseMetric

The total cost incurred for all purchase events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_ratingsMetric

The total cost incurred for all 'rating submitted' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_registrationMetric

The total cost incurred for all user registration events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_sales_leadMetric

The total cost incurred for all 'sales lead' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_searchMetric

The total cost incurred for all 'search' events within the app, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_spend_creditsMetric

The total cost incurred for all 'spend credits' events within the app, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_start_trialMetric

The total cost incurred for all 'start trial' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_subscribeMetric

The total cost incurred for all 'subscribe' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_unlock_achievementMetric

The total cost incurred for all 'unlock achievement' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_total_view_contentMetric

The total cost incurred for all 'view content' events, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_unlock_achievementMetric

The average cost incurred for each 'unlock achievement' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_per_view_contentMetric

The average cost incurred for each 'view content' event, as reported through SKAdNetwork (SKAN) for iOS campaigns.

skan_cost_total_add_payment_infoMetric

The total cost associated with 'Add Payment Info' events attributed via SKAdNetwork.

skan_create_gameroleMetric

The number of SKAdNetwork-attributed instances where users created a game role.

skan_create_groupMetric

The number of SKAdNetwork-attributed instances where users created a group.

skan_in_app_ad_clickMetric

The number of in-app ad clicks, as reported via SKAdNetwork.

skan_in_app_ad_click_rateMetric

The rate at which users click on in-app advertisements, with attribution measured through Apple's SKAdNetwork.

skan_in_app_ad_imprMetric

The number of in-app ad impressions, as reported via SKAdNetwork.

skan_join_groupMetric

The number of SKAdNetwork-attributed instances where users joined a group.

skan_launch_appMetric

The number of app launches, as reported via SKAdNetwork.

skan_loan_applyMetric

The number of loan application events, as reported via SKAdNetwork.

skan_loan_creditMetric

The number of SKAdNetwork-attributed instances where users received loan credit.

skan_loan_disbursementMetric

The number of SKAdNetwork-attributed loan disbursements.

skan_loginMetric

The number of login events, as reported via SKAdNetwork.

skan_purchaseMetric

The number of purchase events, as reported via SKAdNetwork.

skan_purchase_rateMetric

The rate of purchase events, as reported via SKAdNetwork.

skan_ratingsMetric

The number of rating events, as reported via SKAdNetwork.

skan_registrationMetric

The number of user registration events, as reported via SKAdNetwork.

skan_registration_rateMetric

The rate of user registration events, as reported via SKAdNetwork.

skan_resultMetric

The final conversion value or result reported via SKAdNetwork (SKAN) for iOS app campaigns.

skan_result_rateMetric

The rate of results (conversions), as reported via SKAdNetwork.

skan_sales_leadMetric

The number of sales lead events, as reported via SKAdNetwork.

skan_searchMetric

The number of search events, as reported via SKAdNetwork.

skan_spend_creditsMetric

The number of "spend credits" events, as reported via SKAdNetwork.

skan_start_trialMetric

The number of "start trial" events, as reported via SKAdNetwork.

skan_start_trial_rateMetric

The rate of "start trial" events, as reported via SKAdNetwork.

skan_subscribeMetric

The number of subscription events, as reported via SKAdNetwork.

skan_subscribe_rateMetric

The rate of subscription events, as reported via SKAdNetwork.

skan_total_achieve_levelMetric

The total count of "achieve level" events, as reported via SKAdNetwork.

skan_total_achieve_level_valueMetric

The total value of SKAdNetwork-attributed instances where users achieved a certain level.

skan_total_add_payment_infoMetric

The total count of "add payment info" events, as reported via SKAdNetwork.

skan_total_add_to_cartMetric

The total count of "add to cart" events, as reported via SKAdNetwork.

skan_total_add_to_cart_valueMetric

The total value associated with "add to cart" events, as reported via SKAdNetwork.

skan_total_add_to_wishlistMetric

The total count of "add to wishlist" events, as reported via SKAdNetwork.

skan_total_checkoutMetric

The total count of "checkout" events, as reported via SKAdNetwork.

skan_total_checkout_valueMetric

The total value associated with "checkout" events, as reported via SKAdNetwork.

skan_total_complete_tutorialMetric

The total count of "complete tutorial" events, as reported via SKAdNetwork.

skan_total_complete_tutorial_valueMetric

The total value of SKAdNetwork-attributed instances where users completed a tutorial.

skan_total_create_gameroleMetric

The total number of SKAdNetwork-attributed instances where users created a game role.

skan_total_create_groupMetric

The total number of SKAdNetwork-attributed instances where users created a group.

skan_total_in_app_ad_clickMetric

The total number of in-app ad clicks, attributed via SKAdNetwork.

skan_total_in_app_ad_click_valueMetric

The total value generated from all in-app ad click events, with attribution measured through Apple's SKAdNetwork.

skan_total_in_app_ad_imprMetric

The total number of in-app ad impressions, attributed via SKAdNetwork.

skan_total_join_groupMetric

The total number of times users joined a group, attributed via SKAdNetwork.

skan_total_launch_appMetric

The total number of app launches, attributed via SKAdNetwork.

skan_total_loan_applyMetric

The total number of loan applications, attributed via SKAdNetwork.

skan_total_loan_creditMetric

The total number of loan credits, attributed via SKAdNetwork.

skan_total_loan_disbursementMetric

The total number of loan disbursements, attributed via SKAdNetwork.

skan_total_loginMetric

The total number of user logins, attributed via SKAdNetwork.

skan_total_purchaseMetric

The total number of purchases, attributed via SKAdNetwork.

skan_total_purchase_valueMetric

The total value generated from purchases, attributed via SKAdNetwork.

skan_total_ratingsMetric

The total number of user ratings, attributed via SKAdNetwork.

skan_total_registrationMetric

The total number of user registrations, attributed via SKAdNetwork.

skan_total_sales_leadMetric

The total number of sales leads, attributed via SKAdNetwork.

skan_total_searchMetric

The total count of search events based on when the events are returned through the SKAdNetwork API.

skan_total_spend_creditsMetric

The total number of times users spent credits, attributed via SKAdNetwork.

skan_total_start_trialMetric

The total number of trial starts, attributed via SKAdNetwork.

skan_total_subscribeMetric

The total number of subscriptions, attributed via SKAdNetwork.

skan_total_view_contentMetric

The total number of content views, attributed via SKAdNetwork.

skan_unlock_achievementMetric

The number of times an achievement was unlocked, attributed via SKAdNetwork.

skan_view_contentMetric

The number of content views, attributed via SKAdNetwork.

skan_view_content_rateMetric

The rate at which content was viewed, attributed via SKAdNetwork.

skip_learning_phaseDimension

Indicates if the learning phase is skipped for campaign delivery optimization.

sku_idsDimension

A list of Stock Keeping Unit (SKU) identifiers, representing unique product items in a catalog.

smart_audience_enabledDimension

A flag indicating whether smart audience features are enabled for an ad group, allowing for dynamic audience optimization.

smart_interest_behavior_enabledDimension

A flag indicating whether smart interest and behavior-based targeting features are enabled for an ad group.

smart_targetDimension

The optimization goal set for smart targeting.

sound_usage_clicksMetric

Number of clicks on the 'Use sound' button associated with the ad.

sourceDimension

The advertising platform or origin where the ad was run.

special_industriesDimension

Special ad categories that apply to the campaign, such as HOUSING, EMPLOYMENT, or CREDIT. This is similar to 'Campaign Special Industries'.

spendMetric

The total amount of money spent on the ad or campaign.

spend_EURMetric

The total amount of money spent in Euros for the advertising campaign, ad group, or ad.

spend_creditsMetric

The number of unique app spend credit actions attributed to your ads.

spend_credits_rateMetric

The percentage of app spend credit actions from all app installs attributed to your ads.

split_testMetric

Indicates the status or identification of a split test (A/B test) run to compare different ad versions or strategies.

split_test_group_idDimension

The unique identifier for a specific group within a split test.

split_test_statusDimension

The current status of a split test.

start_trialMetric

The number of times a trial was started.

start_trial_rateMetric

The rate at which trials were started.

stat_time_dayDimension

The specific day for which the statistics are reported.

stat_time_hourDimension

The hour of the day for which the statistics are reported.

statistic_typeDimension

The statistical type or method used for reporting metrics.

statusDimension

The operational status of the ad, ad group, or campaign (e.g., active, paused, deleted).

stitch_clicksMetric

The number of clicks on the 'Stitch' button in Spark Ads.

subscribeMetric

The number of subscription events attributed to the ad.

subscribe_rateMetric

The rate at which users subscribe after interacting with an ad.

target_roi_budgetMetric

The budget allocated to achieve a specific Return On Investment (ROI) target.

targeting_expansionDimension

A feature that allows the ad platform to automatically expand targeting beyond manually set criteria to find a broader, relevant audience.

tiktok_item_idMetric

The unique identifier for a TikTok post ID, used specifically for Spark Ads.

tiktok_page_categoryDimension

A category assigned to a TikTok page or content, used for targeting audiences based on their engagement with specific content interests.

timezoneDimension

The timezone used for report data.

titleDimension

The title of an advertisement, creative, or other content asset.

topview_reach_rangeDimension

The estimated range of unique users that a TopView ad is expected to reach, providing a forecast for premium ad placements.

total_achieve_levelMetric

The total number of times users achieved a certain level within an app or game, attributed to the ad.

total_achieve_level_valueMetric

The total value generated from achieve level events.

total_active_pay_roasMetric

The Return On Ad Spend (ROAS) from actively paying users.

total_ad_impression_events_valueMetric

The cumulative value attributed to all ad impression events, potentially reflecting estimated revenue or importance.

total_ad_impression_roasMetric

The Return on Ad Spend (ROAS) specifically calculated based on ad impression events, indicating the revenue generated per unit of ad spend after impressions.

total_add_billing_valueMetric

The total value generated from users initiating adding billing information.

total_add_payment_infoMetric

The total number of times payment information was added.

total_add_to_wishlistMetric

The total number of 'add to wishlist' events attributed to your ads.

total_add_to_wishlist_valueMetric

The total monetary value of 'add to wishlist' events attributed to your ads.

total_app_event_add_to_cartMetric

The total number of 'add to cart' events that occurred within your app, attributed to your ads.

total_app_event_add_to_cart_valueMetric

The total monetary value of 'add to cart' events that occurred within your app, attributed to your ads.

total_button_click_valueMetric

The total value generated from button clicks on a website or app, attributed to the ad.

total_checkoutMetric

The total number of checkout events initiated.

total_checkout_valueMetric

The total monetary value of all checkout events.

total_complete_payment_rateMetric

The total value of website purchase actions attributed to ads. Despite its name, this metric returns a summed value, not a rate.

total_complete_tutorialMetric

The total number of times users have completed a tutorial.

total_complete_tutorial_valueMetric

The total value of app complete tutorial actions attributed to your ads.

total_create_gameroleMetric

The total number of app create role actions attributed to your ads.

total_create_gamerole_valueMetric

The total value of app create role actions attributed to your ads.

total_create_groupMetric

The total number of times a group was created.

total_create_group_valueMetric

The total value generated from creating groups.

total_download_start_valueMetric

The total value of website download actions attributed to your ads.

total_form_valueMetric

The total monetary value generated from form submissions.

total_in_app_ad_clickMetric

The total number of clicks on an ad within an application.

total_in_app_ad_click_valueMetric

The total value of in-app ad clicks attributed to your ads.

total_in_app_ad_imprMetric

The total number of in-app ad impressions.

total_in_app_ad_impr_valueMetric

The total value generated from in-app ad impressions.

total_initiate_checkout_valueMetric

The total monetary value of all initiate checkout events.

total_join_groupMetric

The total number of times a group was joined.

total_join_group_valueMetric

The total value generated from joining groups.

total_landing_page_viewMetric

The total number of landing page views after ad interaction.

total_launch_appMetric

The total number of times the app was launched by users.

total_loan_applyMetric

The total number of loan applications.

total_loan_creditMetric

The total number of loan credits.

total_loan_disbursementMetric

The total number of loan disbursements.

total_loginMetric

The total number of user logins.

total_next_day_openMetric

The total number of times the app was opened the day after installation or engagement.

total_on_web_add_to_wishlist_valueMetric

The total value of 'add to wishlist' actions on the website attributed to ads.

total_on_web_order_valueMetric

The total monetary value of order events that occurred on the website, attributed to ads.

total_on_web_subscribe_valueMetric

The total monetary value of subscription events that occurred on the website, attributed to ads.

total_online_consult_valueMetric

The total value generated from online consultation events.

total_onsite_add_billing_valueMetric

The total value generated from onsite add billing events.

total_onsite_add_to_wishlist_valueMetric

The total value generated from onsite add to wishlist events.

total_onsite_form_valueMetric

The total value generated from onsite form submission events.

total_onsite_initiate_checkout_count_valueMetric

The total value generated from onsite initiate checkout events.

total_onsite_on_web_cart_valueDimension

The total value generated from onsite add to cart events.

total_onsite_shopping_valueMetric

The total monetary value of all onsite shopping events.

total_page_event_search_valueMetric

The total monetary value of search events that occurred on a webpage, attributed to ads.

total_page_view_content_events_valueMetric

The total value associated with page view content events.

total_pageviewDimension

The total number of page views.

total_purchaseMetric

The total number of purchases.

total_purchase_roas_day0Metric

The total Return on Ad Spend (ROAS) for purchases within 0 days of ad interaction.

total_purchase_roas_day2Metric

The total return on ad spend (ROAS) generated from purchase actions within 72 hours of an app install.

total_purchase_roas_day6Metric

The total Return on Ad Spend (ROAS) for purchases within 6 days of ad interaction.

total_purchase_valueMetric

The total monetary value of purchases.

total_purchase_value_EURMetric

The total monetary value of purchases in Euros, attributed to ad interactions.

total_purchase_value_day0Metric

The total monetary value of purchases attributed to ads within zero days of the ad interaction, often indicating immediate purchase conversions.

total_purchase_value_day2Metric

The total monetary value of purchases within 2 days of ad interaction.

total_purchase_value_day6Metric

The total monetary value of purchases within 6 days of ad interaction.

total_ratingsMetric

The total number of ratings given by users.

total_ratings_valueMetric

The total value of app rate actions attributed to your ads.

total_registrationMetric

The total number of registration events.

total_sales_leadMetric

The total number of sales leads generated.

total_sales_lead_valueMetric

The total value generated from sales leads.

total_searchDimension

The total number of search events that are attributed to your ads.

total_spend_creditsMetric

The total number of app spend credit actions attributed to your ads.

total_spend_credits_valueMetric

The total value of app spend credit actions attributed to your ads.

total_start_trialMetric

The total number of times users have started a trial period.

total_subscribeMetric

The total number of subscription events attributed to ads.

total_subscribe_valueMetric

The total monetary value of subscription events attributed to ads.

total_unlock_achievementMetric

The total number of app unlock achievement actions attributed to your ads.

total_unlock_achievement_valueMetric

The total value of app unlock achievement actions attributed to your ads.

total_user_registration_valueMetric

The total value generated from user registrations.

total_value_per_pageviewMetric

The total monetary value generated for each page view attributed to the ad.

total_view_contentMetric

The total number of view content events attributed to your ads.

total_view_content_valueMetric

The total monetary value of view content events attributed to your ads.

total_web_event_add_to_cart_valueMetric

The total monetary value of 'add to cart' web events.

tracking_app_idMetric

The unique identifier of the app used for tracking purposes.

tracking_pixel_idMetric

The unique identifier of the pixel used for tracking purposes.

tt_account_nameDimension

The name of the TikTok account associated with the ad.

tt_account_profile_image_urlDimension

The URL of the profile image for the TikTok account associated with the ad.

tt_app_idDimension

The unique identifier for the TikTok application.

tt_app_nameMetric

The name of the TikTok application.

unique_ad_impression_eventsMetric

The number of unique times an ad was displayed to users.

unique_custom_app_eventsMetric

The number of unique custom in-app events recorded.

unlock_achievementMetric

The number of times users unlocked an achievement.

unlock_achievement_rateMetric

The rate at which users unlock achievements.

user_registrationMetric

The number of user registration events.

user_registration_rateMetric

The rate at which users complete registration.

value_per_ad_impression_eventMetric

The average value attributed to each individual ad impression event.

value_per_add_billingMetric

The average value generated each time a user adds billing information, typically after interacting with an ad.

value_per_button_clickMetric

The value generated per button click.

value_per_checkoutMetric

The average value generated per checkout event.

value_per_complete_paymentMetric

The monetary value generated for each complete payment.

value_per_download_startMetric

The average value generated each time a user initiates a download, often for an application or software promoted by an ad.

value_per_formMetric

The average value generated per form submission event.

value_per_initiate_checkoutMetric

The average value generated per 'initiate checkout' event.

value_per_offline_add_payment_info_eventMetric

The average monetary value generated for each offline 'add payment info' event, attributed to ad campaigns.

value_per_offline_add_to_cart_eventMetric

The average monetary value generated for each offline 'add to cart' event, attributed to ad campaigns.

value_per_offline_add_to_wishlist_eventMetric

The average monetary value generated for each offline 'add to wishlist' event, attributed to ad campaigns.

value_per_offline_click_button_eventMetric

The average monetary value generated for each offline 'click button' event, attributed to ad campaigns.

value_per_offline_complete_registration_eventMetric

The average monetary value generated for each offline 'complete registration' event, attributed to ad campaigns.

value_per_offline_download_eventMetric

The average monetary value generated for each offline 'download' event, attributed to ad campaigns.

value_per_offline_form_eventMetric

The average monetary value generated for each offline 'form submission' event.

value_per_offline_initiate_checkout_eventMetric

The average monetary value generated for each offline 'initiate checkout' event, attributed to ad campaigns.

value_per_offline_place_order_eventMetric

The average monetary value generated for each offline 'place order' event.

value_per_on_web_add_to_wishlistMetric

The average monetary value generated for each 'add to wishlist' event occurring on the advertiser's website.

value_per_on_web_orderMetric

The monetary value generated for each order completed on the website.

value_per_online_consultMetric

The average value generated each time a user completes an online consultation initiated through an ad.

value_per_onsite_add_billingMetric

The average monetary value generated for each 'add billing information' event occurring on the advertiser's website after an ad interaction.

value_per_onsite_add_to_wishlistMetric

The average monetary value generated for each 'add to wishlist' event occurring on the advertiser's website after an ad interaction.

value_per_onsite_formMetric

The average monetary value generated for each form submission event on the advertiser's website.

value_per_onsite_initiate_checkout_countDimension

The average monetary value generated for each 'initiate checkout' event on the advertiser's website.

value_per_onsite_on_web_cartDimension

The average monetary value generated for each 'add to cart' event occurring on the advertiser's website after an ad interaction.

value_per_onsite_on_web_detailDimension

The average monetary value generated for each 'view product detail' event occurring on the advertiser's website after an ad interaction.

value_per_onsite_shoppingDimension

The average monetary value generated from each onsite shopping event, such as an add to cart, checkout initiation, or product page view. from TikTok Ads API onsite shopping value metrics query results

value_per_page_event_searchMetric

The average monetary value generated for each search event performed on a webpage, attributed to ad engagement.

value_per_total_achieve_levelMetric

The average monetary value generated for each instance of a user achieving a level within an application or game.

value_per_total_add_to_wishlistMetric

The average monetary value generated for each 'add to wishlist' event, including both in-app and onsite occurrences, attributed to ad interactions.

value_per_total_app_event_add_to_cartMetric

The average value generated per 'add to cart' event within the app.

value_per_total_complete_tutorialMetric

The cumulative value generated from all instances where users complete a tutorial within an application or game after engaging with an ad.

value_per_total_create_gameroleMetric

The average monetary value generated for each instance of a user creating a game role within an application, attributed to ads.

value_per_total_create_groupMetric

The average monetary value generated for each instance of a user creating a group within an application or platform, attributed to ads.

value_per_total_in_app_ad_clickMetric

The average monetary value generated for each in-app ad click, attributed to ads.

value_per_total_in_app_ad_imprMetric

The cumulative value generated from all in-app ad impression events.

value_per_total_join_groupMetric

The average monetary value generated for each instance of a user joining a group within an application or platform, attributed to ads.

value_per_total_purchaseMetric

Total monetary value generated for each purchase attributed to an ad.

value_per_total_ratingsMetric

The average monetary value generated for each user rating action, attributed to ads.

value_per_total_sales_leadMetric

The average value generated per sales lead.

value_per_total_spend_creditsMetric

The average value generated per 'spend credits' event.

value_per_total_subscribeMetric

The average value generated per subscription event.

value_per_total_unlock_achievementMetric

The cumulative value generated from all instances where users unlock an achievement within an application or game after engaging with an ad.

value_per_total_view_contentMetric

The average value generated per 'view content' event.

value_per_user_registrationMetric

The average value generated per user registration.

value_per_web_event_add_to_cartMetric

The average value generated per 'add to cart' web event.

video_idDimension

The unique identifier for a video creative used in an ad.

video_play_actionsMetric

The total number of times users initiated playing a video ad.

video_views_p100Metric

The total number of times a video was played to completion (100%).

video_views_p25Metric

The total number of times a video was played to at least 25% of its length.

video_views_p50Metric

The total number of times a video was played to at least 50% of its length.

video_views_p75Metric

The total number of times a video was played to at least 75% of its length.

video_watched_2sMetric

The number of times a video ad was watched for at least 2 seconds.

video_watched_6sMetric

The number of times a video has been played for at least 6 seconds, or played in full if it is less than 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad.

video_watched_continuous_2sMetric

The number of times a video was continuously watched for at least 2 seconds.

view_attribution_windowDimension

The time window during which a view of an ad can be attributed to a conversion.

view_completionMetric

The percentage of the ad's content that was viewed.

view_contentMetric

The number of times a specific content page or product was viewed after an ad interaction.

view_content_rateMetric

The rate at which users view specific content pages.

vta_conversionMetric

The number of conversions attributed to a view-through action.

vta_purchaseMetric

Purchases attributed to a view-through action (user saw the ad but didn't click, then converted later).

vta_registrationMetric

The number of registration events attributed to view-through actions (VTA), based on information received from your measurement partner.

web_event_add_to_cartMetric

The number of 'add to cart' events that occurred on the website, attributed to ads.

web_event_add_to_cart_rateMetric

The rate at which users add items to their cart on a website.