...
Resource | Sub Resource | Description | Parameter |
Ad Group | List of All Ad Group | Lists all ad groups in the advertiser account | Advertiser Id |
Reports | Auction Basic - Advertiser | Use this type of report to get spending and performance data at four levels: campaigns, ad groups, ads, or ad accounts. | Advertiser Id |
Reports | Auction Basic - Campaign | Use this type of report to get spending and performance data at four levels: campaigns, ad groups, ads, or ad accounts. | Advertiser Id |
Campaign | All Campaigns | Lists all campaigns in the advertiser account | Advertiser Id |
Ads | List of All Ads | Lists all ads in the advertiser account | Advertiser Id |
Reports | Auction Playable Ad | Advertiser Id | |
Reports | Auction Basic - Ad | Use this type of report to get spending and performance data at four levels: campaigns, ad groups, ads, or ad accounts. | Advertiser Id |
Reports | Auction Audience - Ad Group | Use this type of report to get audience data. You can group spend and performance data by audience attributes such as age, gender, region, or interest. | Advertiser Id |
Reports | Auction Audience - Campaign | Use this type of report to get audience data. You can group spend and performance data by audience attributes such as age, gender, region, or interest. | Advertiser Id |
Reports | Auction Audience - Advertiser | Use this type of report to get audience data. You can group spend and performance data by audience attributes such as age, gender, region, or interest. | Advertiser Id |
Reports | Auction Audience - Ad | Use this type of report to get audience data. You can group spend and performance data by audience attributes such as age, gender, region, or interest. | Advertiser Id |
Reports | Auction Basic - Ad Group | Use this type of report to get spending and performance data at four levels: campaigns, ad groups, ads, or ad accounts. | Advertiser Id |
Connection Properties
Name | Mandatory | Description |
---|---|---|
Connection Name | Yes | Name of the connection |
Description | No | Description of connection |
Creating a connection
Fill up required fields (name)
Click Authorize
You will be redirected to tiktok for business for oauth
Allow EazyDI to access (It is important to leave all the access requested ticked in order for EazyDI to retrieve the resources)
If your user does not have any access to any advertising account/advertiser Id, then A validation error will be shown in EazyDI stating “No Advertiser Id Found“
After allowing EazyDI, you will be redirected back to the app to test the connection and continue with the pipelines
Configuring Object
Choose from the Resource Type, Sub Resource Type, and Advertiser Id that will be used as source
Fields
The fields are based on schema defined in https://business-api.tiktok.com/portal/docs?id=1738864739862530 but automatically flattened to be able to map easily
Resource Name | Sub Type | Fields | Description |
Reports | Auction Basic – Ad | metrics_spend | Total spend. |
Reports | Auction Basic – Ad | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Basic – Ad | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Basic – Ad | metrics_impressions | Number of impression. |
Reports | Auction Basic – Ad | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Basic – Ad | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Basic – Ad | metrics_reach | Reach, The number of unique users who saw your ads at least once. This metric is estimated. |
Reports | Auction Basic – Ad | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_frequency | Frequency, The average number of times each person saw your ad. |
Reports | Auction Basic – Ad | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Basic – Ad | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad | metrics_campaign_name | Campaign name, Supported at Campaign, Ad Group and Ad level. |
Reports | Auction Basic – Ad | metrics_objective_type | Advertising objective, Supported at Campaign, Ad Group and Ad level. |
Reports | Auction Basic – Ad | metrics_app_promotion_type | App promotion type, Supported at Campaign, Ad Group and Ad level. Enum values: APP_INSTALL, APP_RETARGETING. APP_INSTALL and APP_RETARGETING will be returned when objective_type is APP_PROMOTION. Otherwise, UNSET will be returned. |
Reports | Auction Basic – Ad | metrics_campaign_id | Campaign ID, Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad | metrics_adgroup_name | Ad group name, Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad | metrics_placement_type | Placement type, Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad | metrics_adgroup_id | Ad group ID, Supported at Ad level. |
Reports | Auction Basic – Ad | metrics_ad_name | Ad name, Supported at Ad level. |
Reports | Auction Basic – Ad | metrics_ad_text | Ad title, Supported at Ad level. |
Reports | Auction Basic – Ad | metrics_tt_app_id | TikTok App ID, TikTok App ID, the App ID you used when creating an Ad Group. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad | metrics_tt_app_name | TikTok App Name, The name of your TikTok App. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad | metrics_mobile_app_id | Mobile App ID, Mobile App ID. Examples are, App Store: https://apps.apple.com/us/app/angry-birds/id343200656; Google Play:https://play.google.com/store/apps/details?id=com.rovio.angrybirds. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad | metrics_promotion_type | Promotion type, It can be app, website, or others. Supported at Ad Group and Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Basic – Ad | metrics_dpa_target_audience_type | Target audience type for DPA, The Audience that DPA products target. Supported at Ad Group or Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Basic – Ad | metrics_video_play_actions | Video Views, The number of times your video starts to play. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_video_watched_2s | 2-Second Video Views, The number of times your video played for at least 2 seconds. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_video_watched_6s | 6-Second Video Views, The number of times your video played for at least 6 seconds, or completely played. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_average_video_play | Video Average Watch Time Per Video View, The average time your video was played per single video view, including any time spent replaying the video. |
Reports | Auction Basic – Ad | metrics_video_views_p25 | Video Views at 25%, The number of times your video was played at 25% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_video_views_p50 | Video Views at 50%, The number of times your video was played at 50% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_video_views_p75 | Video Views at 75%, The number of times your video was played at 75% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_video_views_p100 | Video Views at 100%, The number of times your video was played at 100% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad | metrics_engaged_view | 6-second views (Focused view), The number of times your video has been played at least 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. |
Reports | Auction Basic – Ad | metrics_engaged_view_15s | 15-second views (Focused view), The number of times your video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. Note: This metric is on the allowlist. If you would like access to it, please reach out to your TikTok representative. |
Reports | Auction Basic – Ad | metrics_profile_visits | Paid Profile Visit, The number of profile visits the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad | metrics_profile_visits_rate | Paid Profile Visit Rate, The rate of profile visits per impression the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad | metrics_likes | Paid Likes, The number of likes your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad | metrics_comments | Paid Comments, The number of comments your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad | metrics_shares | Paid Shares, The number of shares your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad | metrics_follows | Paid Followers, The number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad | metrics_clicks_on_music_disc | Music Clicks, The number of clicks on the official music in your Spard Ads during the campaign. |
Reports | Auction Basic – Ad | dimensions_ad_id | Group by Ad ID |
Reports | Auction Basic – Ad | dimensions_country_code | Group by location code |
Reports | Auction Basic – Ad Group | metrics_spend | Total spend. |
Reports | Auction Basic – Ad Group | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Basic – Ad Group | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Basic – Ad Group | metrics_impressions | Number of impression. |
Reports | Auction Basic – Ad Group | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Basic – Ad Group | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Basic – Ad Group | metrics_reach | Number of reach. |
Reports | Auction Basic – Ad Group | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Ad Group | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_frequency | Frequency, The average number of times each person saw your ad. |
Reports | Auction Basic – Ad Group | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Basic – Ad Group | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Ad Group | metrics_campaign_name | Auction Ads Campaign Name / Reservation Ads Group Name. |
Reports | Auction Basic – Ad Group | metrics_objective_type | Advertising objective, Supported at Campaign, Ad Group and Ad level. |
Reports | Auction Basic – Ad Group | metrics_app_promotion_type | App promotion type, Supported at Campaign, Ad Group and Ad level. Enum values: APP_INSTALL, APP_RETARGETING. APP_INSTALL and APP_RETARGETING will be returned when objective_type is APP_PROMOTION. Otherwise, UNSET will be returned. |
Reports | Auction Basic – Ad Group | metrics_campaign_id | Campaign ID Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad Group | metrics_adgroup_name | Ad group name, Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad Group | metrics_placement_type | Placement type , Supported at Ad Group and Ad level. |
Reports | Auction Basic – Ad Group | metrics_tt_app_id | TikTok App ID, TikTok App ID, the App ID you used when creating an Ad Group. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad Group | metrics_tt_app_name | TikTok App Name, The name of your TikTok App. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad Group | metrics_mobile_app_id | Mobile App ID, Mobile App ID. Examples are, App Store: https://apps.apple.com/us/app/angry-birds/id343200656; Google Play:https://play.google.com/store/apps/details?id=com.rovio.angrybirds. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Basic – Ad Group | metrics_promotion_type | Promotion type, It can be app, website, or others. Supported at Ad Group and Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Basic – Ad Group | metrics_video_play_actions | Video Views, The number of times your video starts to play. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_video_watched_2s | 2-Second Video Views, The number of times your video played for at least 2 seconds. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_video_watched_6s | 6-Second Video Views, The number of times your video played for at least 6 seconds, or completely played. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_average_video_play | Video Average Watch Time Per Video View, The average time your video was played per single video view, including any time spent replaying the video. |
Reports | Auction Basic – Ad Group | metrics_video_views_p25 | Video Views at 25%, The number of times your video was played at 25% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_video_views_p50 | Video Views at 50%, The number of times your video was played at 50% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_video_views_p75 | Video Views at 75%, The number of times your video was played at 75% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_video_views_p100 | Video Views at 100%, The number of times your video was played at 100% of its length. Replays will not be counted. |
Reports | Auction Basic – Ad Group | metrics_engaged_view | 6-second views (Focused view), The number of times your video has been played at least 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. |
Reports | Auction Basic – Ad Group | metrics_engaged_view_15s | 15-second views (Focused view), The number of times your video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. Note: This metric is on the allowlist. If you would like access to it, please reach out to your TikTok representative. |
Reports | Auction Basic – Ad Group | metrics_profile_visits | Paid Profile Visit, The number of profile visits the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad Group | metrics_profile_visits_rate | Paid Profile Visit Rate, The rate of profile visits per impression the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad Group | metrics_likes | Paid Likes, The number of likes your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad Group | metrics_comments | Paid Comments, The number of comments your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad Group | metrics_shares | Paid Shares, The number of shares your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Ad Group | metrics_follows | Paid Followers, The number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Spark Ads. |
Reports | Auction Basic – Ad Group | metrics_clicks_on_music_disc | Music Clicks, The number of clicks on the official music in your Spard Ads during the campaign. |
Reports | Auction Basic – Ad Group | dimensions_adgroup_id | Ad Group ID. Returns when dimensions contain adgroup_id. |
Reports | Auction Basic – Ad Group | dimensions_country_code | |
Reports | Auction Basic – Campaign | metrics_spend | Total spend. |
Reports | Auction Basic – Campaign | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Basic – Campaign | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Basic – Campaign | metrics_impressions | Number of impression. |
Reports | Auction Basic – Campaign | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Basic – Campaign | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Basic – Campaign | metrics_reach | Number of reach. |
Reports | Auction Basic – Campaign | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Campaign | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_frequency | Frequency, The average number of times each person saw your ad. |
Reports | Auction Basic – Campaign | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Basic – Campaign | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Campaign | metrics_campaign_name | Auction Ads Campaign Name / Reservation Ads Group Name. |
Reports | Auction Basic – Campaign | metrics_objective_type | Advertising objective, Supported at Campaign, Ad Group and Ad level. |
Reports | Auction Basic – Campaign | metrics_app_promotion_type | App promotion type, Supported at Campaign, Ad Group and Ad level. Enum values: APP_INSTALL, APP_RETARGETING. APP_INSTALL and APP_RETARGETING will be returned when objective_type is APP_PROMOTION. Otherwise, UNSET will be returned. |
Reports | Auction Basic – Campaign | metrics_video_play_actions | Video Views, The number of times your video starts to play. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_video_watched_2s | 2-Second Video Views, The number of times your video played for at least 2 seconds. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_video_watched_6s | 6-Second Video Views, The number of times your video played for at least 6 seconds, or completely played. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_average_video_play | Video Average Watch Time Per Video View, The average time your video was played per single video view, including any time spent replaying the video. |
Reports | Auction Basic – Campaign | metrics_video_views_p25 | Video Views at 25%, The number of times your video was played at 25% of its length. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_video_views_p50 | Video Views at 50%, The number of times your video was played at 50% of its length. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_video_views_p75 | Video Views at 75%, The number of times your video was played at 75% of its length. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_video_views_p100 | Video Views at 100%, The number of times your video was played at 100% of its length. Replays will not be counted. |
Reports | Auction Basic – Campaign | metrics_engaged_view | 6-second views (Focused view), The number of times your video has been played at least 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. |
Reports | Auction Basic – Campaign | metrics_engaged_view_15s | 15-second views (Focused view), The number of times your video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. Note: This metric is on the allowlist. If you would like access to it, please reach out to your TikTok representative. |
Reports | Auction Basic – Campaign | metrics_profile_visits | Paid Profile Visit, The number of profile visits the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Campaign | metrics_profile_visits_rate | Paid Profile Visit Rate, The rate of profile visits per impression the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Campaign | metrics_likes | Paid Likes, The number of likes your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Campaign | metrics_comments | Paid Comments, The number of comments your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Campaign | metrics_shares | Paid Shares, The number of shares your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Campaign | metrics_follows | Paid Followers, The number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Spark Ads. |
Reports | Auction Basic – Campaign | metrics_clicks_on_music_disc | Music Clicks, The number of clicks on the official music in your Spard Ads during the campaign. |
Reports | Auction Basic – Campaign | dimensions_campaign_id | Campaign ID. Returns when dimensions contain campaign_id. |
Reports | Auction Basic – Campaign | dimensions_country_code | |
Reports | Auction Basic – Advertiser | metrics_spend | Total spend. |
Reports | Auction Basic – Advertiser | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Basic – Advertiser | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Basic – Advertiser | metrics_impressions | Number of impression. |
Reports | Auction Basic – Advertiser | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Basic – Advertiser | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Basic – Advertiser | metrics_reach | Number of reach. |
Reports | Auction Basic – Advertiser | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Basic – Advertiser | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_frequency | Frequency, The average number of times each person saw your ad. |
Reports | Auction Basic – Advertiser | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Basic – Advertiser | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Basic – Advertiser | metrics_video_play_actions | Video Views, The number of times your video starts to play. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_video_watched_2s | 2-Second Video Views, The number of times your video played for at least 2 seconds. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_video_watched_6s | 6-Second Video Views, The number of times your video played for at least 6 seconds, or completely played. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_average_video_play | Video Average Watch Time Per Video View, The average time your video was played per single video view, including any time spent replaying the video. |
Reports | Auction Basic – Advertiser | metrics_video_views_p25 | Video Views at 25%, The number of times your video was played at 25% of its length. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_video_views_p50 | Video Views at 50%, The number of times your video was played at 50% of its length. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_video_views_p75 | Video Views at 75%, The number of times your video was played at 75% of its length. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_video_views_p100 | Video Views at 100%, The number of times your video was played at 100% of its length. Replays will not be counted. |
Reports | Auction Basic – Advertiser | metrics_engaged_view | 6-second views (Focused view), The number of times your video has been played at least 6 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. |
Reports | Auction Basic – Advertiser | metrics_engaged_view_15s | 15-second views (Focused view), The number of times your video has been played at least 15 seconds, or received at least 1 engagement within 1 day of the user seeing a paid ad. Engagements to be measured: Likes, shares, follows, profile visits, clicks, hashtag clicks, music clicks, anchor clicks, and interactive add-ons activity clicks. Note: This metric is on the allowlist. If you would like access to it, please reach out to your TikTok representative. |
Reports | Auction Basic – Advertiser | metrics_profile_visits | Paid Profile Visit, The number of profile visits the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Advertiser | metrics_profile_visits_rate | Paid Profile Visit Rate, The rate of profile visits per impression the paid ad drove during the campaign. This metric is only for Spark Ads. |
Reports | Auction Basic – Advertiser | metrics_likes | Paid Likes, The number of likes your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Advertiser | metrics_comments | Paid Comments, The number of comments your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Advertiser | metrics_shares | Paid Shares, The number of shares your video creative received within 1 day of a user seeing a paid ad. |
Reports | Auction Basic – Advertiser | metrics_follows | Paid Followers, The number of new followers that were gained within 1 day of a user seeing a paid ad. This metric is only for Spark Ads. |
Reports | Auction Basic – Advertiser | metrics_clicks_on_music_disc | Music Clicks, The number of clicks on the official music in your Spard Ads during the campaign. |
Reports | Auction Basic – Advertiser | dimensions_advertiser_id | Advertiser ID. Returns when dimensions contain advertiser_id. |
Reports | Auction Basic – Advertiser | dimensions_country_code | |
Reports | Auction Audience – Ad | metrics_spend | Total spend. |
Reports | Auction Audience – Ad | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Audience – Ad | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Audience – Ad | metrics_impressions | Number of impression. |
Reports | Auction Audience – Ad | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Audience – Ad | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Audience – Ad | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Audience – Ad | metrics_campaign_name | Auction Ads Campaign Name / Reservation Ads Group Name. |
Reports | Auction Audience – Ad | metrics_campaign_id | Campaign ID Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad | metrics_adgroup_name | Ad group name, Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad | metrics_placement_type | Placement type , Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad | metrics_adgroup_id | Ad group ID, Supported at Ad level. |
Reports | Auction Audience – Ad | metrics_ad_name | Ad name, Supported at Ad level. |
Reports | Auction Audience – Ad | metrics_ad_text | Ad title, Supported at Ad level. |
Reports | Auction Audience – Ad | metrics_tt_app_id | TikTok App ID, TikTok App ID, the App ID you used when creating an Ad Group. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad | metrics_tt_app_name | TikTok App Name, The name of your TikTok App. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad | metrics_mobile_app_id | Mobile App ID, Mobile App ID. Examples are, App Store: https://apps.apple.com/us/app/angry-birds/id343200656; Google Play:https://play.google.com/store/apps/details?id=com.rovio.angrybirds. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad | metrics_promotion_type | Promotion type, It can be app, website, or others. Supported at Ad Group and Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Audience – Ad | metrics_dpa_target_audience_type | Target audience type for DPA, The Audience that DPA products target. Supported at Ad Group or Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Audience – Ad | dimensions_ad_id | Ad ID. Returns when dimensions contain ad_id. |
Reports | Auction Audience – Ad | dimensions_age | Audience age group. See Enumeration - Age Group for details. Returns when dimensions contain age. |
Reports | Auction Audience – Ad | dimensions_gender | Targeting gender. Enum values: FEMALE, MALE, NONE. Returns when dimensions contain gender. |
Reports | Auction Audience – Ad Group | metrics_spend | Total spend. |
Reports | Auction Audience – Ad Group | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Audience – Ad Group | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Audience – Ad Group | metrics_impressions | Number of impression. |
Reports | Auction Audience – Ad Group | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Audience – Ad Group | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Audience – Ad Group | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Ad Group | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Ad Group | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Audience – Ad Group | metrics_campaign_name | Auction Ads Campaign Name / Reservation Ads Group Name. |
Reports | Auction Audience – Ad Group | metrics_campaign_id | Campaign ID Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad Group | metrics_adgroup_name | Ad group name, Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad Group | metrics_placement_type | Placement type , Supported at Ad Group and Ad level. |
Reports | Auction Audience – Ad Group | metrics_tt_app_id | TikTok App ID, TikTok App ID, the App ID you used when creating an Ad Group. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad Group | metrics_tt_app_name | TikTok App Name, The name of your TikTok App. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad Group | metrics_mobile_app_id | Mobile App ID, Mobile App ID. Examples are, App Store: https://apps.apple.com/us/app/angry-birds/id343200656; Google Play:https://play.google.com/store/apps/details?id=com.rovio.angrybirds. Supported at Ad Group and Ad level. Returned if the promotion type of one Ad Group is App. |
Reports | Auction Audience – Ad Group | metrics_promotion_type | Promotion type, It can be app, website, or others. Supported at Ad Group and Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Audience – Ad Group | metrics_dpa_target_audience_type | Target audience type for DPA, The Audience that DPA products target. Supported at Ad Group or Ad levels in both synchronous and asynchronous reports. |
Reports | Auction Audience – Ad Group | dimensions_adgroup_id | Ad Group ID. Returns when dimensions contain adgroup_id. |
Reports | Auction Audience – Ad Group | dimensions_age | Audience age group. See Enumeration - Age Group for details. Returns when dimensions contain age. |
Reports | Auction Audience – Ad Group | dimensions_gender | Targeting gender. Enum values: FEMALE, MALE, NONE. Returns when dimensions contain gender. |
Reports | Auction Audience – Advertiser | metrics_spend | Total spend. |
Reports | Auction Audience – Advertiser | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Audience – Advertiser | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Audience – Advertiser | metrics_impressions | Number of impression. |
Reports | Auction Audience – Advertiser | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Audience – Advertiser | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Audience – Advertiser | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Advertiser | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Advertiser | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Audience – Advertiser | dimensions_advertiser_id | Advertiser ID. Returns when dimensions contain advertiser_id. |
Reports | Auction Audience – Advertiser | dimensions_age | Audience age group. See Enumeration - Age Group for details. Returns when dimensions contain age. |
Reports | Auction Audience – Advertiser | dimensions_gender | Targeting gender. Enum values: FEMALE, MALE, NONE. Returns when dimensions contain gender. |
Reports | Auction Audience – Campaign | metrics_spend | Total spend. |
Reports | Auction Audience – Campaign | metrics_cpc | CPC, The average amount of money you've spent on a click. |
Reports | Auction Audience – Campaign | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Audience – Campaign | metrics_impressions | Number of impression. |
Reports | Auction Audience – Campaign | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Audience – Campaign | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Audience – Campaign | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_real_time_conversion | Real-time Conversions, The number of times your ad achieved an outcome, based on the objective and settings you selected. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_real_time_cost_per_conversion | Real-time CPA, The average amount of money you've spent on a conversion. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_real_time_conversion_rate | Real-time CVR (%), The percentage of results you received out of all the clicks of your ads. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_result | Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the results. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_cost_per_result | Cost Per Result, The average cost for each result from your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the cost per result. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_result_rate | Result Rate (%), The percentage of results you achieved out of all of the views/clicks on your ads. As one campaign may have a number of different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to ad groups or ads to view the result rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Audience – Campaign | metrics_real_time_result | Real-time Result, The number of times your ad achieved an outcome, based on the optimization goal you selected. As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_real_time_cost_per_result | Real-time Cost Per Result, As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the cost per Result. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_real_time_result_rate | Real-time Result Rate (%), As a campaign may have different optimization goals, this metric is not supported at advertiser level or campaign level. Please go to the ad group section to view the Result Rate. (The total count is based on when the conversion actually happened.) |
Reports | Auction Audience – Campaign | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Audience – Campaign | metrics_campaign_name | Auction Ads Campaign Name / Reservation Ads Group Name. |
Reports | Auction Audience – Campaign | dimensions_campaign_id | Campaign ID. Returns when dimensions contain campaign_id. |
Reports | Auction Audience – Campaign | dimensions_age | Audience age group. See Enumeration - Age Group for details. Returns when dimensions contain age. |
Reports | Auction Audience – Campaign | dimensions_gender | Targeting gender. Enum values: FEMALE, MALE, NONE. Returns when dimensions contain gender. |
Reports | Auction Playable – Ad | metrics_spend | Total spend. |
Reports | Auction Playable – Ad | metrics_cpm | CPM, The average amount of money you've spent per 1,000 impressions. |
Reports | Auction Playable – Ad | metrics_impressions | Number of impression. |
Reports | Auction Playable – Ad | metrics_clicks | Clicks, The number of clicks on your ads. |
Reports | Auction Playable – Ad | metrics_ctr | CTR (%), The percentage of times people saw your ad and performed a click. |
Reports | Auction Playable – Ad | metrics_conversion | Conversions, The number of times your ad achieved an outcome, based on the secondary goal you selected. As one campaign may have a number of different secondary goals, this statistic is not supported for campaigns. Please go to ad groups or ads to view. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_cost_per_conversion | CPA, The average amount of money you've spent on a conversion.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_conversion_rate | CVR (%), The percentage of results you received out of all the clicks of your ads.(The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_currency | currency, The currency code, e. g. USD. Note that if you want to use currency as metrics, then the dimensions field in your request must include adgroup_id/ad_id/campaign_id/advertiser_id. |
Reports | Auction Playable – Ad | metrics_playable_id | Playable ID, Playable creative ID |
Reports | Auction Playable – Ad | metrics_playable_name | Playable Name, Playable creative name |
Reports | Auction Playable – Ad | metrics_playable_url | Playable URL, Playable creative URL |
Reports | Auction Playable – Ad | metrics_preview_url | Thumbnail |
Reports | Auction Playable – Ad | metrics_create_time | Create time |
Reports | Auction Playable – Ad | metrics_modify_time | Modify time |
Reports | Auction Playable – Ad | metrics_playable_status | Status |
Reports | Auction Playable – Ad | metrics_associated_adgroup_count | No. of Related Ad Groups |
Reports | Auction Playable – Ad | metrics_orientation | Display orientation |
Reports | Auction Playable – Ad | metrics_country | Delivery country or location |
Reports | Auction Playable – Ad | metrics_app_install | App Install, The number of times your mobile app was installed that were recorded as app events and attributed to your ads. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_cost_per_app_install | Cost per App Install, The average cost for each app install event. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_app_install_rate | App Install Rate, App Install Rate. (The total count is calculated based on the time each ad impression occurred.) |
Reports | Auction Playable – Ad | metrics_playable_page_view_count | Playable page views, Playable page view count. The number of times people viewed your playable page. |
Reports | Auction Playable – Ad | metrics_playable_first_scene_view_count | Playable views: first scene, The number of times viewers reach the first scene of your playable ad. Views are reported according to the SDK of your playable creative. |
Reports | Auction Playable – Ad | metrics_playable_second_scene_view_count | Playable views: second scene, The number of times viewers reach the second scene of your playable ad. Views are reported according to the SDK of your playable creative. |
Reports | Auction Playable – Ad | metrics_playable_third_scene_view_count | Playable views: third scene, The number of times viewers reach the third scene of your playable ad. Views are reported according to the SDK of your playable creative. |
Reports | Auction Playable – Ad | metrics_playable_cta_click | Playable CTA button clicks, The number of times people clicked the download button on your playable page. |
Reports | Auction Playable – Ad | dimensions_playable_id | Group by playable ID. |
Running a Pipeline with Tiktok as Source
Tiktok data:
Target:
Reauthorize:
If token has been stale, invalid, uninstalled in your Tiktok account, or you are receiving unauthorized error, You can reauthorize your connection by clicking the Reauthorize button