GET Search for Videos

Syntax

The following request is used to retrieve a videos by searching for them using a specified term or terms:

Note: The parameters highlighted in red are placeholders for the mandatory values described bellow.

http://api.vidible.tv/COMPANY_KEY/video/search?query=SEARCH_TERM&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.

  • SEARCH_TERM - Replace this placeholder with a single or multiple search terms.
    Note: You can use our search syntax to define a here. For further details, please see How to use our Search Syntax.

  • PARAMETERS - Please refer to the following parameters section to apply any additional query parameters to the request.

 

 

Parameters

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 u
se the ampersands sign '&' to add multiple parameters and values one after the other within the query string.

 

Parameter Description Value
offset

Enter a numeric value to define how many videos will be skipped before returning video results in the call response.

For Example: If I set this field to 3, the search request will not display the first 3 video responses, and start respond only from the 4th one and on.

offset=number

offset=5

limit

Enter a numeric value from 1 and up to limit how many videos will be returned in the call response.

limit=number

limit=5

sort

Sort the search results according to one of the following options:

  • creationdate - Sort videos according to the dates they were created in the platform.
  • modificationdate - Sort videos according to the dates they were last time modified in the platform.
  • publishdate - Sort videos according to their original release dates.

    Note: publishdate field is a metadata that is added to the original video file itself.

  • compositestartdate - Sort videos either according to startdate, which is the video availability date set in the platform, or according to the creationdate (if startdate field in the video file metadata is empty).

    Note: If both startdate and creationdate fields are not empty, the sorting is done by the most recent one.

  • compositeReleaseDate - Sort videos either according to publishdate or according to creationDate (if publishdate field in the video file metadata is empty).
  • plays - Sort videos according to number of video playbacks.

sort=Sort Option

sort=creationdate

sort=modificationdate

ascending   

Sort your search results according to ascending (first to last) or descending (last to first) order.

ascending=true/false

ascending=true(default: first to last)

ascending=false(last to first)

 

Try it out by clicking here.

 

Examples

Request without Parameters

Method: GET

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video/search?query=greetings

Response

