TikTok - Parameters

The query parameters available to a TikTok connector.

These are the parameters a TikTok connector's query accepts. The recommended template sets the ones it needs; the rest are only reachable by editing the connector in the Advanced Editor.

Most accounts never touch these. The page exists so that when a connector does need adjusting, what is adjustable is written down. The columns it can return are listed separately on TikTok - Supported Columns.

Parameters

Parameter	Type	Default	What it does
Level	TikTokReportLevel		Level of report
ServiceTypes	list of TikTokReportServiceType	[]	Report service type (auction ads, reservation ads)
ReportType	TikTokReportType	TikTokReportType.Basic	Report type
Dimensions	list of text	[]	Name of dimensions to retrieve
Metrics	list of text	[]	Names of metrics to retrieve
Filtering	Filter[]		Data filtering
KeepEmptyRows	true or false		If empty rows should be filtered out (false) or kept in resulting data (true)

TikTokReportLevel values

Value	Meaning
Campaign	Campaign level report
AdGroup	AdGroup level report
Ad	Ad level report (the most granular report)

TikTokReportServiceType values

Value	Meaning
Auction	Auction Ads report
Reservation	Reservation Ads report

TikTokReportType values

Value	Meaning
Basic	Basic report, default
Audience	Audience analysis data report
Playable	Playable ads data report
Dsa	DSA (DPA) ads data report (CALATLOG)

A connector edited in the Advanced Editor stops receiving template updates. Roivenue ships improvements by updating the shared template a connector is built from, and only connectors still configured by that template pick those updates up. Once a connector is switched to advanced mode, its query and transformations belong to you.