Usage

The Media API offers a variety of additional Parameters for querying Purposes.

General Parameters

Parameter	Values	Description
createdAfter	UNIX Timestamp	restrict Result to Elements, created after the given Time
modifiedAfter	UNIX Timestamp	restrict Result to Elements, modified after the given Time
publishedAfter	UNIX Timestamp	restrict Result to Elements, published after the given Time
channel	int	restrict Result Set to Items in this Channel
respectChannelHierarchy	[0, 1]	If the target Channel is a Main Channel, and the Contents of its Subchannels shall also be included, set this Parameter to 1.
format	int	restrict Result Set to Items in this Format
category	int	restrict Result Set to Items in this Category
genre	int	restrict Result Set to Items in this Genre (only for Video, Playlist, Series, Audio and Audio Album)
type	String	many Media Items have certain "Types" to define their Purpose. If necessary, you can filter by this Enum.
contentType	[video, comic, cgi] for videos or [foto, drawing, clipart] for images	many Media Items have a certain "contentType" that defines some Characteristics. If necessary, you can filter by this Enum.
country	2-Letter Code	restricts the Result to Media from the given Country
noExplicit	[0, 1]	restrict Result Set to Items with defined Age Level < 13 AND without Content Moderation Aspects
noContentModerationHints	[0, 1]	restrict Result Set to Items without Content Moderation Aspects
maxAge	[0, 6, 12 ,16 ,18]	restrict Result Set to Items with maximally the given Age Level
minAge	[0, 6, 12, 16, 18]	restrict Result Set to Items with at least the given Age Level
applyContentModerationFilters	[0, 1]	if set to 1, Covers and Texts may be returned slightly differend, depending on Domain Settings, ContentModeration Results and loggedin Users to hide potentially inappropriate Images/Texts (this is NOT related to the Media itself!)
dimension	[hd, fullhd, 2K, 4K]	restrict the Result to Media with the given Height (alternatively, this Parameter also accepts a numeric Value, which will be mapped to the Media Height)
orientation	[portrait, landscape]	restrict the Result to Media with the given Orientation
onlyHDR	[0, 1]	if set to 1, only Media in HDR Quality will be returned
excludeItems	comma seperated Item IDs	the given Items wont be included into the Result Set
includeUGC	[0, 1]	add Items, uploaded by the Community, to the Result Set
onlyUGC	[0, 1]	restrict Result Set to Items, uploaded by the Community
includeRemote	[0, 1]	also include Files, that originate not by nexxOMNIA, but a Partner Provider
onlyRemote	[0, 1]	only include Files, that originate not by nexxOMNIA, but a Partner Provider
includeNotListables	[0, 1]	also include Media Items, that are marked as "not listable". This Parameter should be used only in very specific Usecases.
includeInvalidChildMedia	[0, 1]	only valid for Container Calls with addChildMedia Parameter. This Parameter will add currently invalid Elements to the Child Listing. To make this Parameter work, an active eternal Session must be used.
includePremieres	[0, 1]	also include Media, that are not valid YET, but will be in the near Future and allow Premiere Functionality
onlyPay	[0, 1]	restrict Result Set to Items with Payment Attributes
onlyPremiumPay	[0, 1]	restrict Result Set to Items with Payment Attributes AND Premium Payment Attributes
onlyStandardPay	[0, 1]	restrict Result Set to Items with Payment Attributes AND Standard Payment Attributes
onlyPlanned	[0, 1]	only possible if addPublishingDetails is active. If set to 1, only planned Elements will be returned.
onlyInactive	[0, 1]	only possible, if addPublishingDetails is active. If set to 1, only unpublished Elements will be returned.
forUserID	int	restrict Result Set to Items, that matches the given User (only valid for User-targeting Calls, that shall not match the currently loggedin User)
autoFillResults	[random, latest, topitems, topitemsexternal, forkids, evergreens]	if the API Call wont find enough Items, fill the Result Set with the given Method to the given Limit
connectedMediaDetails	[full, default, ID, GID]	If the Output Modifier addConnectedMedia is used, this Parameter defines the Detail Level for each connected Item.
parentMediaDetails	[full, default, ID, GID]	If the Output Modifier addCParentMedia is used, this Parameter defines the Detail Level for each parent Item.
childMediaDetails	[full, default, ID, GID]	if the Output Modifier addChildMedia is used, this Parameter defines the Detail Level for each Child Item
referencingMediaDetails	[full, default, ID, GID]	If the Output Modifier addReferencingMedia is used, this Parameter defines the Detail Level for each referencing Item.

Output Modifiers