{
"totalNumberOfItems": 2,
"numberOfItems": 2,
"data": [
{
"id": "57c57d8b44c8a327adadb3e9",
"companyId": "56d5921ce4b0f5991ad44713",
"companyName": "Support Testing",
"creationDate": 1472560505553,
"modificationDate": 1472561982044,
"name": "Greetings from Another Red Carpet",
"description": "This is my video's description",
"originalVideoUrl": "http://cdn.vidible.tv/prod/2016-03/22/56f17cc8e4b05b1a3f583e69_v1.orig.null",
"length": 93575,
"metadata": {},
"encodedVariants": [],
"commonRating": {
"value": "NR",
"descriptors": [
"AR"
],
"minAge": 0
},
"audienceGender": "All",
"countries": [
"usa",
"afg",
"gbr"
],
"media": {},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"language": {
"code": "ja",
"name": "Japanese",
"mostUsed": true
},
"clickUrl": "http://www.google.com",
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56d5921ee4b0edf4cd64842e",
"deleted": false,
"supportedPlayerTypes": [
"O2"
],
"playbackAvailable": true,
"ageRatings": [
"NONE_SPECIFIED"
],
"storageType": "ENCODED",
"version": 24,
"systemThumbnails": [
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg",
"width": 854,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg",
"width": 853,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg",
"width": 568,
"height": 320
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg",
"width": 256,
"height": 144
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg",
"width": 160,
"height": 90
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg",
"width": 60,
"height": 60
}
],
"classificationResult": {
"concepts": [],
"entities": [],
"taxonomyCategories": [],
"stories": []
},
"hidden": false,
"subtitles": [],
"encodingProfileId": "550a9818e4b0f2847a5ea4f3",
"uploadState": "Failed",
"uploadErrorMessage": "Zencoder job failed: no_input",
"plays": 4,
"tags": [],
"geoRestriction": {
"whiteList": [],
"blackListMode": false
},
"deviceRestriction": {
"whiteList": [],
"blackListMode": false
},
"thumbnailsNew": [
{
"id": "56d5d2dce4b0807330702257",
"covering": true,
"type": "AUTO",
"version": 1,
"sizes": [
{
"original": true,
"width": 854,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg"
},
{
"original": false,
"width": 853,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg"
},
{
"original": false,
"width": 568,
"height": 320,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg"
},
{
"original": false,
"width": 256,
"height": 144,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg"
},
{
"original": false,
"width": 160,
"height": 90,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg"
},
{
"original": false,
"width": 60,
"height": 60,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg"
}
]
}
],
"videoProjectionType": "Equirectangular",
"videoType": "VOD"
},
{
"id": "56d5d2bce4b0f5991ad447ee",
"companyId": "56d5921ce4b0f5991ad44713",
"companyName": "Support Testing",
"creationDate": 1456853692274,
"modificationDate": 1472557362876,
"name": "Greetings from the Red Carpet!",
"shortDescription": "Short desc",
"description": "This is the description value of the 'long description' field in the video entity",
"originalVideoUrl": "http://cdn.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_v1.orig.mp4",
"length": 93575,
"metadata": {},
"keywords": [
"videoEntityCustomKeyword"
],
"encodedVariants": [
{
"audioBitRate": 96,
"width": 853,
"height": 480,
"advancedQuality": false,
"audioQuality": 5,
"videoQuality": 3,
"videoBitRate": 1500,
"crop": false,
"frameStep": true,
"mono": false,
"provider": "ZENCODER",
"aspectRatio": 0,
"tokenEnabled": false,
"cdnProvider": "UNKNOWN",
"videoUrl": "http://cdn.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_v1.mp4",
"fileSizeBytes": 13927700,
"file": ""
},
{
"audioBitRate": 96,
"width": 568,
"height": 320,
"advancedQuality": false,
"audioQuality": 5,
"videoQuality": 3,
"videoBitRate": 1500,
"crop": false,
"frameStep": true,
"mono": false,
"provider": "ZENCODER",
"aspectRatio": 0,
"tokenEnabled": false,
"cdnProvider": "UNKNOWN",
"videoUrl": "http://cdn.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_v1.mp4",
"fileSizeBytes": 9064490,
"file": ""
},
{
"audioBitRate": 96,
"width": 568,
"height": 320,
"advancedQuality": false,
"audioQuality": 5,
"videoQuality": 3,
"videoBitRate": 1500,
"crop": false,
"frameStep": true,
"mono": false,
"provider": "ZENCODER",
"aspectRatio": 0,
"tokenEnabled": false,
"cdnProvider": "UNKNOWN",
"videoUrl": "http://cdn.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_v1.ogg",
"fileSizeBytes": 11063764,
"file": ""
}
],
"commonRating": {
"value": "NR",
"descriptors": [],
"minAge": 0
},
"audienceGender": "All",
"countries": [
"usa",
"afg",
"gbr"
],
"media": {},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"language": {
"code": "ja",
"name": "Japanese",
"mostUsed": true
},
"clickUrl": "http://www.google.com",
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56d5921ee4b0edf4cd64842e",
"deleted": false,
"supportedPlayerTypes": [
"O2"
],
"playbackAvailable": true,
"ageRatings": [
"NONE_SPECIFIED"
],
"storageType": "ENCODED",
"version": 25,
"systemThumbnails": [
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg",
"width": 854,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg",
"width": 853,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg",
"width": 568,
"height": 320
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg",
"width": 256,
"height": 144
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg",
"width": 160,
"height": 90
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg",
"width": 60,
"height": 60
}
],
"classificationResult": {
"concepts": [],
"entities": [],
"taxonomyCategories": [],
"stories": []
},
"hidden": false,
"subtitles": [],
"encodingProfileId": "550a9818e4b0f2847a5ea4f3",
"uploadState": "Ready",
"plays": 2,
"tags": [],
"geoRestriction": {
"whiteList": [],
"blackListMode": false
},
"deviceRestriction": {
"whiteList": [],
"blackListMode": false
},
"thumbnailsNew": [
{
"id": "56d5d2dce4b0807330702257",
"covering": true,
"type": "AUTO",
"version": 1,
"sizes": [
{
"original": true,
"width": 854,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg"
},
{
"original": false,
"width": 853,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg"
},
{
"original": false,
"width": 568,
"height": 320,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg"
},
{
"original": false,
"width": 256,
"height": 144,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg"
},
{
"original": false,
"width": 160,
"height": 90,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg"
},
{
"original": false,
"width": 60,
"height": 60,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg"
}
]
}
],
"videoProjectionType": "Equirectangular",
"videoType": "VOD"
}
],
"status": "SUCCESS",
"requestId": "b117e102-8b9c-11e6-a119-123a413802d5"
}

 

 

