> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Spotlightr

> Spotlightr is a video hosting and streaming platform that captures leads, updates contacts with engagement data, and provides analytics reporting.

![Spotlightr logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/spotlightr.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=fbf8e23282ee7fcdac8412b390670817)

* **Category:** video & audio
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `SPOTLIGHTR`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Domain
>
> **Slug:** `SPOTLIGHTR_ADD_DOMAIN`
>
> Tool to add a whitelisted domain for embedding Spotlightr videos. Use when you need to whitelist a new domain for video embedding.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Domain to whitelist for embedding videos (e.g., example.com or test-domain-example.com)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Group
>
> **Slug:** `SPOTLIGHTR_CREATE_GROUP`
>
> Tool to create a new project (group) in Spotlightr. Use when you need to organize videos into a new project or group.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the project/group to create
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Video
>
> **Slug:** `SPOTLIGHTR_CREATE_VIDEO`
>
> Create 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
>
> **URL** `string` *required*
>
> File path or URL to the video source (YouTube, Google Drive, Vimeo, etc.)
>
> **hls** `integer`
>
> Media streaming protocol: 0 to leave as unsecured, 1 to encode with HLS
>
> **name** `string` *required*
>
> The name of the video
>
> **create** `integer`
>
> Type of creation: 0 to debug (test without creating), 1 to confirm creation
>
> **customS3** `string`
>
> Custom S3 integration ID. Use '0' for default storage or provide custom integration ID
>
> **videoGroup** `string`
>
> Video group ID to associate the video with
>
> **playerSettings** `object`
>
> Player configuration settings object for customizing video player appearance and behavior
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Video
>
> **Slug:** `SPOTLIGHTR_DELETE_VIDEO`
>
> Tool to delete or remove videos from Spotlightr projects. Use when you need to permanently delete one or more videos by their IDs.
>
> #### Input Parameters
>
> **video\_ids** `array` *required*
>
> List of video IDs to delete. Must contain at least one video ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domains
>
> **Slug:** `SPOTLIGHTR_GET_DOMAINS`
>
> Tool to retrieve whitelisted domains for a Spotlightr account. Use when you need to list all domains approved for embedding videos.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Top Videos
>
> **Slug:** `SPOTLIGHTR_GET_TOP_VIDEOS`
>
> Tool to retrieve the top videos from a Spotlightr account. Use when you need to list the most viewed videos.
>
> #### Input Parameters
>
> **days** `integer`
>
> Number of days to look back for top videos (default 30)
>
> **total** `integer`
>
> Number of top videos to return (default 3)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video Metrics
>
> **Slug:** `SPOTLIGHTR_GET_VIDEO_METRICS`
>
> Tool 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
>
> **video\_id** `string` *required*
>
> ID of the video to fetch metrics for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video Source
>
> **Slug:** `SPOTLIGHTR_GET_VIDEO_SOURCE`
>
> Replace the source URL of an existing Spotlightr video.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Video ID whose source is to be replaced
>
> **URL** `string` *required*
>
> New URL for the video source
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video Views
>
> **Slug:** `SPOTLIGHTR_GET_VIDEO_VIEWS`
>
> Tool 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
>
> **videoID** `integer` *required*
>
> Video identifier for retrieving view data
>
> **allViews** `boolean`
>
> Return all views without pagination
>
> **onlyWatched** `boolean`
>
> Filter to only include views with percentWatched > 1
>
> **customViewerID** `string`
>
> ID or email of a known viewer to filter views by specific viewer
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Groups
>
> **Slug:** `SPOTLIGHTR_LIST_GROUPS`
>
> Tool to retrieve all projects (groups) in a Spotlightr account. Use when you need to list all available projects or groups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Videos
>
> **Slug:** `SPOTLIGHTR_LIST_VIDEOS`
>
> Tool 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
>
> **video\_id** `integer`
>
> Identifier for a specific video record to retrieve
>
> **video\_group** `integer`
>
> Identifier for filtering videos by project association
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Global
>
> **Slug:** `SPOTLIGHTR_SEARCH_GLOBAL`
>
> Tool 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
>
> **query** `string`
>
> Search query string to search across videos and content. If not provided, returns all content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
