Single Item Calls
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
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/byglobalid/:globalid
Path Parameters
the target Item Global ID
GET https://api.nexx.cloud/v3.1/:streamtype/byhash/:itemhash
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/byrefnr/:itemreference
Path Parameters
the target Item Reference
GET https://api.nexx.cloud/v3.1/:streamtype/byslug/:itemslug
Path Parameters
/byremotereference
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.
Path Parameters
the Item Reference of the remote Provider
Query Parameters
the 3Q nexx Code for this Provider
GET https://api.nexx.cloud/v3.1/:streamtype/bycodename/:codename
only available for Container Streamtypes
Path Parameters
the Codename of the Container
Default Item List Calls
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
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/latest
returns "all" Items, sorted by Creation Date (ignores the "order" Parameters).
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/picked
returns all "picked" Items (ignores the "order" Parameter).
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/evergreens
returns all "Evergreen" Items.
Path Parameters
the Media Streamtype (only supported on Video, Audio and Image)
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.
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/withawards
returns all Items, with have awards added to them.
Path Parameters
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".
Path Parameters
Query Parameters
[classicwithand, classicwithor, fulltext] defines the Way, the Query is executed. Fore more results, "classicwithor" is optimal. For a Lucene Search with Relevance, use "fulltext"
a comma seperated List of Attributes, to search within. If omitted, the Search will use all available Text Attributes.
skip Results with a Query Score lower than the given Value. Only usefull for querymode "fulltext".
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".
if set to 0 or omitted, the Call will implictily report this Query to the nexxOMIA Reporting System.
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.
Path Parameters
Query Parameters
[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).
the maximal Distance (in km, defaults to 10 km)
GET https://api.nexx.cloud/v3.1/:streamtype/random
Path Parameters
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.
Path Parameters
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.
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/byitemlist/:itemlist
Path Parameters
comma seperated Item IDs for this Streamtype
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.
Path Parameters
Query Parameters
[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.
/mostactiveexternal
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.
Path Parameters
Query Parameters
[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set.
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.
Path Parameters
/topitemsexternal
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.
Path Parameters
Reference Item List Calls
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.
/channeloverview
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.
Path 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.
Path Parameters
/recommendationsfor
GET https://api.nexx.cloud/v3.1/:streamtype/recommendationsfor/:itemid
This Call needs a Recommendation Provider configured for the calling Domain.
Path Parameters
the ID of the Media Item to get Recommendations for
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.
Path Parameters
the ID of the Media Item to compute similar Items for
/recommendationsforcontext
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.
Path Parameters
Query Parameters
the Title of the Context Structure
the Subtitle of the Context Structure
the Body of the Context Structure
the Language of the given Constuct (if omitted, the Domain default Language is expected)
GET https://api.nexx.cloud/v3.1/:streamtype/bytag/:tag
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/bytagid/:tagid
Path Parameters
the ID of the Tag to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byperson/:person
Path Parameters
the Name of the Person to query for
GET https://api.nexx.cloud/v3.1/:streamtype/bypersonid/:personid
Path Parameters
the ID of the Person to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byfile/:file
Path Parameters
the Name of the File to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byfileid/:fileid
Path Parameters
the ID of the File to query for
GET https://api.nexx.cloud/v3.1/:streamtype/bygroup/:group
Path Parameters
the Name of the Group to query for
GET https://api.nexx.cloud/v3.1/:streamtype/bygroupid/:groupid
Path Parameters
the ID of the Group to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byshow/:show
Path Parameters
the Name of the Show to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byshowid/:showid
Path Parameters
the ID of the Show to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byplace/:place
Path Parameters
the Name of the Place to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byplaceid/:placeid
Path Parameters
the ID of the Place to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byproduct/:product
Path Parameters
the Name of the Product to query for
GET https://api.nexx.cloud/v3.1/:streamtype/byproductid/:productid
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/bystudio/:studioid
only available for Videos, Playlists and Sereis
Path Parameters
the ID of the Studio to query for
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)
Path Parameters
the ID of the target Container
/connectedtoitem
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.
Path Parameters
User Item List Calls
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.
Path Parameters
the ID of the uploading User
GET https://api.nexx.cloud/v3.1/:streamtype/userhistory
Path Parameters
Query Parameters
if set to 1, only not fully completed Elements will be returned
/userfavourites
GET https://api.nexx.cloud/v3.1/:streamtype/userfavourites
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/userlikes
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/userratings
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/userreactions
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/usercomments
Path Parameters
GET https://api.nexx.cloud/v3.1/:streamtype/useruploads
Path Parameters
Item Detail List Calls
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.
/texttrackdatafor
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.
Path Parameters
the ID of the Media Item to get Captions for
Query Parameters
the desired language of the Caption Data
["subtitles", "captions", "forced"]
the role of the given Captions, defaults to "subtitles"
GET https://api.nexx.cloud/v3.1/:streamtype/commentsfor/:itemid
Path Parameters
the ID of the Media Item to get Captions for
GET https://api.nexx.cloud/v3.1/:streamtype/externalcommentsfor/:itemid
Path Parameters
the ID of the Media Item to get Captions for
/currentviewsfor
GET https://api.nexx.cloud/v3.1/:streamtype/currentviewsfor/:itemid
Path Parameters
the ID of the Media Item to get Realtime Views for
/stitchedmanifestfor
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".
Path Parameters
the ID of the Media Item to get Captions for
Streamtype specific Calls
GET https://api.nexx.cloud/v3.1/videos/bylivelink/:livelinkid
Path Parameters
the ID of the LiveLink, that the target Videos were recorded of
GET https://api.nexx.cloud/v3.1/videos/byvariant/:variantid
will return the Video Object, that represents the given Variant
Path Parameters
the ID of the Variant, that the returned Video represents
GET https://api.nexx.cloud/v3.1/videos/byrack/:rackid
Path Parameters
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.
Path Parameters
the ID of the Video, that is currently played
GET https://api.nexx.cloud/v3.1/live/byrack/:rackid
Path Parameters
GET https://api.nexx.cloud/v3.1/scenes/byvideo/:videoid
Path Parameters
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
Query Parameters
the Number of Days to compute Events for
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