Request with Query Parameters

Method: GET

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video/search?query=greetings&limit=1&ascending=false

Response

{
"totalNumberOfItems": 2,
"numberOfItems": 1,
"data": [
{
"id": "57c57d8b44c8a327adadb3e9",
"companyId": "56d5921ce4b0f5991ad44713",
"companyName": "Support Testing",
"creationDate": 1472560505553,
"modificationDate": 1472561982044,
"name": "Greetings from Another Red Carpet",
"description": "This is my video's description",
"originalVideoUrl": "http://cdn.vidible.tv/prod/2016-03/22/56f17cc8e4b05b1a3f583e69_v1.orig.null",
"length": 93575,
"metadata": {},
"encodedVariants": [],
"commonRating": {
"value": "NR",
"descriptors": [
"AR"
],
"minAge": 0
},
"audienceGender": "All",
"countries": [
"usa",
"afg",
"gbr"
],
"media": {},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"language": {
"code": "ja",
"name": "Japanese",
"mostUsed": true
},
"clickUrl": "http://www.google.com",
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56d5921ee4b0edf4cd64842e",
"deleted": false,
"supportedPlayerTypes": [
"O2"
],
"playbackAvailable": true,
"ageRatings": [
"NONE_SPECIFIED"
],
"storageType": "ENCODED",
"version": 24,
"systemThumbnails": [
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg",
"width": 854,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg",
"width": 853,
"height": 480
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg",
"width": 568,
"height": 320
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg",
"width": 256,
"height": 144
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg",
"width": 160,
"height": 90
},
{
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg",
"width": 60,
"height": 60
}
],
"classificationResult": {
"concepts": [],
"entities": [],
"taxonomyCategories": [],
"stories": []
},
"hidden": false,
"subtitles": [],
"encodingProfileId": "550a9818e4b0f2847a5ea4f3",
"uploadState": "Failed",
"uploadErrorMessage": "Zencoder job failed: no_input",
"plays": 4,
"tags": [],
"geoRestriction": {
"whiteList": [],
"blackListMode": false
},
"deviceRestriction": {
"whiteList": [],
"blackListMode": false
},
"thumbnailsNew": [
{
"id": "56d5d2dce4b0807330702257",
"covering": true,
"type": "AUTO",
"version": 1,
"sizes": [
{
"original": true,
"width": 854,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_o_A_v1.jpg"
},
{
"original": false,
"width": 853,
"height": 480,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_853x480_A_v1.jpg"
},
{
"original": false,
"width": 568,
"height": 320,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_568x320_A_v1.jpg"
},
{
"original": false,
"width": 256,
"height": 144,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_256x144_A_v1.jpg"
},
{
"original": false,
"width": 160,
"height": 90,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_160x90_A_v1.jpg"
},
{
"original": false,
"width": 60,
"height": 60,
"url": "http://img.vidible.tv/prod/2016-03/01/56d5d2bce4b0f5991ad447ee_60x60_A_v1.jpg"
}
]
}
],
"videoProjectionType": "Equirectangular",
"videoType": "VOD"
}
],
"status": "SUCCESS",
"requestId": "e50cf77c-8b9c-11e6-9ad2-126645915ee5"
}
Have more questions? Submit a request