Video Analytics

Get video details

Retrieves comprehensive video details including metadata (title, caption, hashtags, music), analytics metrics (views, likes, engagement rate), account information, and content properties. Includes platform-specific data and computed performance indicators, and the creative the video is a copy of (the same video posted to other platforms), when it is in one.

get/videos/{platform}/{platformVideoId}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/videos/{platform}/{platformVideoId}
  • Auth: API key in header x-api-key

Path parameters

platform'facebook' | 'instagram' | 'tiktok' | 'youtube' | 'snapchat' required

Social media platform (facebook, instagram, tiktok, youtube, snapchat)

Example:facebook
platformVideoIdstring required

Native platform video id found in the URL of the video

Example:7123456789012345678

Response

OK

idstring required
platformVideoIdstring required
platformstring required
accountUsernamestring required
platformAccountIdstring required
accountDisplayNamestring nullable required
accountProfilePictureUrlstring nullable required
captionstring nullable required
hashtagsstring[] required
contentTypestring required
videoIndexnumber required
thumbnailUrlstring nullable required
musicIdstring nullable required
musicTitlestring nullable required
musicArtiststring nullable required
musicAlbumstring nullable required
musicPlayUrlstring nullable required
musicCoverUrlstring nullable required
isOriginalMusicnumber nullable required
durationSecondsnumber nullable required
viewCountnumber nullable required
organicViewCountnumber nullable
paidViewCountnumber nullable
likeCountnumber nullable required
commentCountnumber nullable required
shareCountnumber nullable required
bookmarkCountnumber nullable required
engagementRatenumber nullable required
viralityFactornumber nullable required
publishedDatestring required
publishedAtstring required
loadAtstring required
orgAccountIdstring required

Organization account ID with orgacc_ prefix. Not the same as platform account ID.

orgVideoIdstring nullable

Organization video ID with orgvid_ prefix

orgAccountMaxVideosinteger nullable

Tracking limit (max_videos) of the account that owns this video; 0 means the account is paused or only holds individually tracked videos

orgCreatorIdstring nullable required

Organization creator ID with orgcre_ prefix

access'own' | 'briefSample'

How the caller may see this video: 'own' for the organization's own tracked content (or, for a creator, a video on one of their assigned accounts); 'briefSample' for a creator viewing a sample video of a campaign brief they were given — a reference view without assignment, paid-media, exclusion, or tracking details

archivedRawVideoUrlstring nullable

Public URL of the video's archived raw file in viral.app storage, when the media pipeline has stored one (the detail view's native 'Video Player' toggle); null otherwise

archivedThumbnailUrlstring nullable

Public URL of the archived thumbnail (the native player's poster), if stored

isCompetitorboolean

Whether the tracked account is marked as a competitor

isExcludedboolean

Whether this video is excluded from analytics: its metrics are omitted from dashboards, aggregate totals, and exports

adSpendByCurrencyobject

This organization's total Spark Ads spend on this video, keyed by advertiser currency — one video can be boosted by several ads and advertisers

Example response

{
  "id": "vid_91rBGUI9L6Db",
  "platformVideoId": "76891234567890012345678",
  "platform": "tiktok",
  "accountUsername": "viral_creator",
  "platformAccountId": "6891234567890",
  "accountDisplayName": "Viral Creator",
  "accountProfilePictureUrl": "https://example.com/profile.jpg",
  "caption": "Amazing viral content! #trending #viral #fyp",
  "hashtags": [
    "trending",
    "viral",
    "fyp"
  ],
  "contentType": "video",
  "videoIndex": 1,
  "thumbnailUrl": "https://example.com/thumbnail.jpg",
  "musicId": "music_123",
  "musicTitle": "Trending Song",
  "musicArtist": "Popular Artist",
  "musicAlbum": "Hit Album",
  "musicPlayUrl": "https://example.com/music.mp3",
  "musicCoverUrl": "https://example.com/cover.jpg",
  "isOriginalMusic": false,
  "durationSeconds": 45,
  "viewCount": 1250000,
  "likeCount": 125000,
  "commentCount": 8500,
  "shareCount": 15000,
  "bookmarkCount": 35000,
  "engagementRate": 0.1464,
  "viralityFactor": 8.5,
  "publishedDate": "2025-12-15",
  "publishedAt": "2025-12-15T18:30:00Z",
  "loadAt": "2025-12-20T08:00:00Z",
  "orgAccountId": "orgacc_W97M6KLWV4Yq",
  "isExcluded": false,
  "tracking_status": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.