Skip to main content
View as Markdown

Key Objects & Enums Quick Reference - Content Management

Key Objects & Enums Quick Reference​

  • Params: KalturaESearchEntryParams, KalturaESearchCategoryParams, KalturaESearchUserParams
  • Operator: KalturaESearchEntryOperator (and variants)
  • Items: KalturaESearchUnifiedItem, KalturaESearchEntryItem, KalturaESearchCaptionItem, KalturaESearchEntryMetadataItem, KalturaESearchCuePointItem
  • Response: KalturaESearchEntryResponse (and variants), KalturaESearchEntryResult (and variants), KalturaESearchHighlight, KalturaESearchItemDataResult, KalturaESearchAggregationResponse

Entry Field Names (KalturaESearchEntryFieldName)​

Use these values in the fieldName property of KalturaESearchEntryItem:

ValueDescription
idEntry ID
nameEntry display name
descriptionEntry description
tagsEntry tags
admin_tagsAdmin-only tags
reference_idExternal reference ID
creditCredit/attribution text
site_urlAssociated site URL
created_atCreation timestamp (use RANGE itemType)
updated_atLast update timestamp (use RANGE itemType)
last_played_atLast playback timestamp (use RANGE itemType)
start_dateScheduling start date
end_dateScheduling end date
media_typeMedia type (1=video, 2=image, 5=audio)
entry_typeEntry type (1=media, 7=live, etc.)
moderation_statusModeration status value
creator_kuser_idCreator user ID
kuser_idOwner user ID
playsTotal play count (use RANGE for numeric filtering)
votesVote count
display_in_searchSearch visibility (0=none, 1=partner, 2=network)
parent_idParent entry ID (for clips/children)
root_idRoot entry ID
captions_contentFull-text search within caption content
conversion_profile_idConversion profile ID
access_control_idAccess control profile ID
redirect_entry_idRedirect target entry ID
recorded_entry_idAssociated recording entry ID
template_entry_idTemplate entry ID
is_liveWhether entry is currently live
is_quizWhether entry is a quiz
entitled_kusers_editUsers entitled to edit
entitled_kusers_publishUsers entitled to publish
entitled_kusers_viewUsers entitled to view

Caption Field Names (KalturaESearchCaptionFieldName)​

Use these values in the fieldName property of KalturaESearchCaptionItem:

ValueDescription
contentCaption/transcript text content
caption_asset_idCaption asset ID
labelCaption label/display name
languageCaption language code
start_timeCaption line start time (use RANGE)
end_timeCaption line end time (use RANGE)

Order-By Field Names (KalturaESearchEntryOrderByFieldName)​

Use these values in the sortField property of KalturaESearchOrderByItem:

ValueDescription
created_atCreation date
updated_atLast update date
nameAlphabetical by name
playsTotal play count
plays_last_1_dayPlays in last 24 hours
plays_last_7_daysPlays in last 7 days
plays_last_30_daysPlays in last 30 days
viewsTotal view count
views_last_1_dayViews in last 24 hours
views_last_30_daysViews in last 30 days
rankRelevance/ranking score
start_dateScheduling start date
end_dateScheduling end date
last_played_atLast playback date