Media Data
Last updated
Last updated
These API Calls will return only one the referenced Item (if available and accessible with the calling Domain). The Result Set Format will be an Object.
GET https://api.nexx.cloud/v3.1/:streamtype/byid/:itemid
| Name | Type | Description |
|---|---|---|
GET https://api.nexx.cloud/v3.1/:streamtype/byglobalid/:globalid
| Name | Type | Description |
|---|---|---|
GET https://api.nexx.cloud/v3.1/:streamtype/byhash/:itemhash
GET https://api.nexx.cloud/v3.1/:streamtype/byrefnr/:itemreference
GET https://api.nexx.cloud/v3.1/:streamtype/byslug/:itemslug
GET https://api.nexx.cloud/v3.1/:streamtype/byremotereference/:remotereference
This Call queries for an Item, that is (possibly) not hosted by nexxOMNIA. The API will call the given Remote Provider for Media Details and implicitely create the Item for future References within nexxOMNIA.
GET https://api.nexx.cloud/v3.1/:streamtype/bycodename/:codename
only available for Container Streamtypes
These API Calls will return Lists of Items (if available and accessible with the calling Domain). The Result Set Format will be an Array of Objects.
GET https://api.nexx.cloud/v3.1/:streamtype/all
GET https://api.nexx.cloud/v3.1/:streamtype/latest
returns "all" Items, sorted by Creation Date (ignores the "order" Parameters).
GET https://api.nexx.cloud/v3.1/:streamtype/picked
returns all "picked" Items (ignores the "order" Parameter).
GET https://api.nexx.cloud/v3.1/:streamtype/evergreens
returns all "Evergreen" Items.
GET https://api.nexx.cloud/v3.1/:streamtype/forkids
returns all Items, marked as "created for Kids". This is NOT connected to any Age Restriction.
GET https://api.nexx.cloud/v3.1/:streamtype/withawards
returns all Items, with have awards added to them.
GET https://api.nexx.cloud/v3.1/:streamtype/byquery/:query
performs a regular Query on all Items. The "order" Parameters are ignored, if querymode is set to "fulltext".
GET https://api.nexx.cloud/v3.1/:streamtype/bygeo/:geoquery
performs a Geo Query on all Items. Only Items, that have a "Geo" Attribute can be found. The "order" Parameters will be ignored, as "distance" will be the sorting Attribute.
GET https://api.nexx.cloud/v3.1/:streamtype/topslider
this Endpoint is only available for Domains with nexxNEON Support and will return Media currently in TopSlider.
GET https://api.nexx.cloud/v3.1/:streamtype/random
GET https://api.nexx.cloud/v3.1/:streamtype/expiring
returns only Items, that have an Expiry Attribute (for the current Gateway). The "order" Parameter will be ignored, as the Expiry Date will be the order Criteria. The "addRestrictionDetails" Output Modifier is usefull to know more about the Expiry Date.
GET https://api.nexx.cloud/v3.1/:streamtype/comingsoon
returns only Items, that have a Start Date Attribute (for the current Gateway), but are active on all other Restrictions. The "addRestricionDetails" Output Modifier is usefull to know more about the Start Date.
Please notice, that this API Call will return Items, that are NOT visible or returned in any other Call.
GET https://api.nexx.cloud/v3.1/:streamtype/byitemlist/:itemlist
GET https://api.nexx.cloud/v3.1/:streamtype/mostactive
"mostactive" refers to the Number of "Views" of each Media Item. The "order" Parameters will be ignored.
GET https://api.nexx.cloud/v3.1/:streamtype/mostactiveexternal
"mostactive" refers to the Number of "Views" of each Media Item (on external Platforms). The "order" Parameters will be ignored.
GET https://api.nexx.cloud/v3.1/:streamtype/topitems
"topitems" refers to the Number of "Views" of each Media Item within the last Hour. The "order" Parameter will be ignored.
GET https://api.nexx.cloud/v3.1/:streamtype/topitemsexternal
"topitems" refers to the Number of "Views" of each Media Item in the last Hour (on external Platforms). The "order" Parameter will be ignored.
These API Calls will return Lists of Items (if available and accessible with the calling Domain). The Result Set Format will be an Array of Objects.
GET https://api.nexx.cloud/v3.1/:streamtype/channeloverview
will return an Array of Channels and the latest Media Items under each Channel. (if the "channel" Parameter is given, the Array will reflect the Subchannels of this Channel). Ignores the "order" and "respectChannelHierachy" Parameters.
GET https://api.nexx.cloud/v3.1/:streamtype/formatoverview
will return an Array of Formats and the latest Media Items under each Format. Ignores the "order" Parameters.
GET https://api.nexx.cloud/v3.1/:streamtype/recommendationsfor/:itemid
This Call needs a Recommendation Provider configured for the calling Domain.
GET https://api.nexx.cloud/v3.1/:streamtype/similarsfor/:itemid
This Call will return Items, that are similar to the given Media Item. This is close to a Recommendation, but does not include any other Information than the Metadata into the Result Set.
GET https://api.nexx.cloud/v3.1/:streamtype/recommendationsforcontext/:context
This Call will try to compute matching Items for a given "context". Context is a (long) String, that may be an Article Text or similar Structure. The context may also be given via the other Query Parameters given below. This Call can also be sent via POST (due to the possible long Amount of Text). The calling Domain needs an active AI License.
GET https://api.nexx.cloud/v3.1/:streamtype/bytag/:tag
GET https://api.nexx.cloud/v3.1/:streamtype/bytagid/:tagid
GET https://api.nexx.cloud/v3.1/:streamtype/byperson/:person
GET https://api.nexx.cloud/v3.1/:streamtype/bypersonid/:personid
GET https://api.nexx.cloud/v3.1/:streamtype/byfile/:file
GET https://api.nexx.cloud/v3.1/:streamtype/byfileid/:fileid
GET https://api.nexx.cloud/v3.1/:streamtype/bygroup/:group
GET https://api.nexx.cloud/v3.1/:streamtype/bygroupid/:groupid
GET https://api.nexx.cloud/v3.1/:streamtype/byshow/:show
GET https://api.nexx.cloud/v3.1/:streamtype/byshowid/:showid
GET https://api.nexx.cloud/v3.1/:streamtype/byplace/:place
GET https://api.nexx.cloud/v3.1/:streamtype/byplaceid/:placeid
GET https://api.nexx.cloud/v3.1/:streamtype/byproduct/:product
GET https://api.nexx.cloud/v3.1/:streamtype/byproductid/:productid
GET https://api.nexx.cloud/v3.1/:streamtype/bystudio/:studioid
only available for Videos, Playlists and Sereis
GET https://api.nexx.cloud/v3.1/:streamtype/by:container/:containerid
This Call is available for all Streamtypes, that support Containers (i.e., parent Elements). An Example would be - /videos/byplaylist (as the Container for the Streamtype Video is Container)
GET https://api.nexx.cloud/v3.1/:streamtype/connectedtoitem
This Call is available for all Streamtypes, that can be linked to other Streamtypes. Typically, this would mean [persons, shows, places, links, files, products]. It will return all Items of the current Streamtype, that are linked to the referenced Media Item.
These API Calls will return Lists of Items (if available and accessible with the calling Domain). The Result Set Format will be an Array of Objects.
GET https://api.nexx.cloud/v3.1/:streamtype/byuser/:userid
returns only Items, uploaded by the given User ID. Ignores the "onlyUGC" and "includeUGC" Parameters, as only UGC Elements will be returned by default.
GET https://api.nexx.cloud/v3.1/:streamtype/userhistory
GET https://api.nexx.cloud/v3.1/:streamtype/userfavourites
GET https://api.nexx.cloud/v3.1/:streamtype/userlikes
GET https://api.nexx.cloud/v3.1/:streamtype/userratings
GET https://api.nexx.cloud/v3.1/:streamtype/userreactions
GET https://api.nexx.cloud/v3.1/:streamtype/usercomments
GET https://api.nexx.cloud/v3.1/:streamtype/useruploads
These API Calls will return Lists of Details for a given Media Item (if available and accessible with the calling Domain). The Result Set Format will be an Array of Objects.
GET https://api.nexx.cloud/v3.1/:streamtype/texttrackdatafor/:itemid
This Call will return Captions for the given Media Item. Captions are only supported on Videos and Audio.
GET https://api.nexx.cloud/v3.1/:streamtype/commentsfor/:itemid
GET https://api.nexx.cloud/v3.1/:streamtype/externalcommentsfor/:itemid
GET https://api.nexx.cloud/v3.1/:streamtype/currentviewsfor/:itemid
GET https://api.nexx.cloud/v3.1/:streamtype/stitchedmanifestfor/:itemid
This Endpoint is only available for the Streamtypes "playlist", "collection" and "set". Furthermore, the calling Domain must have enabled "Stitching Service".
GET https://api.nexx.cloud/v3.1/videos/bylivelink/:livelinkid
GET https://api.nexx.cloud/v3.1/videos/byvariant/:variantid
will return the Video Object, that represents the given Variant
GET https://api.nexx.cloud/v3.1/videos/byrack/:rackid
GET https://api.nexx.cloud/v3.1/videos/nextinseries/:videoid
If a Video is an Episode of a Series, the Call will return the next Episode to watch. This Call is a Single Item Call, and the Result Set will be identical to a Video Call.
GET https://api.nexx.cloud/v3.1/live/byrack/:rackid
GET https://api.nexx.cloud/v3.1/scenes/byvideo/:videoid
GET https://api.nexx.cloud/v3.1/events/today
will return Events, that occur on the current Day
GET https://api.nexx.cloud/v3.1/events/thisweek
will return Events, that occur on the current Week
GET https://api.nexx.cloud/v3.1/events/thismonth
will return Events, that occur on the current Month
GET https://api.nexx.cloud/v3.1/events/nextdays
will return Events, that occur within the next given Days
GET https://api.nexx.cloud/v3.1/polls/latestopen
will return the latest open Poll, if any
GET https://api.nexx.cloud/v3.1/polls/latestopen
will return the latest open Poll, if any
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
streamtype
string
the Media Streamtype
itemid
integer
the target Item ID
streamtype*
string
the Media Streamtype
globalid*
integer
the target Item Global ID
streamtype
string
the Media Streamtype
itemhash
string
the target Item Hash
streamtype
string
the Media Streamtype
itemreference
string
the target Item Reference
streamtype
string
the Media Streamtype
itemslug
string
the target Item Slug
streamtype
string
the Media Streamtype
remotereference
integer
the Item Reference of the remote Provider
provider
string
the 3Q nexx Code for this Provider
streamtype
string
the Media Streamtype
codename
string
the Codename of the Container
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype (only supported on Video, Audio and Image)
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
query
string
the Search Term
queryMode
string
[classicwithand, classicwithor, fulltext] defines the Way, the Query is executed. Fore more results, "classicwithor" is optimal. For a Lucene Search with Relevance, use "fulltext"
queryFields
string
a comma seperated List of Attributes, to search within. If omitted, the Search will use all available Text Attributes.
minimalQueryScore
integer
skip Results with a Query Score lower than the given Value. Only usefull for querymode "fulltext".
includeSubstringMatches
boolean
By default, the Query will only return Results on full Words. If also Substring Matches shall be returned, set this Parameter to 1. Only usefull, if querymode is not "fulltext".
skipReporting
boolean
if set to 0 or omitted, the Call will implictily report this Query to the nexxOMIA Reporting System.
streamtype
string
the Media Streamtype
geoquery
string
the Geo Query Reference
geoMode
string
[geo, place, zipcode] defines the given geoquery Term.. If a Geo Location (Lat, Lng) is available, use "geo", if only a Zipcode is available, use "zipcode", in all other Cases, "place" is the best Mode (and the default).
distance
integer
the maximal Distance (in km, defaults to 10 km)
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
itemlist
string
comma seperated Item IDs for this Streamtype
streamtype
string
the Media Streamtype
timeframe
integer
[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.
streamtype
string
the Media Streamtype
timeframe
integer
[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Recommendations for
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to compute similar Items for
streamtype
string
the Media Streamtype
context
string
the Tag to query for
title
string
the Title of the Context Structure
subtitle
string
the Subtitle of the Context Structure
content
string
the Body of the Context Structure
language
string
the Language of the given Constuct (if omitted, the Domain default Language is expected)
streamtype
string
the Media Streamtype
tag
string
the Tag to query for
streamtype
string
the Media Streamtype
tagid
integer
the ID of the Tag to query for
streamtype
string
the Media Streamtype
person
string
the Name of the Person to query for
streamtype
string
the Media Streamtype
personid
integer
the ID of the Person to query for
streamtype
string
the Media Streamtype
file
string
the Name of the File to query for
streamtype
string
the Media Streamtype
fileid
integer
the ID of the File to query for
streamtype
string
the Media Streamtype
group
string
the Name of the Group to query for
streamtype
string
the Media Streamtype
groupid
integer
the ID of the Group to query for
streamtype
string
the Media Streamtype
show
string
the Name of the Show to query for
streamtype
string
the Media Streamtype
showid
number
the ID of the Show to query for
streamtype
string
the Media Streamtype
place
string
the Name of the Place to query for
placeid
number
the ID of the Place to query for
streamtype
string
the Media Streamtype
product
string
the Name of the Product to query for
string
streamtype
string
the Media Streamtype
studioid
number
the ID of the Studio to query for
streamtype
string
the Media Streamtype
container
string
the Container Streamtype
containerid
integer
the ID of the target Container
item
number
the Media ID
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
userid
integer
the ID of the uploading User
streamtype
string
the Media Streamtype
excludeCompleted
boolean
if set to 1, only not fully completed Elements will be returned
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Stream
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Captions for
language
string
the desired language of the Caption Data
role
["subtitles", "captions", "forced"]
the role of the given Captions, defaults to "subtitles"
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Captions for
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Captions for
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Realtime Views for
streamtype
string
the Media Streamtype
itemid
integer
the ID of the Media Item to get Captions for
livelinkid*
integer
the ID of the LiveLink, that the target Videos were recorded of
variantid*
integer
the ID of the Variant, that the returned Video represents
livelinkid*
integer
the ID of a valid Rack
videoid*
integer
the ID of the Video, that is currently played
rackd*
integer
the ID of a valid Rack
videoid*
integer
the ID of a valid Video
days
integer
the Number of Days to compute Events for