TikTok Video
Details for the TIKTOK_VIDEO link type
Type Value: TIKTOK_VIDEO
Status: PRODUCTION
A TIKTOK_VIDEO
link type corresponds to a TikTok video. Along with the common preview attributes (title
, description
, image
), TIKTOK_VIDEO
links provide extensive data about the video’s creator, engagement metrics, and associated media assets. This helps you deliver more informative previews—like showing video thumbnails, engagement counts, and even associated user details.
What It Includes
When type
is TIKTOK_VIDEO
, the response includes a tiktokVideo
object with fields such as:
- user: Information about the creator, including their username, display name, avatar, and verification status.
- publishedAt: The date and time the video was posted.
- text (caption): The text caption that accompanies the video.
- media: An array of media items (images or videos), making it easy to display a thumbnail or even a short snippet.
- likesCount, commentsCount, playsCount, sharesCount: Engagement metrics that show how the video is performing on the platform.
By leveraging these fields, you can create rich video previews that provide immediate context—how popular the video is, who created it, and what users can expect from it.
Example Request
Example Response
Special Notes
- Fallback Strategies: If certain metadata (like the caption or avatar) is missing, Peekalink makes best-effort inferences to maintain a useful preview.
- User & Engagement Data: Leverage metrics like playsCount, likesCount, and sharesCount to highlight popularity and trending content.
- Media Variation: With media arrays that include both images and videos, you can choose the best format for your layout or add interactive previews.
Schema reference
For a full technical breakdown of all fields and validation rules, including detailed JSON schemas, please refer to the API Reference.