# Spotlightr

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

- **Category:** video & audio
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `SPOTLIGHTR`
- **Version:** 20260227_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain to whitelist for embedding videos (e.g., example.com or test-domain-example.com) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the project/group to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video

**Slug:** `SPOTLIGHTR_CREATE_VIDEO`

Tool to create a video in Spotlightr by uploading a file or linking from an external source. Use when you need to add a new video from YouTube, Google Drive, Vimeo, or other sources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `URL` | string | Yes | File path or URL to the video source (YouTube, Google Drive, Vimeo, etc.) |
| `hls` | integer | No | Media streaming protocol: 0 to leave as unsecured, 1 to encode with HLS |
| `name` | string | Yes | The name of the video |
| `create` | integer | No | Type of creation: 0 to debug (test without creating), 1 to confirm creation |
| `customS3` | string | No | Custom S3 integration ID. Use '0' for default storage or provide custom integration ID |
| `videoGroup` | string | No | Video group ID to associate the video with |
| `playerSettings` | object | No | Player configuration settings object for customizing video player appearance and behavior |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_ids` | array | Yes | List of video IDs to delete. Must contain at least one video ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `days` | integer | No | Number of days to look back for top videos (default 30) |
| `total` | integer | No | Number of top videos to return (default 3) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | ID of the video to fetch metrics for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Source

**Slug:** `SPOTLIGHTR_GET_VIDEO_SOURCE`

Tool to get or replace the video source for an existing video in Spotlightr. Use when you need to update a video's source URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Video ID whose source is to be replaced |
| `URL` | string | Yes | New URL for the video source |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `videoID` | integer | Yes | Video identifier for retrieving view data |
| `allViews` | boolean | No | Return all views without pagination |
| `onlyWatched` | boolean | No | Filter to only include views with percentWatched > 1 |
| `customViewerID` | string | No | ID or email of a known viewer to filter views by specific viewer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | integer | No | Identifier for a specific video record to retrieve |
| `video_group` | integer | No | Identifier for filtering videos by project association |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search query string to search across videos and content. If not provided, returns all content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |