Video Object Indexed Properties for Search

The following table describes the current video object indexed properties that can be used to narrow your video search queries.

 

Index Name

Type

Description

Format

id

String

Search for a specific video using a known videoID.


Note: Video ID in this sense regards the video ID in the Vidible system.

id:VIDEO_ID

id:563bfde6e4b0da1a799f0f8b

bid

String

Search for a specific playlist using a known playlistID.


Note: Playlist ID in this sense regards the Playlist ID in the Vidible system.

bid: Playlist ID

bid:5835d5278526315b7e84e921

creationdate

String

search for videos using a defined date and time.


Note: Please see notes 1-3 at the bottom of the article.

creationdate:[YYYY-MM-DDThh:mm TO *]

creationdate:[2015-01-01 TO 2015-01-02]

creationdate:[2015-01-01T12:00 TO 2015-01-01T14:00]

creationdate:[2015-01-01T12:00 TO 2015-01-01T14:00+0200]

companyid

String

Search for videos that were uploaded to a specific company (either White Label or Affiliate), using a known Vidible Company ID.

companyId:COMPANY_ID

companyId:56425b83ff690a0a7c360416

company

String

Search for videos that were uploaded to a specific company by name.


Note: Please see note 4 at the bottom of the article.

company:COMPANY_NAME

company:Vidible

company:"My Company"

parentcompanyid

String

Search for videos that were uploaded to a specific White Label Company using a known Vidible Company ID.

parentCompanyId:PARENT_COMPANY_ID

parentCompanyId:56425b83ff690a0a7c360416

parentcompany

String

Search for videos that were uploaded to a specific company by name.


Note: Please see note 4 at the bottom of the article.

parentCompany:COMPANY_NAME

parentCompany:Vidible

parentCompany:Vidible:"My Company"



modificationdate

Date

Search for videos that were modified on a specified date or in a range between two dates.

Note: Please see notes 1-3 at the bottom of the article.

modificationdate:[YYYY-MM-DDThh:mm TO *]

modificationdate:[2015-01-01 TO 2015-01-02]

modificationdate:[2015-01-01T12:00 TO 2015-01-01T14:00]

modificationdate:[2015-01-01T12:00 TO 2015-01-01T14:00+0200]

modifierid

String

Search for videos that were modified by a specific user using a known User ID number.

modifierid:USER_ID

modifierid:5639e0e2e4b0a86f5ec699cc

tag

String

Search for videos that include a specific custom tag.


Note: Tags are custom entities that need to be created and assigned to videos in order to search by them.

 

Note: Please see note 4 at the bottom of the article.

tag:TAG_NAME

tag:news

companyRating

Integer

Search for video according to defined company rating index either 0 or 10.

Note: 0 is an entry level company while 10 is a standard partner.

companyRating:COMPANY_RATING_NUMBER

companyRating:0

companyRating:10

companyGroupId

String

Search for videos under any company that has the specified Company Group ID number.

companyGroupId:COMPANY_GROUP_ID

companyGroupId:55646b88e4b005d0e08d4149

companyGroupNames

String

Search for videos under any company that has the specified Company Group name.


Note: Please see note 4 at the bottom of the article.

companyGroupNames:COMPANY_GROUP_NAME

companyGroupNames:Vidible

companyGroupNames:”Vidible Network”

name

String

Search for videos that contain the specified words in their video titles.


Note: Please see note 4 at the bottom of the article.

name:TEXT

name:”how to”

name:batman

description

String

Search for videos that contain the specified words in their video descriptions. Double quotes are mandatory.


Note: Please see note 4 at the bottom of the article.

description:"TEXT"

description:"veterans day"

shortdescription

String

Search for videos that contain the specified words in their video short descriptions.


Note: Please see note 4 at the bottom of the article.

shortdescription:SHORT_DESCRIPTION

shortdescription:”A man walks into a bar”

category

String

Search for videos that include the specified category names.


Note: Please see note 4 at the bottom of the article.

category:CATEGORY_NAME

category:news

category:”sci fi”

publishdate

Date

Search for videos that were published on a specified date or in a range between two dates.

Note: Please see notes 1-3 at the bottom of the article.

publishdate:[YYYY-MM-DDThh:mm TO *]

publishdate:[2015-01-01 TO 2015-01-02]

publishdate:[2015-01-01T12:00 TO 2015-01-01T14:00]

publishdate:[2015-01-01T12:00 TO 2015-01-01T14:00+0200]

startDate

Date

Search for videos that are available for distribution form the specified date.

Note: Please see notes 1-3 at the bottom of the article.

startDate:AVAILABILITY_BEGIN_DATE

startDate:[2015-01-01 TO *]

startDate:[2015-01-01T12:00 TO *]

endDate

Date

Search for videos that are not available for distribution after the specified date.


Note: Please see notes 1-3 at the bottom of the article.

endDate:AVAILABILITY_END_DATE

endDate:[2015-01-01 TO *]

endDate:[2015-01-01T12:00 TO *]

author

String

Search for videos that include the specified author metadata attribute.


Note: Please see note 4 at the bottom of the article.

author:TEXT

author:charles

author:”charles dickens”

credit

String

Search for videos that include the specified credit metadata attribute.


Note: Please see note 4 at the bottom of the article.

credit:TEXT

credit:vidible.tv

credit:”John Doe”

keyword

String

Search for videos that include one or more keyword metadata attributes.


Note: Please see note 4 at the bottom of the article.

keyword:TEXT

keyword:TEXT,TEXT

keyword:cats,dogs,”funny cats”

rating

String

Search for videos that include one or more of the following rating conventions: Y, Y-7, G, PG, PG-14, MA, NC-17, NR, D, L, S, V, FV, AR.

rating:RATING_CONVENTION

rating:PG

rating:PG,PG-14

feedid

String

Search for videos that were uploaded using an MRSS feed using a known MRSS feed ID number.

feedId:MRSS_FEED_ID

feedId:560255bae4b05aa976cc8263

feed

String

Search for videos that were uploaded using an MRSS feed according to a  known MRSS feed name.


Note: Please see note 4 at the bottom of the article.

feed:FEED_NAME

feed:”My Feed”

feed:videofeeds

rssid

string

Search for videos according to a specific  RSS Video ID number.

rssid:RSS_VIDEO_ID

rssid:3d7cf098-a66e-4655-901a-8a623b0abd97

emotion

String

Search for videos that include a specified 'emotion' media metadata attribute attribute.


Note: Please see note 4 at the bottom of the article.

emotion:TEXT

emotion:happy

mediaTag

String

Search for videos that include a specified media metadata tag.


Note: This searches the video entity defined tags.


Note: Please see note 4 at the bottom of the article.

mediaTag:TEXT

mediaTag:transcript

condition

String

Search for videos that include a specified 'condition' media metadata attribute.


Note: Please see note 4 at the bottom of the article.

condition:TEXT

condition:healthy

specialties

String

Search for videos that include a specified 'specialties' media metadata attribute.


Note: Please see note 4 at the bottom of the article.

specialties:TEXT

specialties:DIY

contentRating.descriptor

String

Search for videos that were uploaded using an MRSS feed with a specified content rating descriptor according to the following options:

  • D - Suggestive language.
  • L - Coarse language.
  • S - Sexual content.
  • V - Violence.
  • FV - Fantasy violence.
  • AR - Age restricted.

contentRating.descriptor:DESCRIPTOR_CODE

contentRating.descriptor:D

contentRating.value

String

Search for videos that were uploaded using an MRSS feed with a specified content rating value according to the following options:

  • Y - For all children.
  • Y7 - Age 7 and above.
  • G - All ages.
  • PG - Age 10 and above.
  • PG14 - Age 14 and above.
  • MA - Age 17and above.
  • NC17 - Adults only.
  • NR - Not rated.
contentRating.value:DESCRIPTOR_VALUE

contentRating.value:G

gender

String

Search for videos that were uploaded using an MRSS feed with a specified target gender according to the following options:

  • Female
  • Male
  • All

 

gender:GENDER

gender:female

gender:male

gender:all

whiteList

String Search for videos whitelisted for specific geographical locations using three letter country codes.

Note: By default, 'geoBlackListMode' is set to 'false', meaning that only whitelisted videos will be displayed.

whiteList: COUNTRY_3_LETTER_CODE

whiteList: usa

whiteList: aus

geoBlackListMode

Boolean

