TikTok
The table below gives information about all the data fields that you can import from TikTok.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
|
Field UI name |
Field API name |
Description |
Use in Adverity |
Docs |
|---|---|---|---|---|
|
|
avatar_url |
User's profile image |
dimension |
|
|
|
bio_description |
User's bio description if there is a valid one |
dimension |
|
|
|
comment_count |
Number of comments on the video |
metric |
|
|
|
cover_image_url |
A CDN link for the video's cover image. The image is static. Due to our trust and safety policies, the link has a TTL of 6 hours. |
dimension |
|
|
|
create_time |
UTC Unix epoch (in seconds) of when the TikTok video was posted. |
dimension |
|
|
|
display_name |
User's profile name |
dimension |
|
|
|
duration |
The duration of the TikTok video in seconds. |
dimension |
|
|
|
embed_html |
HTML code for embedded video |
dimension |
|
|
|
embed_link |
Video embed link of tiktok.com |
dimension |
|
|
|
follower_count |
User's followers count |
metric |
|
|
|
following_count |
The number of accounts that the user is following |
metric |
|
|
|
height |
The height of the TikTok video. |
dimension |
|
|
|
id |
Unique identifier for the TikTok video. Also called 'item_id' |
dimension |
|
|
|
is_verified |
Whether TikTok has provided a verified badge to the account after confirming that it belongs to the user it represents |
dimension |
|
|
|
like_count |
Number of likes for the video |
metric |
|
|
|
likes_count |
The total number of likes received by the user across all of their videos |
metric |
|
|
|
open_id |
The unique identification of the user in the current application. Open ID for the client |
dimension |
|
|
|
profile_deep_link |
The link to user's TikTok profile page |
dimension |
|
|
|
share_count |
Number of shares of the video |
metric |
|
|
|
share_url |
A shareable link for this TikTok video. Note that the website behaves differently on Mobile and Desktop devices. |
dimension |
|
|
|
title |
The video title. Max length: 150 |
dimension |
|
|
|
union_id |
The unique identification of the user across different apps for the same developer. For example, if a partner has X number of clients, it will get X number of open_id for the same TikTok user, but one persistent union_id for the particular user |
dimension |
|
|
|
video_description |
The description that the creator has set for the TikTok video. Max length: 150 |
dimension |
|
|
|
view_count |
Number of views of the video |
metric |
|
|
|
width |
The width of the TikTok video. |
dimension |
|