GET_CAMPAIGN_METRICS_TIKTOK_ADS

Insights about your TikTok Ads campaigns.

icon of TikTok AdsTikTok Ads
Not a big fan of functions?
Use the Actions Wizard to configure any action in Rows without functions.

Parameter List

Syntax
GET_CAMPAIGN_METRICS_TIKTOK_ADS(advertiser id
[campaign id]
[report type]
[date range]
[metrics]
[dimensions]
)
advertiser id

The ID of your TikTok Ads account.

[optional] campaign id

The id of the campaign. Leave blank to get data for all campaigns.

[optional] report type

The type of report.

Selected options:
Basic
Audience
Playable ad
[optional] date range

Date range to get insights for. For example: ">2019", ">2019-11-01" or "[2010-01-01;2019-01-01]". By default, you get insights for the last 30 days.

[optional] metrics

Range of fields to retrieve about the ad account. For example: 'clicks','country'. By default, it returns the most common metrics about the ad account. For a complete list of possible metrics, see the TikTok Ads documentation documentation.

Selected options:
Ad Format Asset
Campaign Name
Total Cost
CPC (Destination)
CPM
Impressions
Gross Impressions (Includes Invalid Impressions)
Clicks (Destination)
CTR (Destination)
Conversion
CPA
CVR (Clicks)
CVR (Impressions)
Real-time Conversions
Real-time CPA
Real-time CVR (Clicks)
Real-time CVR (Impressions)
Result
Cost Per Result
Result Rate (%)
Real-time Result
Real-time Cost Per Result
Real-time Result Rate (%)
Currency
Is ACO
Is Smart Creative
Advertiser Name
Campaign Name
Objective Type
Split Test
Campaign Budget
App Promotion Type
Video Views
2-Second Video Views
6-Second Video Views
Video Average Watch Time Per Video View
Video Average Watch Time Per Person
Video Views at 25%
Video Views at 50%
Video Views at 75%
Video Views at 100%
6-second views (Focused view)
15-second views (Focused view)
Paid Profile Visit
Paid Profile Visit Rate
Paid Likes
Paid Comments
Paid Shares
Paid Followers
Music Clicks
Instant Experience Average View Time
Instant Experience Average View Percentage
Total Landing Page View
Cost per Landing Page View
Landing Page View Rate
[optional] dimensions

Range of values to break down the results into different sets. For example: 'age'. For a complete list of possible dimensions, see the TikTok Ads documentation documentation.

Selected options:
Advertiser ID
Campaign ID
Ad Group ID
Ad ID
Day
Gender
Age
Country Code
AC
Language
Platform
Interest Category
Placement
Contextual Tag (Cannot be used together with other audience dimensions)
Province ID
DMA ID
Interest Category Tier 2
Interest Category Tier 3
Interest Category Tier 4
Device Brand ID
Behavior ID
Ad Type
Hashtag
Audience Tags
Additional Interests
Purchase Intention

Examples

GET_CAMPAIGN_METRICS_TIKTOK_ADS("adidas", , audience, ">2021-09-01", "impressions,clicks,spend,cpc,cpm", "age") returns report with clicks, spend, cpc and cpm per age of the audience.