Easel TV

https://docs.easeltv.com/
Admin
Easel TV is a platform offering comprehensive guides and API documentation to help users quickly...
Tokens:1,102,636
Snippets:2,630
Trust Score:7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Fetch Labels - Node.js Example

Source: https://docs.easeltv.com/reference/label

This Node.js code snippet illustrates how to make a GET request to the 'Fetches labels' API endpoint. It utilizes the 'node-fetch' library to send the request and handle the JSON response. Ensure 'node-fetch' is installed (`npm install node-fetch`).

```javascript
import fetch from 'node-fetch';

const url = "https://prod.suggestedtv.com/api/dashboard/v1/label";

async function fetchLabels() {
  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: {
        'accept': 'application/json'
      }
    });
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error('Error fetching labels:', error);
  }
}

fetchLabels();
```

--------------------------------

### POST /v1/intro-video

Source: https://docs.easeltv.com/reference/post_v1-intro-video

Creates a new intro video with specified details. This endpoint allows for the creation of intro videos, associating them with VOD media and market IDs, and configuring playback and skippable options.

```APIDOC
## POST /v1/intro-video

### Description
Creates a new intro video.

### Method
POST

### Endpoint
https://prod.suggestedtv.com/api/dashboard/v1/intro-video

### Parameters
#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the intro video
- **vodMediaId** (string) - Required - The ID of the vod media to be associated with the intro video
- **description** (string) - Optional - The description of the intro video
- **marketId** (string) - Optional - The ID of the market to be associated with the intro video
- **numberOfTimesToPlay** (number) - Optional - A positive number indicating the number of times the intro video should be played
- **skippable** (boolean) - Optional - Whether the intro video can be skipped.

### Request Example
```json
{
  "name": "Welcome Video",
  "vodMediaId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "description": "A brief introduction to Easel TV",
  "marketId": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
  "numberOfTimesToPlay": 3,
  "skippable": true
}
```

### Response
#### Success Response (201)
- **id** (string) - The ID of the intro video
- **name** (string) - The name of the intro video
- **description** (string) - The description of the intro video
- **vodMediaId** (string) - The ID of the vod media to be associated with the intro video
- **marketId** (string) - The ID of the market to be associated with the intro video
- **numberOfTimesToPlay** (number) - A positive number indicating the number of times the intro video should be played
- **skippable** (boolean) - Whether the intro video can be skipped.
- **created** (string) - The date the item was created in the system (date-time format)
- **updated** (string) - The date the item was last updated in the system (date-time format)

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Welcome Video",
  "description": "A brief introduction to Easel TV",
  "vodMediaId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "marketId": "f0e9d8c7-b6a5-4321-0987-654321fedcba",
  "numberOfTimesToPlay": 3,
  "skippable": true,
  "created": "2023-10-27T10:00:00Z",
  "updated": "2023-10-27T10:00:00Z"
}
```

#### Error Response (400)
- **description** (string) - Details about the bad request.
```

--------------------------------

### GET /v1/intro-video

Source: https://docs.easeltv.com/reference/get_v1-intro-video

Fetches intro videos from the Easel TV Dashboard. Supports filtering, sorting, and pagination.

```APIDOC
## GET /v1/intro-video

### Description
Fetches intro videos from the Easel TV Dashboard. Supports filtering, sorting, and pagination.

### Method
GET

### Endpoint
/v1/intro-video

### Parameters
#### Query Parameters
- **ids** (string) - Optional - A comma separated list of the IDs to retrieve up to a maximum of 100. If specified, the limit, offset, filter and query parameters are ignored.
- **limit** (number) - Optional - The number of items to return up to a maximum of 100. Defaults to 50.
- **offset** (number) - Optional - Used for pagination. Determines how many items to offset the results by. Defaults to 0.
- **sort-by** (string) - Optional - Determines what field and order the results should be sorted by. It can be set to an enumeration of either 'created', 'updated' or 'name'. By default results are returned in ascending order. The enumeration can be prefixed by a '-' symbol to denote descending order. Defaults to 'updated'.
- **query** (string) - Optional - Returns items that have a name like the query or matches the ID. Case insensitive.