Parameter	Values	Description
addGeoDetails	[0, 1]	add Details of a connected Location with all Location Attributes to each Item
addInteractionOptions	[0, 1]	add Information about Social Interactions (canBeRated, canBeFavourite, canBeLike, canBeWatchlist etc) to each Item
addConnectedMedia	[persons, shows, places, files, products, links, videos, audio, event, poll, album, article, studio, trailerFor, bonusFor, replaceWith, replacementFor, alternative, alternativeFor, variants, variantOf, nextEpisode, birthdayOf]	add the connected Item Details to each Item. This Modifier take "all" to include all possible Items or any combination of the given Enums, comma-seperated.
addComments	[all, own]	add (the last 25) Comments to each Item. It set to "own", only the Comments of the currently loggedin User are returned.
addAnnotations	[0, 1]	add (the last 25) Annotations (i.e. Comments within nexxOMNIA) to each Item
addTextTracks	[data, auto, languages, vtt, srt, ttml, ebuttde]	return the TextTracks in the given Format ("languages" will return only a List of available Languages and "auto" will decide based on Media Duration, which Format is optimal)
addPaymentData	[0, 1]	add Information to the Payment State to each Item
addEmbedDetails	[0, 1]	add Embed Code, oEmbed Link and JSON-LD to each Item (if embeddable)
addStatusDetails	[0, 1]	add a list of allowance Rules to each Item
addParentMedia	[playlists, audioalbums, albums, magazines, folders, groups, bundles, collections, sets, racks, series, season]	add the parent Container Details to each Item. This Modifier take "all" to include all possible Items or any combination of the given Enums, comma-seperated.
addReferencingMedia	[videos, scenes, audio, articles, playlists, series, sets, collections, magazines, albums, events, persons, places, studios, files, folders, groups, links, shows, birthdayOf]	add the referencing Media Details to each Item. This Modifier take "all" to include all possible Items or any combination of the given Enums, comma-seperated.
addChildMedia	[videos, audio, images, files, articles, scenes, chapters, live, playlists, audioalbums, albums, collections, sets, racks]	add the Child Media Details to each Item. This Modifier take "all" to include all possible Items or any combination of the given Enums, comma-seperated.
addRestrictionDetails	[0, 1]	add an Object of active Restrictions to each Item.
addMultiLanguageData	[0, 1]	add an Object of available MultiLanguage Metadata to each Item.
addCustomAttributes	[0, 1]	add an Object of domain specific Custom Attributes to each Item.
addAwards	[0, 1]	add an Object of Awards, given to the current Media Item
addAuthorDetails	[0, 1]	add Details of the Author of an Item (only valid in UGC Media Items)
addExportDetails	[0, 1]	add a List of active Exports of the current Item
addPreviewLinks	[0, 1]	add a List of active PreviewLinks of the current Item
addDownloadLinks	[0, 1]	add a List of active DownloadLinks of the current Item
addBroadcastLinks	[0, 1]	add a List of active BroadcastLinks to the current Item
addFileURLs	[0, 1]	add a List of File Details of the current Item (for example - the URL to the Source Material). This Modifier only works with the eternal Session.
addStreamingURLs	[0, 1]	add a List of Streaming URLs of the current Item (only valid on streamable Streamtypes) This Modifier only works with the eternal Session.
addRenditionDetails	[0, 1]	add a List of all available Renditions of the current Item (only valid for transcodable Streamtypes)
addTranscodingDetails	[0, 1]	add a List of all available Transcoding Steps of the current Item (only valid for transcodable Streamtypes)
addFeatures	[0, 1]	add an Object of technical Features (Resolution, Filesize etc) to each Item
addInsights	[keyframes, structure, ocr, topics, keywords, brands, atmosphere, emotions, entities, faces]	add AI generated Analysis Metadata to each Item. This Modifier take "all" to include all possible Items or any combination of the given Enums, comma-seperated.
addFaceDetails	[0, 1]	add a List of detected Persons (via AI, based on Face Detection) to each Media Item
addPodcastDetails	[0, 1]	if the current Item is the Source for a Podcast, add the Podcast Details.

Streamtype specific Parameters

Video

Parameter	Values	Description
includeTrailers	[0, 1]	also include Trailers in the Result Set
onlyTrailers	[0, 1]	only include Trailers in the Result Set
includeBonus	[0, 1]	also include Bonus Material in the Result Set
onlyBonus	[0, 1]	only include Bonus Material in the Result Set
onlyForSessionLanguage	[0, 1]	don’t include Videos, that have a different Audio Language than the current Session Language
audioLanguage	2-Letter Code	restricts the Result to Media with an Audio Track of the given Language
includeEpisodes	[0, 1]	also include Episodes in the Result Set
onlyEpisodes	[0, 1]	only include Episodes in the Result Set
includeStoryParts	[0, 1]	also include Videos, that are Part of a Story, in the Result Set
onlyStoryParts	[0, 1]	only include Videos, that are Part of a Story, in the Result Set
includeRackParts	[0, 1]	also include Videos, that are Part of a Rack, in the Result Set
onlyRackParts	[0, 1]	only include Videos, that are Part of a Rack, in the Result Set
includeLiveRepresentations	[0, 1]	also include Videos, that are Representations of a LiveStream, in the Result Set
onlyLiveRepresentations	[0, 1]	only include Videos, that are Representations of a LiveStream, in the Result Set
onlyUnsecured	[0, 1]	only include Videos without DRM/AES Security
onlyPanorama	[0, 1]	only include Panorama Video
onlyWithSurroundSound	[0, 1]	only include Videos with Surround Sound
minDuration	int	only return Videos with the given minimal Duration (in Seconds)
maxDuration	int	only return Videos with the given maximal Duration (in Seconds)
onlyDownloadable	[0, 1]	only include Videos, that can be watched offline
addHotSpots	[0, 1]	add a List of all available HotSpots to each Item (also automatically created by Auto HotSpot Rules) (this Parameter is an Output Modifier)
addBumpers	[0, 1]	if the Call is a single Call, optionally expand the Item with appropriate Pre/Post Bumpers (so the Single Item Call will become a Item List Call) (this Parameter is an Output Modifier)

