Skip to main content
Spotlightr logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: SPOTLIGHTR
  • Version: 20261101_00

Tools

Slug: SPOTLIGHTR_ADD_DOMAINTool to add a whitelisted domain for embedding Spotlightr videos. Use when you need to whitelist a new domain for video embedding.

Input Parameters

string
required
Domain to whitelist for embedding videos (e.g., example.com or test-domain-example.com)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_CREATE_GROUPTool to create a new project (group) in Spotlightr. Use when you need to organize videos into a new project or group.

Input Parameters

string
required
Name of the project/group to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_CREATE_VIDEOCreate a Spotlightr video from an external source URL, such as YouTube, Google Drive, or Vimeo. The request can also run in debug mode instead of creating a video.

Input Parameters

string
required
File path or URL to the video source (YouTube, Google Drive, Vimeo, etc.)
integer
Media streaming protocol: 0 to leave as unsecured, 1 to encode with HLS
string
required
The name of the video
integer
Type of creation: 0 to debug (test without creating), 1 to confirm creation
string
Custom S3 integration ID. Use ‘0’ for default storage or provide custom integration ID
string
Video group ID to associate the video with
object
Player configuration settings object for customizing video player appearance and behavior

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_DELETE_VIDEOTool to delete or remove videos from Spotlightr projects. Use when you need to permanently delete one or more videos by their IDs.

Input Parameters

array
required
List of video IDs to delete. Must contain at least one video ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_GET_DOMAINSTool to retrieve whitelisted domains for a Spotlightr account. Use when you need to list all domains approved for embedding videos.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_GET_TOP_VIDEOSTool to retrieve the top videos from a Spotlightr account. Use when you need to list the most viewed videos.

Input Parameters

integer
Number of days to look back for top videos (default 30)
integer
Number of top videos to return (default 3)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_GET_VIDEO_METRICSTool to retrieve analytics metrics for a specified video. Use when you have a video ID and need its metrics (loads, plays, playRate, completionRate, shares, etc.).

Input Parameters

string
required
ID of the video to fetch metrics for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_GET_VIDEO_SOURCEReplace the source URL of an existing Spotlightr video.

Input Parameters

integer
required
Video ID whose source is to be replaced
string
required
New URL for the video source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_GET_VIDEO_VIEWSTool to retrieve video view data with optional filtering by viewer ID and watch status. Use when you need detailed view records for a specific video.

Input Parameters

integer
required
Video identifier for retrieving view data
boolean
Return all views without pagination
boolean
Filter to only include views with percentWatched > 1
string
ID or email of a known viewer to filter views by specific viewer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_LIST_GROUPSTool to retrieve all projects (groups) in a Spotlightr account. Use when you need to list all available projects or groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_LIST_VIDEOSTool to retrieve videos from a Spotlightr account. Use when you need to list all videos or filter by specific video ID or project.

Input Parameters

integer
Identifier for a specific video record to retrieve
integer
Identifier for filtering videos by project association

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SPOTLIGHTR_SEARCH_GLOBALTool to perform account-wide search across all videos and content in Spotlightr. Use when you need to find specific videos, projects, or content by name or keyword.

Input Parameters

string
Search query string to search across videos and content. If not provided, returns all content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not