### Request Example
```json
{
  "query": "example"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of intro video objects.
  - **id** (string) - The ID of the intro video.
  - **name** (string) - The name of the intro video.
  - **description** (string) - The description of the intro video.
  - **vodMediaId** (string) - The ID of the vod media to be associated with the intro video.
  - **marketId** (string) - The ID of the market to be associated with the intro video.
  - **numberOfTimesToPlay** (number) - A positive number indicating the number of times the intro video should be played.
  - **skippable** (boolean) - Whether the intro video can be skipped.
  - **created** (string) - The date the item was created in the system.
  - **updated** (string) - The date the item was last updated in the system.

#### Response Example
```json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "name": "Welcome Video",
      "description": "An introductory video for new users.",
      "vodMediaId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
      "marketId": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",
      "numberOfTimesToPlay": 3,
      "skippable": true,
      "created": "2023-10-27T10:00:00Z",
      "updated": "2023-10-27T10:30:00Z"
    }
  ]
}
```
```

--------------------------------

### Fetch Price Bands PHP Example

Source: https://docs.easeltv.com/reference/price-band

Shows how to fetch price bands using PHP. This example uses the cURL extension to make the HTTP GET request and retrieve the JSON response.

```php
// Example for PHP

<?php

$url = 'https://prod.suggestedtv.com/api/dashboard/v1/price-band';
$headers = array(
    'accept: application/json'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

c_close($ch);

?>
```

--------------------------------

### PUT /v1/intro-video/{id}

Source: https://docs.easeltv.com/reference/put_v1-intro-video-id

Updates an existing intro video by its ID. Allows modification of name, description, associated media, and playback settings.

```APIDOC
## PUT /v1/intro-video/{id}

### Description
Updates an existing intro video by its ID. This endpoint allows you to modify various attributes of an intro video, including its name, description, associated video media, market, playback count, and skippable status.

### Method
PUT

### Endpoint
/v1/intro-video/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the intro video to update (UUID format).

#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the intro video.
- **vodMediaId** (string) - Required - The ID of the vod media to be associated with the intro video (UUID format).
- **id** (string) - Optional - The ID of the intro video (UUID format).
- **description** (string) - Optional - The description of the intro video.
- **marketId** (string) - Optional - The ID of the market to be associated with the intro video (UUID format).
- **numberOfTimesToPlay** (number) - Optional - A positive number indicating the number of times the intro video should be played.
- **skippable** (boolean) - Optional - Whether the intro video can be skipped.

### Request Example
```json
{
  "name": "Updated Intro Video Name",
  "vodMediaId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "description": "This is an updated description for the intro video.",
  "marketId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "numberOfTimesToPlay": 3,
  "skippable": false
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the intro video (UUID format).
- **name** (string) - The name of the intro video.
- **description** (string) - The description of the intro video.
- **vodMediaId** (string) - The ID of the vod media associated with the intro video (UUID format).
- **marketId** (string) - The ID of the market associated with the intro video (UUID format).
- **numberOfTimesToPlay** (number) - The number of times the intro video should be played.
- **skippable** (boolean) - Whether the intro video can be skipped.
- **created** (string) - The date the item was created in the system (date-time format).
- **updated** (string) - The date the item was last updated in the system (date-time format).

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Updated Intro Video Name",
  "description": "This is an updated description for the intro video.",
  "vodMediaId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "marketId": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
  "numberOfTimesToPlay": 3,
  "skippable": false,
  "created": "2023-10-27T10:00:00Z",
  "updated": "2023-10-27T10:30:00Z"
}
```
```

--------------------------------

### Fetch Price Bands Node.js Example

Source: https://docs.easeltv.com/reference/price-band

