Skip to main content
TikTok Organic refers to non-paid content on TikTok—creator profiles and videos. The connector uses the TikTok Open API (Login Kit) to extract the authenticated user’s profile and their published videos so you can analyze organic content in your Lakehouse.

​
Configuring TikTok Organic as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the TikTok Organic option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You need to authorize Nekt to access your TikTok account via OAuth 2.0. Complete the TikTok authorization flow so that the connector can use your OAuth credentials to obtain and refresh access tokens. The following configurations are available:
  • Client ID: (Required) The client ID of your TikTok OAuth app. Find it in your TikTok for Developers app settings.
  • Client Secret: (Required) The client secret of your TikTok OAuth app. Keep this value secret; use environment variables or a secrets manager.
  • Refresh Token: (Required) The refresh token obtained through the TikTok OAuth flow from a TikTok account that has the permissions needed to access the data (e.g. user info, video list). The connector uses it to obtain and refresh access tokens.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE. All streams use full table sync by default.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from TikTok Organic (Open API) and their corresponding fields.
Single record with the authenticated user’s basic profile (Open API user info).Key Fields:
  • open_id - The user’s open ID (primary key)
  • union_id - The user’s union ID
  • avatar_url - User’s avatar URL
  • display_name - User’s display name
  • bio_description - User’s bio description
  • profile_deep_link - User’s profile deep link
  • is_verified - Whether the user is verified
  • follower_count - Number of followers
  • following_count - Number of following
  • likes_count - Number of likes received
  • video_count - Number of videos posted
  • username - User’s username
List of videos published by the authenticated user (paginated).Key Fields:
  • id - The video’s unique ID (primary key)
  • create_time - Video creation unix timestamp
  • cover_image_url - Video cover image URL
  • share_url - Video share URL
  • video_description - Video description
  • duration - Video duration in seconds
  • height, width - Video dimensions in pixels
  • title - Video title
  • embed_html, embed_link - Embed code and link
  • like_count - Number of likes
  • comment_count - Number of comments
  • share_count - Number of shares
  • view_count - Number of views

​
Data Model

The following diagram illustrates the relationship between the two streams. user_info is the authenticated user’s profile; videos is the list of videos published by that user.

​
Implementation Notes

  • Authentication: The connector uses OAuth credentials (client_id, client_secret, refresh_token) to obtain and refresh access tokens automatically. Create a TikTok OAuth app in TikTok for Developers, complete the TikTok OAuth flow to get a refresh token from an account with the right permissions, and provide client ID, client secret, and refresh token in the source configuration. Do not store secrets in code; use environment variables or a secrets manager.
  • API base: Requests are sent to the TikTok Open API by default. Endpoints used include /v2/user/info/ (user_info) and /v2/video/list/ (videos).
  • Pagination: videos uses cursor-based pagination (cursor, max_count). user_info returns a single record.
  • Stream selection: You can select user_info, videos, or both. Select only what you need to reduce extraction time and catalog size.