Account Analytics

Get account details

Retrieves comprehensive account details including profile data (followers, following, display name), tracking metadata, and computed lifetime analytics (total views, engagement rate, virality rate, video counts, post activity).

get/accounts/{platform}/{platformAccountId}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/accounts/{platform}/{platformAccountId}
  • 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
platformAccountIdstring required

Native platform account id

Example:7123456789012345678

Response

OK

idstring required

Organization-specific account ID

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

Social media platform (tiktok, instagram, youtube)

platformAccountIdstring required

Platform-specific account identifier

maxVideosinteger required

Maximum number of videos to track for this account

lastErrorAtstring date-time nullable required

Timestamp of last sync error, if any

lastErrorCode'NOT_FOUND' | 'INVALID_DATA' | 'PRIVATE_CONTENT' | 'RESTRICTED' | 'UNSUPPORTED_CONTENT' | 'APPLE_REQUIRED_AGREEMENT' | 'APPLE_INVALID_VENDOR' | 'APPLE_INVALID_CREDENTIALS' nullable required

Error code from last failed sync attempt

createdAtstring date-time required

When this account tracking was created

updatedAtstring date-time required

When this account tracking was last updated

userIdstring required

ID of the user who added this account

orgIdstring required

Organization that owns this account tracking

orgCreatorIdstring nullable required

Assigned organization creator ID, if linked

creatorUserIdstring nullable required

Assigned creator user ID for this account, if linked

creatorNamestring nullable required

Assigned creator display name, if linked

creatorEmailstring nullable required

Assigned creator email, if linked

creatorImagestring nullable required

Assigned creator profile image URL, if linked

usernamestring nullable required

Account username/handle on the platform

loadAtstring nullable required

Timestamp when account data was last loaded

followerCountnumber nullable required

Number of followers for this account

followingCountnumber nullable required

Number of accounts this account is following

profilePictureUrlstring nullable required

URL to the account's profile picture

displayNamestring nullable required

Display name of the account

countryCodestring nullable required

Country code where the account is based

isCompetitorboolean required

Whether the tracked account is marked as a competitor

totalVideosTrackednumber nullable required

Count of videos actively tracked within the max videos setting

totalVideosRetainednumber nullable required

Count of historic videos retained beyond the active tracking limit

totalVideosExcludednumber required

Count of videos within the tracking window hidden from analytics by the Excluded tag (exclusion workflows or manual exclusions); 0 when the organization excludes nothing

totalVideosPublishednumber nullable required

Total number of all-time videos published by this account. Null on platforms that publish no such total (YouTube, Facebook, Snapchat); sorting by this field orders those accounts by totalVideosTracked + totalVideosRetained instead

totalViewsnumber nullable required

Total lifetime views across all videos

totalLikesnumber nullable required

Total lifetime likes across all videos

totalCommentsnumber nullable required

Total lifetime comments across all videos

totalSharesnumber nullable required

Total lifetime shares across all videos

totalBookmarksnumber nullable required

Total lifetime bookmarks across all videos

averageViewsPerVideonumber nullable required

Average views across all tracked videos, rounded to whole views

p10Viewsnumber nullable required

10th percentile views across all tracked videos, rounded to whole views

p50Viewsnumber nullable required

Median (50th percentile) views across all tracked videos, rounded to whole views

p90Viewsnumber nullable required

90th percentile views across all tracked videos, rounded to whole views

viralityRatenumber nullable required

Virality rate based on capped P90/P50 lift (0–100)

latestVideoPublishedAtstring nullable required

Timestamp of when the latest video was published

daysSinceLastPostnumber nullable required

Number of days since the last video was published

engagementRatenumber nullable required

Overall engagement rate (likes+comments+shares+bookmarks)/views

Example response

{
  "isCompetitor": true,
  "tags": [
    {
      "scope": "system",
      "color": "#2563EB"
    }
  ],
  "videoTags": [
    {
      "scope": "system",
      "color": "#2563EB"
    }
  ]
}

Changes

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