Provides an example of how to fetch price bands using Node.js. This snippet demonstrates making an HTTP GET request to the API endpoint and handling the JSON response.

```javascript
// Example for Node.js (using fetch, available in recent versions)

async function getPriceBands() {
  const url = 'https://prod.suggestedtv.com/api/dashboard/v1/price-band';
  const headers = {
    'accept': 'application/json'
  };

  try {
    const response = await fetch(url, {
      method: 'GET',
      headers: headers
    });

    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }

    const data = await response.json();
    console.log(data);
    return data;
  } catch (error) {
    console.error('Error fetching price bands:', error);
  }
}

getPriceBands();
```

--------------------------------

### POST /v1/vod-media/{id}/start-encode

Source: https://docs.easeltv.com/reference/post_v1-vod-media-id-start-encode

Initiates the encoding process for a specific VoD media item. The response indicates if the encoding has started, and further status can be obtained via GET requests or webhooks.

```APIDOC
## POST /v1/vod-media/{id}/start-encode

### Description
Encodes a managed VoD media. The response signifies that the encoding has successfully started. To check for completion, you can make a GET request or subscribe using a webhook.

### Method
POST

### Endpoint
https://prod.suggestedtv.com/api/dashboard/v1/vod-media/{id}/start-encode

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the VoD media.

#### Query Parameters
None

#### Request Body
- **quality** (string) - Required - The maximum quality of the encode. Enum: ["sd", "hd"]

### Request Example
```json
{
  "quality": "hd"
}
```

### Response
#### Success Response (200)
- **description** (string) - Success response signifies the encode has successfully started. To check for when an encode completes either make a get request or subscribe using a webhook.

#### Response Example
(No specific JSON structure provided for success response, only a description)

#### Error Response (400, 404)
- **key** (string) - The unique key for the type of error that occurred.
- **name** (string) - The name of the error that occurred.
- **description** (string) - Describes the error that occurred in more detail.
- **data** (object) - Contains parameters of the error in an easy to access format. The properties of this object depend on the type of error that occurred. For example, a not found error would contain the type of object and the ID of the object that could not be found.

#### Error Response Example (400/404)
```json
{
  "key": "error.generic.not-found",
  "name": "Not Found",
  "description": "The requested product 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found.",
  "data": {}
}
```
```

--------------------------------

### POST /websites/easeltv/bundles

Source: https://docs.easeltv.com/reference/post_v1-bundle

Creates a new bundle with specified details, including pricing, availability, and associated tiers.

