Viral Video Library

Get a viral video

Returns one research library video by id, or null when it is not (or no longer) in the library.

get/library/viral-videos/{videoId}

Request

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

Path parameters

videoIdstring required

Response

OK

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

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

platformVideoIdstring required
platformAccountIdstring nullable required
accountUsernamestring nullable required
accountDisplayNamestring nullable required
accountProfilePictureUrlstring nullable required
accountFollowerCountnumber nullable required
regionstring nullable

Region code (2-letter ISO country code)

captionstring nullable required
hashtagsstring[] nullable required
downloadUrlstring nullable required
musicTitlestring nullable required
musicArtiststring nullable required
durationSecondsnumber nullable required
thumbnailUrlstring nullable required
viewCountnumber nullable required
likeCountnumber nullable required
commentCountnumber nullable required
shareCountnumber nullable required
bookmarkCountnumber nullable required
engagementRatenumber nullable required
outlierFactornumber nullable required
publishedAtstring date-time nullable required
lastSeenAtstring date-time required
addedAtstring date-time required

When the video entered the library

matchedTermsstring[] nullable required
isUgcboolean nullable required
ugcConfidencenumber nullable required
verticalstring nullable required

Research vertical (niche), e.g. education_study

formatPrimarystring nullable required

Primary video format, e.g. product_demo_review

hookArchetypestring nullable required

Hook archetype, e.g. curiosity_gap

hookTextOverlaystring nullable required

The on-screen hook text in the first seconds, if any

whyItWorkedstring nullable required

One-paragraph research verdict on why it went viral

replicationTipstring nullable required

How a marketer could adapt the pattern

relatedMatchunknown

Example response

{
  "platform": "facebook",
  "region": "US",
  "copies": [
    {
      "platform": "facebook"
    }
  ]
}

Changes

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