Scene

Parameter	Values	Description
includeRackParts	[0, 1]	also include Scenes, that are Part of a Rack, into the Result Rest
onlyRackParts	[0, 1]	only include Scenes, that are Part of a Rack, into the Result Set.
purpose	string	[opening, recap,chapter, credits] only include Scenes of the given Purpose

Live

Parameter	Values	Description
includeReLive	[0, 1]	if set to 1, the Result Set will also contain not-live LiveStreams, which have a ReLive Recording and can therefore still be played back.
includeRackParts	[0, 1]	also include LiveStreams, that are Part of a Rack, into the Result Rest
onlyRackParts	[0, 1]	only include Scenes, that are Part of a Rack, into the Result Rest
addIngestDetails	[0, 1]	add the Ingest URLs and Tokens for Publishing to the Live Event. This Modifier only works with the eternal Session. (this Parameter is an Output Modifier)

Rack

Parameter	Values	Description
purpose	string	[language, alternative] only include Racks of the given Purpose

Playlist

Parameter	Values	Description
includeSeasons	[0, 1]	also include Seasons in the Result Set
onlySeasons	[0, 1]	only include Seasons in the Result Set
includePodcastSources	[0, 1]	also include Playlists, that are Sources for Podcasts in the Result Set
onlyPodcastSources	[0, 1]	only include Playlists, that are Sources for Podcasts in the Result Set

Audio

Parameter	Values	Description
includeTrailers	[0, 1]	also include Trailers in the Result Set
onlyTrailers	[0, 1]	only include Trailers in the Result Set
includeBonus	[0, 1]	also include Bonus Material in the Result Set
onlyBonus	[0, 1]	only include Bonus Material in the Result Set
audioLanguage	2-Letter Code	restricts the Result to Media with an Audio Track of the given Language
includeEpisodes	[0, 1]	also include Episodes in the Result Set
onlyEpisodes	[0, 1]	only include Episodes in the Result Set
minDuration	int	only return Audio Files with the given minimal Duration (in Seconds)
maxDuration	int	only return Audio Files with the given maximal Duration (in Seconds)

AudioAlbum

Parameter	Values	Description
includePodcastSources	[0, 1]	also include Audio Albums, that are Sources for Podcasts in the Result Set
onlyPodcastSources	[0, 1]	only include Audio Albums, that are Sources for Podcasts in the Result Set

Image

Parameter	Values	Description
onlyPanorama	[0, 1]	only include Panorama Images
onlyAnimations	[0, 1]	only include animated Images
includeStoryParts	[0, 1]	also include Images, that are Part of a Story, in the Result Set
onlyStoryParts	[0, 1]	only include Images, that are Part of a Story, in the Result Set
onlyBW	[0, 1]	only include Black/White Images

Collection

Parameter	Values	Description
includeStories	[0, 1]	also include Collections, that serve as Story in the Result Set
onlyStories	[0, 1]	only include Collections, that serve as Story in the Result Set

Series

Parameter	Values	Description
addSeasonList	[0, 1]	add a list of Seasons (this is identical to addItemData, but skips the underlying Episode Lists) (this Parameter is an Output Modifier)
addEpisodesForSeason	int	add the Episode List of the given Season (referenced by Season Number (1-X), not Playlist ID. Optionally set to "latest" to automatically add the Episode List of just the latest Season (this Parameter is an Output Modifier)

File

Parameter	Values	Description
fileType	string	only include Files of the given Filetype (e.g. "pdf")

Link

Parameter	Values	Description
purpose	string	[link, reference] only include Links of the given Purpose

Studio

Parameter	Values	Description
forStreamtype	[video, audio]	only return Studios for the given Streamtype

Person

Parameter	Values	Description
addTaggedImages	[0, 1]	add a list of Images, where the current Item has been found on (and additionally a list of potential matches without manual confirmation) (this Parameter is an Output Modifier)
addTaggedVideos	[0, 1]	add a list of Videos, where the current Item has been found on (and additionally a list of potential matches without manual confirmation) (this Parameter is an Output Modifier)

Post

Parameter	Values	Description
platform	[facebook, instagram, twitter, linkedin, mastodon]	only include Posts, that were created on the given Platform
account	int	only include Posts, that were created within the given Account