```APIDOC
## POST /websites/easeltv/bundles

### Description
Creates a new bundle with specified details, including pricing, availability, and associated tiers.

### Method
POST

### Endpoint
/websites/easeltv/bundles

### Parameters
#### Request Body
- **name** (string) - Required - The name of the bundle.
- **description** (string) - Optional - The description of the bundle.
- **details** (string) - Optional - Any additional information regarding this bundle.
- **children** (array[uuid]) - Required - An array containing IDs of tiers which belong to this bundle.
- **availabilityWindows** (object) - Required - An object defining the availability windows for the bundle.
  - **daily** (object) - Optional - Daily pricing and availability.
    - **marketId** (uuid) - Required - The ID for the market of the availability window.
    - **priceBandId** (uuid) - Required - The ID of the price band.
  - **weekly** (object) - Optional - Weekly pricing and availability.
    - **marketId** (uuid) - Required - The ID for the market of the availability window.
    - **priceBandId** (uuid) - Required - The ID of the price band.
  - **monthly** (object) - Optional - Monthly pricing and availability.
    - **marketId** (uuid) - Required - The ID for the market of the availability window.
    - **priceBandId** (uuid) - Required - The ID of the price band.
  - **yearly** (object) - Optional - Yearly pricing and availability.
    - **marketId** (uuid) - Required - The ID for the market of the availability window.
    - **priceBandId** (uuid) - Required - The ID of the price band.

### Request Example
```json
{
  "name": "Example Bundle",
  "children": ["tier-id-1", "tier-id-2"],
  "availabilityWindows": {
    "daily": {
      "marketId": "market-id-1",
      "priceBandId": "price-band-id-daily"
    },
    "weekly": {
      "marketId": "market-id-1",
      "priceBandId": "price-band-id-weekly"
    }
  }
}
```

### Response
#### Success Response (200)
- **id** (uuid) - The ID of the bundle.
- **created** (date-time) - The date the item was created in the system.
- **updated** (date-time) - The date the item was last updated in the system.
- **name** (string) - The name of the bundle.
- **description** (string) - The description of the bundle.
- **details** (string) - Any additional information regarding this bundle.
- **children** (array[uuid]) - An array containing IDs of tiers which belong to this bundle.
- **availabilityWindows** (object) - Availability windows for the bundle.
  - **daily** (object) - Daily pricing and availability.
    - **marketId** (uuid) - The ID for the market of the availability window.
    - **priceBandId** (uuid) - The ID of the price band.
  - **weekly** (object) - Weekly pricing and availability.
    - **marketId** (uuid) - The ID for the market of the availability window.
    - **priceBandId** (uuid) - The ID of the price band.
  - **monthly** (object) - Monthly pricing and availability.
    - **marketId** (uuid) - The ID for the market of the availability window.
    - **priceBandId** (uuid) - The ID of the price band.
  - **yearly** (object) - Yearly pricing and availability.
    - **marketId** (uuid) - The ID for the market of the availability window.
    - **priceBandId** (uuid) - The ID of the price band.
- **image** (object) - The images to use with this bundle.
  - **master** (object) - Master image details.
    - **imageId** (uuid) - The ID of the image to be used.
    - **imageRenditionId** (uuid) - The image rendition ID.
    - **autoGenerated** (boolean) - Whether the rendition was auto-generated by the system.
    - **crop** (object) - Crop details.

#### Response Example
```json
{
  "id": "bundle-id-123",
  "created": "2023-10-27T10:00:00Z",
  "updated": "2023-10-27T10:00:00Z",
  "name": "Example Bundle",
  "description": "A description of the example bundle.",
  "details": "Additional details about the bundle.",
  "children": ["tier-id-1", "tier-id-2"],
  "availabilityWindows": {
    "daily": {
      "marketId": "market-id-1",
      "priceBandId": "price-band-id-daily"
    },
    "weekly": {
      "marketId": "market-id-1",
      "priceBandId": "price-band-id-weekly"
    }
  },
  "image": {
    "master": {
      "imageId": "image-id-abc",
      "imageRenditionId": "rendition-id-xyz",
      "autoGenerated": false,
      "crop": {}
    }
  }
}
```
```

--------------------------------

### GET /websites/easeltv/encoding/status

Source: https://docs.easeltv.com/reference/post_v1-live-media

Retrieves the status and statistics of a live media encoding job. This endpoint provides details about when the encoding was queued, started, and ended, along with input URLs and connection status.

