Skip to main content
Feedback

TikTok walkthrough

note

TikTok API version 1.3 is currently supported.

This integration enables businesses to access, analyze, and use TikTok data seamlessly within their data workflows. It empowers organizations to leverage TikTok's rich user-generated content and audience insights, enhancing their marketing strategies and audience engagement.

Connection

  1. To connect Tiktok API with your destination, refer to Tiktok connection topic.
  2. Choose a Source connection after creating a connection.

Predefined reports

Data Integration provides a convenient entry point and recommended approach for accessing a range of predefined reports. Each report includes a concise data description, a list of customizable fields (if applicable), and the schema mapping. Since these reports follow a standardized format, specific fields are restricted and can only be accessed through Custom Reports.

Custom reports

Select a specific report to pull data from the Tiktok API.

  1. Custom Reports

  2. Reports Filters - Filter the report by fields (leave the filter empty for getting a report without a filter by field). Each report may have any combination of filters, but not necessarily all of them.

Time period for reports

  1. Select the Incremental extract method to filter the report for specific periods or dates.
  2. Select the time period of the report. All the reports support two kinds of time periods:
    1. Date Range
      • Pulls data in the date range between the start and end date provided, including the end date.
      • You must select a start date.
      • Leaving the end date empty pulls data up to the current time of the river's run.
      • Select a timezone offset to send dates considering the offset.
      • Use the Last Days Back For Each Run to expand the start date and pull data a given number of days back before the chosen start date.
    2. Predefined date - A date range defined by Data Integration:
    • Day - Yesterday.
    • Week (From Monday to Sunday) - Week to date, Previous week, Previous week to date.
    • Month - Month to date, Previous month, Previous month to date.
    • Year - Year to date. Audience Reports include a dimensions filter that has a maximum time range of 365 days, unless you select "time dimension" for the group by, in which case it can function properly without overwriting your data.
note

The Start Date does not advance if a River run is unsuccessful. If you want to turn off this default setting, click More Options and select the checkbox to advance the start date even if the River run is unsuccessful (Not recommended).

Interval chunks

Data Integration can run over the increment using chunks, to make the loading efficient and precise for large amounts of data. You can choose from:

  • Don't Split: Data Integration pulls the data from the chosen start date to the end date in one bulk.
  • Daily: Chunk data daily from the start to the end date.
  • Monthly: Chunk data monthly from the start to the end date.
  • Yearly (Less Recommended): Chunk data yearly from the start to the end date.

Interval size

Set the size of each interval.

Example

Setting the Interval Size to 4 with a Daily Interval Chunk splits the date period into 4-day chunks. Running from 01/01/2025 to 08/01/2025 will be split into two intervals: from 01/01/2025 to 04/01/2025 and from 05/01/2025 to 08/01/2025.

V1.2 reports on V1.3

Data Integration makes it possible to select deprecated reports from the API version 1.2 by combining the Report Name, Report Type, and Data Level parameters from API version 1.3.

To obtain metrics for the reports you require from version 1.2, you must select the right combination, shown in the following table:

V1.2 Report NameV1.3 Report NameReport TypeData Level
Advertisers ReportBasicAdvertiser
Auction Ads ReportBasicAdvertiser
Campaign ReportBasicCampaign
Ad Group ReportBasicAd Group
Ads ReportBasicAd
Campaign Audience DataAudienceCampaign
Ad Group Audience DataAudienceAd Group
Ad Audience DataAudienceAd

IOS 14 Dedicated Campaigns

Apple introduced a new AppTrackingTransparency (ATT) framework that required apps to request users' permission before accessing IDFA (Identifier for Advertiser).

For more details, refer to the Tiktok user manual.

To fetch IOS14 metrics in the "Campaigns" report, set Campaign Type to IOS14_CAMPAIGN.

Activity Logs

The Activity Logs offer an inside perspective of the processes taking place in Tiktok river.

TikTok Kits

Kits are pre-built data models to help data teams immediately create the right data pipelines to tackle common challenges and scenarios.

These codes can be customized to fit your company’s data needs. These are the best starting points to leverage existing data models that are effective in specific use cases.

List of available TikTok Kits:

On this Page