Search for videos that are either Whitelisted or Blacklisted to specific geographical locations. By default 'geoBlackListMode' is set to 'false' meaning that the search will return videos that are Whitelisted.

  • False - search for whitelisted videos
  • True - search for blacklisted videos.

geoBlackListMode: false (default)

geoBlackListMode: true 

geoBlackList String

Search for videos blacklisted for specific geographical locations using three letter country codes.

Note: You must define 'geoBlackListMode' as 'true' to use this parameter.


Note: By default, 'geoBlackListMode' is set to 'false', meaning that only whitelisted videos will be displayed. 

geoBlackList:  COUNTRY_3_LETTER_CODE

geoBlackList: usa

geoBlackList: aus

minimumage

Integer

Search for videos that are appropriate for viewers above a specified age.

minimumage:AGE_NUMBER

minimumage:21

minimumage:14

maximumage

Integer

Search for videos that are appropriate for viewers below a specified age.

maximumage:AGE_NUMBER

maximumage:80

maximumage:50

ageRatings

String

Search for videos that were uploaded using an MRSS feed with a specified age rating according to the following options:

  • Kids.
  • Tweens.
  • Teens.
  • Adults.
  • Seniors.
  • None_specified.
ageRatings:AGE_RATING

ageRatings:kids

ageRatings:tweens && kids

length

Integer

Search for videos with specified playback duration time.

length:DURATION_SECONDS

length:30

length:45

language.name

String

Search for videos that are in a specified language using a language name.

language.name:LANGUAGE_NAME

language.name:english

language.name:japanese

language.code4letters

String

Search for videos that are in a specified language using a 4 letter language code.

language.code4letters:LANGUAGE _4_LETTER_CODE

language.code4letters:en-US

language.code

String

Search for videos that are in a specified language using a language code.

language.code:LANGUAGE_CODE

language.code:ja

lifecycle

String

Search for videos that have a specified content lifecycle value according to the following options:

  • Evergreen
  • FastBreaking
  • Live
lifecycle:LIFECYCLE_TYPE

lifecycle:evergreen

lifecycle:live

producer

String

Search for videos that include one or more 'producer' metadata attributes.


Note: Please see note 4 at the bottom of the article.

producer:TEXT

producer:”Jimmy Miller”

location

string

Search for videos that include one or more 'location' metadata attributes.

location:TEXT

location:England

location:England,USA

plays

Integer

Search for videos that were played back a specified number of times in the past 7 days.

plays:PLAYBACK_ITTERATIONS

plays:100

supportedPlayerTypes

String

Search for videos that were played using a specified player according to the following options:

  • O2
  • YAHOO
supportedPlayerTypes:PLAYER_TYPE

supportedPlayerTypes:O2

supportedPlayerTypes:YAHOO

hasSubtitles

Boolean

Search for videos that either include or exclude subtitles according to the following options:

  • True - Has subtitles.
  • False - Does not have subtitles.
hasSubtitles:TRUE_FALSE

hasSubtitles:true

hasSubtitles:false

isLocalizedVariant

Boolean

Search for videos that are either a translated version of an existing video or not.

isLocalizedVariant:TRUE_FALSE

isLocalizedVariant:true

isLocalizedVariant:false

minimumprice

Float

Search for videos that have a specified minimum price, based on the video’s assigned Seller rule.

minimumprice:PRICE_USD

minimumprice:1.2

suggestedprice

Float

Search for videos that have a specified suggested price, based on the video’s assigned Seller rule.

suggestedprice:PRICE_USD

suggestedprice:3.5

totalprice

Integer

Search for videos that have a specified total price, based on the video’s assigned Seller rule.

totalprice:PRICE_USD

totalprice:15

aolid

String

Search for videos according to a known AOL On Network Console video ID number.

aolid:AOL_VIDEO_ID

aolid:52145214

 

Note-1: The time definition is not mandatory for this type of search, you may use only the date syntax if you wish.

 

Note-2: The search timezone is autodetected by your browser’s local time. To adjust the timezone add a plus ‘+’ or minus ‘-’ symbol and 4 digit hour time difference value. For example: to add 2 hours to your local time zone, add the following to the end of your search query within the square brackets : [2015-01-01T12:00 TO 2015-01-01T14:00+0200]

 

Note-3: You can set your customized default timezone using the user settings page.


Note-4: If your text includes any white spaces, please enter your text between two double quotes.

Have more questions? Submit a request