```APIDOC
## GET /websites/easeltv/encoding/status

### Description
Retrieves the status and statistics of a live media encoding job. This endpoint provides details about when the encoding was queued, started, and ended, along with input URLs and connection status.

### Method
GET

### Endpoint
/websites/easeltv/encoding/status

### Parameters

#### Query Parameters
- **jobId** (string) - Required - The unique identifier for the encoding job.

### Request Example
```
GET /websites/easeltv/encoding/status?jobId=example-job-id
```

### Response
#### Success Response (200)
- **queued** (string, format: date-time) - The date and time when the encoding was queued.
- **started** (string, format: date-time) - The date and time when the encoding started running.
- **ended** (string, format: date-time) - The date and time when the encoding ended.
- **inputUrl** (string, format: url) - The URL to send the input stream to. Only becomes available after the encode is in status 'running'.
- **backupInputUrl** (string, format: url) - The URL to send the backup input stream to. Only becomes available after the encode is in status 'running'. Only available when the input type is SRT.
- **key** (string) - The key used when sending the input stream to the input URL, only returned when the live media input type is RTMP.
- **extend** (object) - Contains extended statistics about the encoding job.
  - **statistics** (object) - Detailed statistics of the input stream and metrics.
    - **inputStatus** (string, enum: "awaiting-first-connect", "connected", "disconnected", "error", "not-available", "finished") - The current status of the input stream.
    - **metrics** (array) - An array of metric measurements.
      - **occurred** (string, format: date-time) - When the measurement was taken.
      - **streams** (array) - An array of media stream metrics.
        - **mediaType** (string, enum: "audio", "video") - The type of the media stream.
        - **width** (number) - The width of the video in pixels. Not returned where the media type is audio.
        - **height** (number) - The height of the video in pixels. Not returned where the media type is audio.
        - **rate** (number) - The data rate in bits per second.
        - **codec** (string) - The codec used for the stream.
        - **samples** (number) - The number of samples for the stream.
        - **backupSamples** (number) - The number of samples for the backup stream.
        - **bytes** (number) - The number of bytes received for the stream.
        - **backupBytes** (number) - The number of bytes received for the backup stream.

#### Response Example
```json
{
  "queued": "2023-10-27T10:00:00Z",
  "started": "2023-10-27T10:05:00Z",
  "ended": "2023-10-27T10:55:00Z",
  "inputUrl": "rtmp://example.com/live/stream1",
  "backupInputUrl": "srt://backup.example.com:1234",
  "key": "secret-key-123",
  "extend": {
    "statistics": {
      "inputStatus": "connected",
      "metrics": [
        {
          "occurred": "2023-10-27T10:30:00Z",
          "streams": [
            {
              "mediaType": "video",
              "width": 1920,
              "height": 1080,
              "rate": 5000000,
              "codec": "h264",
              "samples": 100000,
              "backupSamples": 95000,
              "bytes": 200000000,
              "backupBytes": 190000000
            },
            {
              "mediaType": "audio",
              "rate": 128000,
              "codec": "aac",
              "samples": 50000,
              "backupSamples": 48000,
              "bytes": 10000000,
              "backupBytes": 9500000
            }
          ]
        }
      ]
    }
  }
}
```
```

--------------------------------

### POST /websites/easeltv/introvideo

Source: https://docs.easeltv.com/reference/put_v1-intro-video-id

This endpoint is used to create or update an intro video for the easeltv website. It accepts video details in the request body and returns the created or updated intro video information upon success. Error responses are provided for bad requests or if an intro video with the specified ID already exists.

```APIDOC
## POST /websites/easeltv/introvideo

### Description
This endpoint creates or updates an intro video for the easeltv website. It requires specific video details in the request body.

### Method
POST

### Endpoint
/websites/easeltv/introvideo

### Parameters
#### Request Body
- **name** (string) - Required - The name of the intro video.
- **url** (string) - Required - The URL of the intro video.
- **description** (string) - Optional - A description for the intro video.

### Request Example
```json
{
  "name": "Welcome Video",
  "url": "https://example.com/videos/welcome.mp4",
  "description": "A brief introduction to our platform."
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the intro video.
- **name** (string) - The name of the intro video.
- **url** (string) - The URL of the intro video.
- **description** (string) - A description for the intro video.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "Welcome Video",
  "url": "https://example.com/videos/welcome.mp4",
  "description": "A brief introduction to our platform."
}
```

#### Error Responses
- **400 Bad Request**: Indicates an issue with the request payload.
  - **key** (string) - The unique key for the type of error.
  - **name** (string) - The name of the error.
  - **description** (string) - Detailed description of the error.
  - **data** (object) - Contains parameters of the error.
- **409 Conflict**: Indicates that an intro video with the specified ID already exists.
  - **key** (string) - The unique key for the type of error.
  - **name** (string) - The name of the error.
  - **description** (string) - Detailed description of the error.
  - **data** (object) - Contains parameters of the error.
```

