Syntax
The following request is used to check if one or more videos are available for use by your company.
Note: The parameters highlighted in red are placeholders for the mandatory values described bellow.
Single Video Request
http://api.vidible.tv/COMPANY_KEY/video/status/VIDEO_ID?PARAMETERS
Multiple Video Request
http://api.vidible.tv/COMPANY_KEY/video/status/VIDEO_ID,VIDEO_ID?PARAMETERS
- COMPANY_KEY - Replace this placeholder with your Company key.
Note: If you do not have a Company key, please contact our Support team by clicking here. - VIDEO_ID - Replace this placeholder with the required Playlist ID you want to retrieve videos from.
Note: To obtain your Playlist ID, please see How to find your video ID. - PARAMETERS - Please refer to the following parameters section to apply any additional query parameters to the request.
The following parameters and values can be added to the request.
Note: As the query string is already opened for the mandatory Company ID and Query parameters use the ampersands sign '&' to add multiple parameters and values one after the other within the query string.
Parameter | Description | Value |
bcid |
Enter a Company ID in this field to limit the scope of the videos in the returned response. Note: For example, if you have a White Label with several Affiliate you can return only the videos that can be played using a selected Affiliates player. |
bcid=company ID bcid=56d5921ce4b0f5991ad44713 |
offset |
Enter a numeric value from 0 and up to define how many video results will be skipped from the beginning of the result list. Note: For example, Specifying two video IDs in the request and setting the offset filed to 1 will return the second video data only in the response. |
offset=number offset=5 |
limit |
Enter a numeric value from 0 and up to define how many video results will be returned in the response. Note: For example, Specifying three video IDs in the request and setting the offset filed to 2 will only return the first two videos in the response. |
limit=number limit=5 |
status |
Select what status results to return according to the following options:
|
status=ALL (default) status=AVAILABLE status=UNAVAILABLE |
Try it out by clicking here.
Examples
Description: This method is used to check the syndication status of a single video.
Method: GET
URL:
http://api.vidible.tv/9d3f3b3ace557e0937be21eef36982ed/video/status/5773b3a45095493da6cdae79
Response
[
{
"videoId": "56eab78de4b00a7b045b0482",
"available": true
}
]
Multiple Videos including Additional Parameters
Description: This method is used to check the syndication status of a multiple videos including additional parameters.
Method: GET
URL:
http://api.vidible.tv/9d3f3b3ace557e0937be21eef36982ed/video/status/5773b3a45095493da6cdae79,56f17cc8e4b05b1a3f583e69,56eab78de4b00a7b045b0482?limit=100&status=AVAILABLE
Response
[
{
"videoId": "56eab78de4b00a7b045b0482",
"available": true
},
{
"videoId": "5773b3a45095493da6cdae79",
"available": true
},
{
"videoId": "56f17cc8e4b05b1a3f583e69",
"available": true
}
]