# Media Data

## 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.

## /byid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byid/:itemid`

#### Path Parameters

| Name       | Type    | Description          |
| ---------- | ------- | -------------------- |
| streamtype | string  | the Media Streamtype |
| itemid     | integer | the target Item ID   |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /byglobalid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byglobalid/:globalid`

#### Path Parameters

| Name                                         | Type    | Description               |
| -------------------------------------------- | ------- | ------------------------- |
| streamtype<mark style="color:red;">\*</mark> | string  | the Media Streamtype      |
| globalid<mark style="color:red;">\*</mark>   | integer | the target Item Global ID |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /byhash

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byhash/:itemhash`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |
| itemhash   | string | the target Item Hash |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /byreference

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byrefnr/:itemreference`

#### Path Parameters

| Name          | Type   | Description               |
| ------------- | ------ | ------------------------- |
| streamtype    | string | the Media Streamtype      |
| itemreference | string | the target Item Reference |

{% tabs %}
{% tab title="200 " %}

```
Item found    
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /byslug

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byslug/:itemslug`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |
| itemslug   | string | the target Item Slug |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /byremotereference

<mark style="color:blue;">`GET`</mark> `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

| Name            | Type    | Description                               |
| --------------- | ------- | ----------------------------------------- |
| streamtype      | string  | the Media Streamtype                      |
| remotereference | integer | the Item Reference of the remote Provider |

#### Query Parameters

| Name     | Type   | Description                        |
| -------- | ------ | ---------------------------------- |
| provider | string | the 3Q nexx Code for this Provider |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /bycodename

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bycodename/:codename`

only available for Container Streamtypes

#### Path Parameters

| Name       | Type   | Description                   |
| ---------- | ------ | ----------------------------- |
| streamtype | string | the Media Streamtype          |
| codename   | string | the Codename of the Container |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## 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.

## /all

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/all`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /latest

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/latest`

returns "**all**" Items, sorted by Creation Date (ignores the "**order**" Parameters).

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /picked

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/picked`

returns all "**picked**" Items (ignores the "**order**" Parameter).

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /evergreens

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/evergreens`

returns all "**Evergreen**" Items.

#### Path Parameters

| Name       | Type   | Description                                                     |
| ---------- | ------ | --------------------------------------------------------------- |
| streamtype | string | the Media Streamtype (only supported on Video, Audio and Image) |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /forkids

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /withawards

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/withawards`

returns all Items, with have awards added to them.

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byquery

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |
| query      | string | the Search Term      |

#### Query Parameters

| Name                    | Type    | Description                                                                                                                                                                              |
| ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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.                                                                                     |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /bygeo

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description             |
| ---------- | ------ | ----------------------- |
| streamtype | string | the Media Streamtype    |
| geoquery   | string | the Geo Query Reference |

#### Query Parameters

| Name     | Type    | Description                                                                                                                                                                                                                               |
| -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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)                                                                                                                                                                                           |

## /random

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/random`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /expiring

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /comingsoon

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Please notice, that this API Call will return Items, that are NOT visible or returned in any other Call.
{% endhint %}

## /byitemlist

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byitemlist/:itemlist`

#### Path Parameters

| Name       | Type   | Description                                  |
| ---------- | ------ | -------------------------------------------- |
| streamtype | string | the Media Streamtype                         |
| itemlist   | string | comma seperated Item IDs for this Streamtype |

{% tabs %}
{% tab title="200 " %}

```
Item found
```

{% endtab %}

{% tab title="404 " %}

```
Item not available
```

{% endtab %}
{% endtabs %}

## /mostactive

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

#### Query Parameters

