Get Report
Fetch TikTok Ads data based on specified metrics and dimensions
The Get Report node lets you fetch TikTok Ads performance data across one or more accounts using specified metrics, dimensions, and filters. This is an AI-powered node that can understand natural language instructions.
When to Use It
Use this node to:
- Generate automated performance reports and dashboards
- Track campaign metrics and KPIs over time
- Create data-driven insights for optimization decisions
- Export data for further analysis in external tools
Inputs
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 |
Filters
Filters allow you to refine your data by applying conditions to specific dimensions or metrics. Multiple filters use AND logic - all conditions must be met for a row to be included in the results.
Available Filter Operators
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 |
Filter Examples
Example 1: High-performing active campaigns
Example 2: Video content campaigns using regex (OR logic)
Example 3: Exclude test campaigns
OR Logic with Filters
Since multiple filters use AND logic, use these approaches for OR conditions:
- IN_LIST operator:
Placement IN ["TikTok", "Pangle", "Global_App_Bundle"]
- REGEXP_MATCH operator:
Campaign name REGEXP_MATCH ".*(video|viral|content).*"
- Run separate queries: Create different workflows for different conditions
Options Reference
These optional settings let you format the output from TikTok Ads before passing it to other nodes.
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 |
Output
The node returns a structured dataset with performance metrics and dimensions. The exact format depends on your configuration and the data returned from TikTok Ads.
Typical Output Structure:
- Data Rows: Performance metrics and dimensions
- Metadata: Account information, date ranges, and query details
- Summary Statistics: Total records, data freshness, execution time
Can be passed to:
- AI nodes like Analyze Data or Structured Output
- Export nodes (e.g., Google Sheets)
- Email or Slides nodes
Credit Cost
- Cost per run: 1 credit (per successful execution)
Example Setup
Configuration Example:
- Date Range: Last 7 days
- Metrics: Impressions, Clicks, Cost, Conversions
- Dimensions: Campaign Name, Date
- Filters: Impressions > 0 (only active campaigns)
- Limit: 1000 rows
FAQs
How do I combine filters with OR logic?
How do I combine filters with OR logic?
Multiple filters always use AND logic (all conditions must be true). For OR logic, use:
Option 1: IN_LIST operator
Option 2: REGEXP_MATCH operator
Option 3: Run separate workflows Create different Get Report nodes for different conditions, then combine the data downstream.
What's the difference between CONTAINS and REGEXP_MATCH?
What's the difference between CONTAINS and REGEXP_MATCH?
- CONTAINS: Simple substring search.
Campaign name CONTAINS "video"
finds any campaign with “video” anywhere in the name - REGEXP_MATCH: Advanced pattern matching.
Campaign name REGEXP_MATCH "^video.*"
finds campaigns that START with “video”
Use CONTAINS for simple text searches, REGEXP_MATCH for complex patterns or OR conditions.
Why are my filters not working?
Why are my filters not working?
Common filter issues:
- Case sensitivity: “Video” ≠ “video”. Use CONTAINS or regex for flexible matching
- Data type mismatch: Don’t use text operators on numeric fields
- Field availability: Not all dimensions/metrics support all filter operators
- Syntax errors: Check regex patterns for proper escaping
What happens if I select multiple TikTok Ads accounts?
What happens if I select multiple TikTok Ads accounts?
The data will be aggregated across all selected accounts into a single dataset.
If you’d like to break it out by account, add the account_name
or account_id
dimension to segment results per account.
Why am I missing conversions?
Why am I missing conversions?
Conversion data might lag behind the UI due to the conversion window.
For example, with a 30-day window, conversions can change long after the click date.
Compare data only after the window closes to ensure accuracy.
Why is my data different from the TikTok Ads UI?
Why is my data different from the TikTok Ads UI?
Data discrepancies can occur due to:
- Reporting delays: TikTok Ads data can take up to 24-48 hours to finalize
- Attribution windows: Different attribution models may show different results
- Filters: Check if you have different filters applied in the UI vs API
- Status changes: Status fields may not reflect recent changes (see status FAQ below)
Why is my report returning no data?
Why is my report returning no data?
Common causes of empty results:
- Date range: The selected period may have no activity
- Filters: Your filters may be too restrictive
- Account status: Campaigns may be paused or inactive
- Metrics compatibility: Some metric/dimension combinations aren’t supported
- Account access: You may lack permissions for specific campaigns
Why are some metrics showing as zero?
Why are some metrics showing as zero?
Zero values can indicate:
- No activity: The campaigns genuinely had no performance for those metrics
- Conversion tracking: Conversion metrics require proper tracking setup
- Dimension compatibility: Some dimensions don’t work with certain metrics
- Attribution: Different attribution models may show different values
My previously connected account stopped working - what happened?
My previously connected account stopped working - what happened?
This is likely due to TikTok’s authentication system:
- Single Access Token: TikTok only issues one access token per user/app
- Account Deselection: When connecting a new account, you may have accidentally deselected an existing one
- Solution: Reconnect to TikTok and ensure ALL accounts you want access to are checked in the authentication dialog
- Prevention: Always verify all desired accounts are selected during TikTok’s authentication flow
I need a business account to connect - how do I verify this?
I need a business account to connect - how do I verify this?
To connect to TikTok Ads, you need:
- TikTok Business Account: Personal accounts cannot be used for advertising data
- Proper Permissions: The account must have access to the advertising data you want to report on
- Authentication: Follow TikTok’s business authentication flow
- Verification: Ensure you’re logging in with business account credentials, not personal account