ViralApp icon

ViralApp

Interact with ViralApp API for video analytics on TikTok, Instagram, and YouTube

Video Data → Get Excluded

AI-generated

Summary

Retrieves a list of videos that have been excluded from ViralApp analytics tracking.

Inputs

  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return (default 50, minimum 1).
  • filters — Collection of filters to narrow results:
  • filters.accounts — Filter by specific account IDs or names.
  • filters.platforms — Filter by social media platform (Instagram, TikTok, YouTube).
  • filters.search — Search by video ID or account username.
  • filters.sortCol — Column to sort by (publishedAt, viewCount, engagementRate).
  • filters.sortDir — Direction to sort (asc, desc).

Output shape

A list of items, each containing video exclusion details.

When 'Simplify Output' is enabled in the Options section, the returned data is cleaned to include only essential fields (id, orgAccountId, platform, platformAccountId, platformVideoId, username, accountDisplayName, createdAt, actorType).

Examples

Example 1: List the most recent 10 excluded videos across all platforms.

Resource: Video Data, Operation: Get Excluded, Return All: false, Limit: 10, Filters: none

Example 2: Retrieve all excluded videos for a specific account (e.g., 'my_account') across all platforms.

Resource: Video Data, Operation: Get Excluded, Return All: true, Filters: accounts=['my_account']

Example 3: Get excluded videos for TikTok, sorted by highest view count.

Resource: Video Data, Operation: Get Excluded, Filters: platforms=['tiktok'], sortCol=['viewCount'], sortDir=['desc']

Links

Discussion