Fetch TikTok Ads data based on specified metrics and dimensions
Field | Type | Required | Description |
---|---|---|---|
Accounts | Dynamic multi-select | Yes | Select one or more TikTok Ads accounts to query |
Date Range | Date range picker | Yes | Select date range for the report |
Metrics | Multi-select | Yes | Select metrics to include in the report |
Dimensions | Multi-select | No | Select dimensions to segment your data |
Filters | Rule-based filters | No | Add filters to refine your data |
Order By | Sort configuration | No | Set the order of results |
Limit | Number | No | Maximum number of rows to return |
Options | Report options | No | Additional options for the report |
Operator | Description | Example Use Case |
---|---|---|
EQUALS | Exact match | Campaign name equals “Summer Sale 2024” |
NOT_EQUALS | Does not match exactly | Campaign status not equals “PAUSED” |
CONTAINS | Contains substring | Campaign name contains “2024” |
NOT_CONTAINS | Does not contain substring | Campaign name doesn’t contain “test” |
IN_LIST | Matches any value in list | Placement in [“TikTok”, “Pangle”] |
NOT_IN_LIST | Doesn’t match any value in list | Device not in [“DESKTOP”] |
REGEXP_MATCH | Matches regular expression | Campaign name matches ”.(viral|trending).” |
NOT_REGEXP_MATCH | Doesn’t match regex | Campaign name doesn’t match “test.*“ |
GREATER_THAN | Numeric greater than | Spend > 100 |
LESS_THAN | Numeric less than | CPC < 1.50 |
IS_NULL | Field has no value | Conversion value is null |
IS_NOT_NULL | Field has a value | Conversion value is not null |
Placement IN ["TikTok", "Pangle", "Global_App_Bundle"]
Campaign name REGEXP_MATCH ".*(video|viral|content).*"
Option | Description |
---|---|
Pretty Column Names | Converts column headers to Title Case (e.g. campaignName becomes Campaign Name ) |
Add Percent Sign to Ratios | Appends % to ratio metrics like CTR or Engagement Rate |
Display Currency Symbol | Adds $ or local currency symbol to monetary metrics |
Compact Numbers | Converts large numbers to short format (e.g. 10K instead of 10,000 ) |
Pivot Dimensions as Columns | Transforms dimension values into separate columns for easier comparison |
How do I combine filters with OR logic?
What's the difference between CONTAINS and REGEXP_MATCH?
Campaign name CONTAINS "video"
finds any campaign with “video” anywhere in the nameCampaign name REGEXP_MATCH "^video.*"
finds campaigns that START with “video”Why are my filters not working?
What happens if I select multiple TikTok Ads accounts?
account_name
or account_id
dimension to segment results per account.Why am I missing conversions?
Why is my data different from the TikTok Ads UI?
Why is my report returning no data?
Why are some metrics showing as zero?
My previously connected account stopped working - what happened?
I need a business account to connect - how do I verify this?