YouTube Video
Details for the YOUTUBE_VIDEO link type
Type Value: YOUTUBE_VIDEO
Status: PRODUCTION
A YOUTUBE_VIDEO
link type corresponds to a YouTube video URL. Beyond the common attributes (title
, description
, image
), YOUTUBE_VIDEO
links include additional metadata like the video’s duration, view counts, and user (channel) information. This helps you display detailed previews that highlight a video’s popularity, relevance, and origin.
What It Includes
When type
is YOUTUBE_VIDEO
, the response includes a youtubeVideo
object with fields like:
- videoId: The unique YouTube video identifier.
- user: Information about the channel or user who uploaded the video.
- publishedAt: The date and time when the video was published.
- duration: Video length in seconds.
- viewsCount, likesCount, dislikesCount, commentsCount: Engagement metrics that reflect the video’s popularity and user interaction.
- rating: A computed rating value.
- thumbnail: A responsive image object with various resolutions, ideal for displaying a suitable thumbnail size in your UI.
By accessing these attributes, you can create rich video previews that show users how popular or recent a video is, who created it, and what they can expect from its content.
Example Request
Example Response
Special Notes
- Fallback Strategies: If certain metadata is missing, Peekalink attempts to infer title, description, or image to maintain a consistent preview experience.
- Engagement Metrics: Views, likes, and comments data allow you to highlight a video’s popularity or credibility.
- Channel Integration: The user field connects the video to its creator’s channel details, which can be leveraged to display subscriber counts or channel branding.
Schema reference
For a full technical breakdown of all fields and validation rules, including detailed JSON schemas, please refer to the API Reference.