--------------------------------

### Fetch Person Types - PHP Request

Source: https://docs.easeltv.com/reference/person-type

Example of how to retrieve person types using PHP. This snippet illustrates making a GET request to the API.

```PHP
// PHP example would go here
// Uses cURL functions or stream contexts
```

--------------------------------

### GET /v1/intro-video/{id}

Source: https://docs.easeltv.com/reference/get_v1-intro-video-id

Fetches a specific intro video by its ID. This endpoint allows retrieval of detailed information about an intro video, including its name, associated media, playback settings, and timestamps.

```APIDOC
## GET /v1/intro-video/{id}

### Description
Fetches a specific intro video by its ID. This endpoint allows retrieval of detailed information about an intro video, including its name, associated media, playback settings, and timestamps.

### Method
GET

### Endpoint
/v1/intro-video/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the intro video (format: uuid)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **id** (string) - The ID of the intro video (format: uuid)
- **name** (string) - The name of the intro video
- **vodMediaId** (string) - The ID of the vod media to be associated with the intro video (format: uuid)
- **skippable** (boolean) - Whether the intro video can be skipped.
- **created** (string) - The date the item was created in the system (format: date-time)
- **updated** (string) - The date the item was last updated in the system (format: date-time)
- **description** (string) - Optional - The description of the intro video
- **marketId** (string) - Optional - The ID of the market to be associated with the intro video (format: uuid)
- **numberOfTimesToPlay** (number) - Optional - A positive number indicating the number of times the intro video should be played

#### Response Example
```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Welcome Video",
  "description": "A brief introduction to Easel TV.",
  "vodMediaId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "marketId": "f0e9d8c7-b6a5-4321-0fed-cba987654321",
  "numberOfTimesToPlay": 3,
  "skippable": false,
  "created": "2023-10-27T10:00:00Z",
  "updated": "2023-10-27T11:00:00Z"
}
```

#### Error Response (400)
- **description** (string) - Describes the error that occurred in more detail.
- **key** (string) - The unique key for the type of error that occurred.
- **name** (string) - The name of the error that occurred.
- **data** (object) - Optional - Contains parameters of the error in an easy to access format.

#### Error Response Example (400)
```json
{
  "description": "The requested intro video could not be found.",
  "key": "error.intro-video.not-found",
  "name": "Intro Video Not Found",
  "data": {
    "introVideoId": "invalid-uuid-id"
  }
}
```

#### Error Response (404)
(Description for 404 Not Found error would be here if provided in the OpenAPI spec)
```

--------------------------------

### POST /websites/easeltv/intro-videos

Source: https://docs.easeltv.com/reference/post_v1-intro-video

This endpoint is used to add a new intro video to the Easeltv website. It requires specific details in the request body and may return errors if the video already exists or if other issues occur.

