TikTok
Last updated
Last updated
When you're setting up your first workflow with TikTok, you'll need to add a credential. Simply click Connect with TikTok.
If you are not already logged in to TikTok, you will be asked to log in with your TikTok For Business credentials. You will then see the following screen. In order for the MESA TikTok integration to fully function, we recommend you leave all permissions checked.
Hit Confirm, and you're all set! You can then use this credential for any TikTok actions or triggers.
In order to retrieve TikTok reports, choose one of the Reports actions.
Both the Ad Group Summary and Auction Campaign Summary reports come with some default parameters to help you get started.
Below is a list of the most important fields, and how to customize them.
Dimensions
TikTok supports a variety of dimensions, depending on the report type. If you have used an invalid dimension, your task will fail, and you will see an error in the workflow's Logs. In some cases, you can specify multiple dimensions. To do so, enter each dimension name and with a comma separating them (no spaces). For instance `adgroup_id,stat_time_day`. For full details, see TikTok's reporting documentation under the Supported Dimensions heading.
When you update the dimensions, this will alter the structure of the data being returned. Ensure that you hit Save after making any changes. This will refresh the variables available in your MESA actions.
Metrics
TikTok allows a vast number of different metrics, depending on the report type. Per dimensions, using an invalid metric will result in your task failing. You may specify multiple metrics with a comma separated between them. For example: `spend,impressions,clicks`. For full details see TikTok's reporting documentation under the Supported Metrics heading.
When you update the metrics, this will alter the structure of the data being returned. Ensure that you hit Save after making any changes. This will refresh the variables available in your MESA actions.
To access the fields below, you will need to select the More Options button.
Filters
Filters must be passed in a JSON format and you can pass multiple. In the above example, we are filtering the Ad Group Summary report by specific ad group IDs. You can also omit filters by deleting the default contents of the field.
For details and examples, see TikTok's reporting documentation under the Supported Filters heading.
Order Field
If you want to order your report by one of the selected metrics or dimensions, you can specify the field name here. Some fields can not be ordered. If they are ordered, your task will fail, and you will see an error in the workflow's Logs.
Order Type
This specifies the direction to order the results in and is based on the Order Field.
Add Field
For advanced users, you can add additional fields to request bespoke reports. For full details, please see TikTok's reporting documentation for available parameters and examples.