| Name      | Type    | Description                                                                                     |
| --------- | ------- | ----------------------------------------------------------------------------------------------- |
| timeframe | integer | \[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set. |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /mostactiveexternal

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

#### Query Parameters

| Name      | Type    | Description                                                                                     |
| --------- | ------- | ----------------------------------------------------------------------------------------------- |
| timeframe | integer | \[1, 5, 10, 30] the Amount of Days, that will be included in the Computation of the Result Set. |

## /topitems

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /topitemsexternal

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## 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

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /formatoverview

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /recommendationsfor

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/recommendationsfor/:itemid`

This Call needs a Recommendation Provider configured for the calling Domain.

#### Path Parameters

| Name       | Type    | Description                                         |
| ---------- | ------- | --------------------------------------------------- |
| streamtype | string  | the Media Streamtype                                |
| itemid     | integer | the ID of the Media Item to get Recommendations for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /similarsfor

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type    | Description                                           |
| ---------- | ------- | ----------------------------------------------------- |
| streamtype | string  | the Media Streamtype                                  |
| itemid     | integer | the ID of the Media Item to compute similar Items for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /recommendationsforcontext

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |
| context    | string | the Tag to query for |

#### Query Parameters

| Name     | Type   | Description                                                                              |
| -------- | ------ | ---------------------------------------------------------------------------------------- |
| 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) |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bytag

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bytag/:tag`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |
| tag        | string | the Tag to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bytagid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bytagid/:tagid`

#### Path Parameters

| Name       | Type    | Description                    |
| ---------- | ------- | ------------------------------ |
| streamtype | string  | the Media Streamtype           |
| tagid      | integer | the ID of the Tag to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byperson

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byperson/:person`

#### Path Parameters

| Name       | Type   | Description                         |
| ---------- | ------ | ----------------------------------- |
| streamtype | string | the Media Streamtype                |
| person     | string | the Name of the Person to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bypersonid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bypersonid/:personid`

#### Path Parameters

| Name       | Type    | Description                       |
| ---------- | ------- | --------------------------------- |
| streamtype | string  | the Media Streamtype              |
| personid   | integer | the ID of the Person to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byfile

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byfile/:file`

#### Path Parameters

| Name       | Type   | Description                       |
| ---------- | ------ | --------------------------------- |
| streamtype | string | the Media Streamtype              |
| file       | string | the Name of the File to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byfileid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byfileid/:fileid`

#### Path Parameters

| Name       | Type    | Description                     |
| ---------- | ------- | ------------------------------- |
| streamtype | string  | the Media Streamtype            |
| fileid     | integer | the ID of the File to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bygroup

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bygroup/:group`

#### Path Parameters

| Name       | Type   | Description                        |
| ---------- | ------ | ---------------------------------- |
| streamtype | string | the Media Streamtype               |
| group      | string | the Name of the Group to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bygroupid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bygroupid/:groupid`

#### Path Parameters

| Name       | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| streamtype | string  | the Media Streamtype             |
| groupid    | integer | the ID of the Group to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byshow

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byshow/:show`

#### Path Parameters

| Name       | Type   | Description                       |
| ---------- | ------ | --------------------------------- |
| streamtype | string | the Media Streamtype              |
| show       | string | the Name of the Show to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byshowid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byshowid/:showid`

#### Path Parameters

| Name       | Type   | Description                     |
| ---------- | ------ | ------------------------------- |
| streamtype | string | the Media Streamtype            |
| showid     | number | the ID of the Show to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byplace

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byplace/:place`

#### Path Parameters

| Name       | Type   | Description                        |
| ---------- | ------ | ---------------------------------- |
| streamtype | string | the Media Streamtype               |
| place      | string | the Name of the Place to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byplaceid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byplaceid/:placeid`

#### Path Parameters

| Name    | Type   | Description                      |
| ------- | ------ | -------------------------------- |
| placeid | number | the ID of the Place to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byproduct

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byproduct/:product`

#### Path Parameters

| Name       | Type   | Description                          |
| ---------- | ------ | ------------------------------------ |
| streamtype | string | the Media Streamtype                 |
| product    | string | the Name of the Product to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byproductid

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/byproductid/:productid`

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
|      | string |             |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /bystudio

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/bystudio/:studioid`

only available for Videos, Playlists and Sereis

#### Path Parameters

| Name       | Type   | Description                       |
| ---------- | ------ | --------------------------------- |
| streamtype | string | the Media Streamtype              |
| studioid   | number | the ID of the Studio to query for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /by:container

<mark style="color:blue;">`GET`</mark> `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

| Name        | Type    | Description                    |
| ----------- | ------- | ------------------------------ |
| streamtype  | string  | the Media Streamtype           |
| container   | string  | the Container Streamtype       |
| containerid | integer | the ID of the target Container |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /connectedtoitem

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| item       | number | the Media ID         |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## 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.

## /byuser

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type    | Description                  |
| ---------- | ------- | ---------------------------- |
| streamtype | string  | the Media Streamtype         |
| userid     | integer | the ID of the uploading User |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /userhistory

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/userhistory`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

#### Query Parameters

| Name             | Type    | Description                                                     |
| ---------------- | ------- | --------------------------------------------------------------- |
| excludeCompleted | boolean | if set to 1, only not fully completed Elements will be returned |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /userfavourites

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/userfavourites`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /userlikes

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/userlikes`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /userratings

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/userratings`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /userreactions

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/userreactions`

#### Path Parameters

| Name       | Type   | Description      |
| ---------- | ------ | ---------------- |
| streamtype | string | the Media Stream |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /usercomments

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/usercomments`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /useruploads

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/useruploads`

#### Path Parameters

| Name       | Type   | Description          |
| ---------- | ------ | -------------------- |
| streamtype | string | the Media Streamtype |

{% tabs %}
{% tab title="200 " %}

```
I
```

{% endtab %}
{% endtabs %}

## 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

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type    | Description                                  |
| ---------- | ------- | -------------------------------------------- |
| streamtype | string  | the Media Streamtype                         |
| itemid     | integer | the ID of the Media Item to get Captions for |

#### Query Parameters

| Name     | Type                                 | Description                                             |
| -------- | ------------------------------------ | ------------------------------------------------------- |
| language | string                               | the desired language of the Caption Data                |
| role     | \["subtitles", "captions", "forced"] | the role of the given Captions, defaults to "subtitles" |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /commentsfor

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/commentsfor/:itemid`

#### Path Parameters

| Name       | Type    | Description                                  |
| ---------- | ------- | -------------------------------------------- |
| streamtype | string  | the Media Streamtype                         |
| itemid     | integer | the ID of the Media Item to get Captions for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /externalcommentsfor

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/externalcommentsfor/:itemid`

#### Path Parameters

| Name       | Type    | Description                                  |
| ---------- | ------- | -------------------------------------------- |
| streamtype | string  | the Media Streamtype                         |
| itemid     | integer | the ID of the Media Item to get Captions for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /currentviewsfor

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/:streamtype/currentviewsfor/:itemid`

#### Path Parameters

| Name       | Type    | Description                                        |
| ---------- | ------- | -------------------------------------------------- |
| streamtype | string  | the Media Streamtype                               |
| itemid     | integer | the ID of the Media Item to get Realtime Views for |

{% tabs %}
{% tab title="200 " %}

{% endtab %}
{% endtabs %}

## /stitchedmanifestfor

<mark style="color:blue;">`GET`</mark> `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

| Name       | Type    | Description                                  |
| ---------- | ------- | -------------------------------------------- |
| streamtype | string  | the Media Streamtype                         |
| itemid     | integer | the ID of the Media Item to get Captions for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

##

## Streamtype specific Calls

### Video

## /bylivelink

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/videos/bylivelink/:livelinkid`

#### Path Parameters

| Name                                         | Type    | Description                                                     |
| -------------------------------------------- | ------- | --------------------------------------------------------------- |
| livelinkid<mark style="color:red;">\*</mark> | integer | the ID of the LiveLink, that the target Videos were recorded of |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byvariant

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/videos/byvariant/:variantid`

will return the Video Object, that represents the given Variant

#### Path Parameters

| Name                                        | Type    | Description                                               |
| ------------------------------------------- | ------- | --------------------------------------------------------- |
| variantid<mark style="color:red;">\*</mark> | integer | the ID of the Variant, that the returned Video represents |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /byrack

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/videos/byrack/:rackid`

#### Path Parameters

| Name                                         | Type    | Description            |
| -------------------------------------------- | ------- | ---------------------- |
| livelinkid<mark style="color:red;">\*</mark> | integer | the ID of a valid Rack |

{% tabs %}
{% tab title="200 " %}

{% endtab %}
{% endtabs %}

## /nextinseries

<mark style="color:blue;">`GET`</mark> `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

| Name                                      | Type    | Description                                   |
| ----------------------------------------- | ------- | --------------------------------------------- |
| videoid<mark style="color:red;">\*</mark> | integer | the ID of the Video, that is currently played |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

### Live

## /byrack

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/live/byrack/:rackid`

#### Path Parameters

| Name                                    | Type    | Description            |
| --------------------------------------- | ------- | ---------------------- |
| rackd<mark style="color:red;">\*</mark> | integer | the ID of a valid Rack |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

### Scene

## /byvideo

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/scenes/byvideo/:videoid`

#### Path Parameters

| Name                                      | Type    | Description             |
| ----------------------------------------- | ------- | ----------------------- |
| videoid<mark style="color:red;">\*</mark> | integer | the ID of a valid Video |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

###

### Event

## /today

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/events/today`

will return Events, that occur on the current Day

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /thisweek

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/events/thisweek`

will return Events, that occur on the current Week

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /thismonth

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/events/thismonth`

will return Events, that occur on the current Month

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## /nextdays

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/events/nextdays`

will return Events, that occur within the next given Days

#### Query Parameters

| Name | Type    | Description                              |
| ---- | ------- | ---------------------------------------- |
| days | integer | the Number of Days to compute Events for |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

### Polls

## /latestopen

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/polls/latestopen`

will return the latest open Poll, if any

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

### Votings

## /latestopen

<mark style="color:blue;">`GET`</mark> `https://api.nexx.cloud/v3.1/polls/latestopen`

will return the latest open Poll, if any

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}