```APIDOC
## POST /websites/easeltv/intro-videos

### Description
Adds a new intro video to the website. Returns a 409 error if a video with the same ID already exists.

### Method
POST

### Endpoint
/websites/easeltv/intro-videos

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier for the intro video.

#### Request Body
- **video_url** (string) - Required - The URL of the intro video.
- **language** (string) - Required - The language of the intro video.

### Request Example
```json
{
  "video_url": "https://example.com/videos/intro.mp4",
  "language": "en"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the video was added successfully.

#### Response Example
```json
{
  "message": "Intro video added successfully."
}
```

#### Error Responses
- **409 Conflict**: An intro video with the specified ID already exists.
- **500 Internal Server Error**: An unexpected error occurred on the server.

### Error Schema
- **key** (string) - The unique key for the type of error that occurred.
- **name** (string) - The name of the error that occurred.
- **description** (string) - Describes the error that occurred in more detail.
- **data** (object) - Contains parameters of the error in an easy to access format. The properties of this object depend on the type of error that occurred.
```

--------------------------------

### Fetch Person Types - Ruby Request

Source: https://docs.easeltv.com/reference/person-type

Demonstrates fetching person types in Ruby. This example shows how to perform a GET request to the API endpoint.

```Ruby
# Ruby example would go here
# Requires an HTTP client library like 'net/http' or 'httparty'
```

--------------------------------

### GET /api/dashboard/v1/report/purchase

Source: https://docs.easeltv.com/reference/reports

Fetches purchase data between specified start and end dates. This endpoint is useful for generating sales reports or analyzing purchase trends over time.

```APIDOC
## GET /api/dashboard/v1/report/purchase

### Description
Fetches purchase data between specified start and end dates. This endpoint is useful for generating sales reports or analyzing purchase trends over time.

### Method
GET

### Endpoint
https://prod.suggestedtv.com/api/dashboard/v1/report/purchase

### Parameters
#### Query Parameters
- **from** (string) - Required - Start date for a search
- **to** (string) - Required - End date for a search

### Request Example
```bash
curl --request GET \
     --url "https://prod.suggestedtv.com/api/dashboard/v1/report/purchase?from=2023-01-01&to=2023-01-31" \
     --header 'accept: application/json'
```

### Response
#### Success Response (200)
- **purchases** (array of objects) - Required - An array containing purchase objects.
  - **id** (uuid) - Required - The ID of the purchase.
  - **categoryTypes** (object) - Contains category types information.
  - **priceBandType** (string) - The type of the price band. Enum: `coming-soon`, `free`, `rental`, `rental-midday`, `subscription`.
  - **productId** (uuid) - The ID of the product purchased.
  - **productName** (string) - The name of the product purchased.
  - **deviceId** (string) - The ID of the device associated with this purchase.
  - **deviceName** (string) - The name of the device associated with this purchase.
  - **devicePlatform** (string) - The platform of the device associated with this purchase.
  - **userId** (uuid) - The ID of the user associated with this purchase.
  - **userName** (string) - The name of the user associated with this purchase.
  - **price** (string) - The amount paid for this purchase.
  - **currency** (string) - The currency in which the purchase was made.
  - **balanceAmount** (string) - The amount to be added to your balance after any foreign exchange but before any fees are deducted.
  - **balanceCurrency** (string) - The currency of the amount to be added to your balance.
  - **feeAmount** (string) - The amount charged for this transaction.
  - **feeCurrency** (string) - The currency of the fee charged for this transaction.
  - **priceBandId** (uuid) - The ID for the price band associated with this purchase.
  - **priceBandName** (string) - The name for the price band associated with this purchase.
  - **purchased** (date-time) - Required - The date and time the purchase was processed on.
  - **stripePaymentMethodType** (string) - The payment method used when purchasing with Stripe.
  - **stripeCardLastFourDigit** (string) - The last 4 digits of the card used for purchase in stripe.
  - **legacyMarketId** (uuid) - The ID for the legacy market associated with the purchase.
  - **marketId** (uuid) - The ID for the market associated with the purchase.
  - **marketName** (string) - The name of the market associated with the purchase.
  - **accessWindow** (string) - The period from the purchase during which the viewing window may begin.
  - **viewingWindow** (string) - The period from the when the content is first watched it may continue to be watched.
  - **availableFrom** (date-time) - Required - The date and time from when the product is available for viewing.

#### Response Example (200)
```json
{
  "purchases": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "categoryTypes": {},
      "priceBandType": "rental",
      "productId": "f0e9d8c7-b6a5-4321-0fed-cba987654321",
      "productName": "Movie Title",
      "deviceId": "device-123",
      "deviceName": "Living Room TV",
      "devicePlatform": "SmartTV",
      "userId": "98765432-10fe-dcba-9876-543210fedcba",
      "userName": "John Doe",
      "price": "4.99",
      "currency": "USD",
      "balanceAmount": "4.99",
      "balanceCurrency": "USD",
      "feeAmount": "0.00",
      "feeCurrency": "USD",
      "priceBandId": "1a2b3c4d-5e6f-7890-1234-567890abcdef",
      "priceBandName": "Standard Rental",
      "purchased": "2023-01-15T10:30:00Z",
      "stripePaymentMethodType": "card",
      "stripeCardLastFourDigit": "1234",
      "legacyMarketId": "market-legacy-xyz",
      "marketId": "market-abc",
      "marketName": "North America",
      "accessWindow": "7 days",
      "viewingWindow": "48 hours",
      "availableFrom": "2023-01-15T10:30:00Z"
    }
  ]
}
```

#### Error Response (400)
- **key** (string) - Required - The unique key for the type of error that occurred.
- **name** (string) - Required - The name of the error that occurred.
- **description** (string) - Required - Describes the error that occurred in more detail.
- **data** (object) - Contains parameters of the error in an easy to access format.

#### Response Example (400)
```json
{
  "key": "invalid_date_range",
  "name": "Invalid Date Range",
  "description": "The provided date range is invalid. Please ensure the start date is before the end date.",
  "data": {
    "startDate": "2023-01-31",
    "endDate": "2023-01-01"
  }
}
```
```

--------------------------------

### GET /websites/easeltv/products

Source: https://docs.easeltv.com/reference/post_v1-product

Retrieves a list of products. Supports filtering and pagination.

```APIDOC
## GET /websites/easeltv/products

### Description
Retrieves a list of products available on Easeltv. This endpoint can be used to fetch general product information such as their ID, name, and publication status.

### Method
GET

### Endpoint
/websites/easeltv/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of products to return per page.
- **offset** (integer) - Optional - The number of products to skip before starting to collect the result set.
- **state** (string) - Optional - Filters products by their publication state. Allowed values: "published", "offline".

### Request Example
```
GET /websites/easeltv/products?limit=10&offset=0&state=published
```

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.
  - **id** (string) - The unique ID for the product.
  - **rev** (string) - The current revision ID of the product.
  - **reference** (string) - The unique URL safe identifier for the product.
  - **type** (string) - The type of the product (e.g., "channel").
  - **name** (string) - The name of the product.
  - **created** (string) - The date the product was created in the system (ISO 8601 format).
  - **updated** (string) - The date the product was last updated in the system (ISO 8601 format).
  - **state** (string) - The enum representing whether the product may be visible or not ("offline", "published").
  - **published** (string) - The date and time in the ISO 8601 format which the product was published.
  - **duration** (string) - The duration of the product in the ISO 8601 format (e.g., "PT1H53M").
  - **released** (string) - The original release date of the product in the ISO 8601 format.
  - **images** (array) - An array of image objects associated with the product.
  - **links** (array) - An array of link objects associated with the product.
  - **ageRatings** (array) - An array of age rating objects.
  - **categories** (array) - An array of category objects.
  - **persons** (array) - An array of person objects.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_12345",
      "rev": "rev_abcde",
      "reference": "the-expendables",
      "type": "channel",
      "name": "The Expendables",
      "created": "2023-01-15T10:00:00Z",
      "updated": "2023-01-15T12:00:00Z",
      "state": "published",
      "published": "2023-01-15T18:30:00Z",
      "duration": "PT1H53M",
      "released": "2010-08-19T00:00:00Z",
      "images": [],
      "links": [],
      "ageRatings": [],
      "categories": [],
      "persons": []
    }
  ]
}
```
```

--------------------------------

### Fetch Segments using Python

Source: https://docs.easeltv.com/reference/segment

Example of how to fetch segments using Python with the 'requests' library. This shows how to construct and send a GET request to the segment API endpoint.

```python
import requests

url = 'https://prod.suggestedtv.com/api/dashboard/v1/segment'
headers = {'accept': 'application/json'}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f'Error: {e}')
```
Tokens:
Raw