Tradecast Video API
If you have any technical questions or ideas about integrating Tradecast
video technology into your website or project,
we’d love to hear from you!
Contact us to explore the possibilities—together, we can achieve endless
potential.
Partner with Us
Become a partner and watch your company thrive with Tradecast Video
technology!
Our partner program is
designed to help your business grow.
Let’s work together and unlock new possibilities.
Join Our Team
If you’re passionate about being part of a team that’s shaping the
future of innovative streaming video technology,
we’d love to hear from you!
Visit our vacancies page to
explore current opportunities.
We look forward to teaming up with you.
Tradecast API Reference
This documentation acts as your guide to accessing and leveraging the power of the Tradecast platform through our GraphQL API.
With this API, you can seamlessly interact with the user-facing aspects of Tradecast, enabling a wide range of functionalities. Both data retrieval and manipulation are designed around the flexibility and efficiency of GraphQL.
Terms of Service
API Endpoints
# Production:
https://api.tradecast.eu/graphql
Headers
# Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE>
# Your channel id
channelid: <YOUR_CHANNEL_ID>Version
77.73.2
Queries
category
Description
🔐 You must have the following permissions to query this field:
- category: read
Example
Query
query Category($id: Int) {
category(id: $id) {
id
title
showMainMenu
slug
automatedTrading
description
thumbnail
parent {
id
title
showMainMenu
slug
automatedTrading
description
thumbnail
parent {
...CategoryFragment
}
children {
...CategoryFragment
}
mediaList {
...MediaListFragment
}
vlogList {
...VlogListFragment
}
}
children {
id
title
showMainMenu
slug
automatedTrading
description
thumbnail
parent {
...CategoryFragment
}
children {
...CategoryFragment
}
mediaList {
...MediaListFragment
}
vlogList {
...VlogListFragment
}
}
mediaList {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
vlogList {
results {
...VlogListItemFragment
}
limit
page
pageCount
resultCount
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"category": {
"id": 123,
"title": "abc123",
"showMainMenu": true,
"slug": "abc123",
"automatedTrading": "inherit",
"description": "xyz789",
"thumbnail": "abc123",
"parent": Category,
"children": [Category],
"mediaList": MediaList,
"vlogList": VlogList
}
}
}
categoryList
Response
Returns a
CategoryList
Arguments
| Name | Description |
|---|---|
filter -
CategoryFilter | |
sort -
CategorySort | |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
parentID
-
Int |
Example
Query
query CategoryList(
$filter: CategoryFilter,
$sort: CategorySort,
$limit: Int,
$page: Int,
$parentID: Int
) {
categoryList(
filter: $filter,
sort: $sort,
limit: $limit,
page: $page,
parentID: $parentID
) {
results {
id
title
showMainMenu
slug
automatedTrading
description
thumbnail
parent {
...CategoryFragment
}
children {
...CategoryFragment
}
mediaList {
...MediaListFragment
}
vlogList {
...VlogListFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": CategoryFilter,
"sort": CategorySort,
"limit": 50,
"page": 1,
"parentID": 123
}
Response
{
"data": {
"categoryList": {
"results": [Category],
"limit": 123,
"page": 987,
"pageCount": 123,
"resultCount": 123
}
}
}
contentPageList
Description
Gets all content pages.
🔐 You must have the following permissions to query this field:
- contentPage: read
The channel must have the contentPages feature enabled to query this field.
Response
Returns
[ContentPageType]
Arguments
| Name | Description |
|---|---|
device -
DeviceEnum | |
permissions
-
ContentPermissionsEnum | |
urlPath
-
String | |
type -
ContentPageEnum |
Example
Query
query ContentPageList(
$device: DeviceEnum,
$permissions: ContentPermissionsEnum,
$urlPath: String,
$type: ContentPageEnum
) {
contentPageList(
device: $device,
permissions: $permissions,
urlPath: $urlPath,
type: $type
) {
id
title
body
device
displayLoggedin
urlPath
publishStart
showMainMenu
type
}
}
Variables
{
"device": "standard",
"permissions": "all",
"urlPath": "xyz789",
"type": "standard"
}
Response
{
"data": {
"contentPageList": [
{
"id": 123,
"title": "abc123",
"body": "xyz789",
"device": "standard",
"displayLoggedin": "all",
"urlPath": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"showMainMenu": true,
"type": "standard"
}
]
}
}
contract
Description
The contract of the given ID when the contract belongs to the authenticated user
🔐 You must have the following permissions to query this field:
- contract: read
Example
Query
query Contract($id: Int) {
contract(id: $id) {
id
status
plan {
id
product {
...ProductFragment
}
title
description
currency
price
termsOfUse
renewable
type
interval
intervalValue
trialInterval
trialIntervalValue
trialMode
trialPrice
status
createdAt
updatedAt
protectedReason
usages
maxUsages
soldOut
}
currency
priceInCents
priceInCentsIncludingTax
taxRate
originalPriceInCents
isTrial
startDate
endDate
interval
intervalValue
billingInterval
appliedDiscount {
discountCode {
...DiscountCodeFragment
}
appliedDiscountInCents
currency
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"contract": {
"id": 987,
"status": "active",
"plan": Plan,
"currency": "USD",
"priceInCents": 987,
"priceInCentsIncludingTax": 123,
"taxRate": 987,
"originalPriceInCents": 987,
"isTrial": false,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"interval": "day",
"intervalValue": 987,
"billingInterval": "day",
"appliedDiscount": AppliedDiscount
}
}
}
contractList
Description
Returns the list of the authenticated user's contracts
Response
Returns a
ContractList
Arguments
| Name | Description |
|---|---|
filter -
ContractFilter | |
sort -
ContractSort | |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
_locale
-
String |
Example
Query
query ContractList(
$filter: ContractFilter,
$sort: ContractSort,
$limit: Int,
$page: Int,
$_locale: String
) {
contractList(
filter: $filter,
sort: $sort,
limit: $limit,
page: $page,
_locale: $_locale
) {
results {
id
status
plan {
...PlanFragment
}
currency
priceInCents
priceInCentsIncludingTax
taxRate
originalPriceInCents
isTrial
startDate
endDate
interval
intervalValue
billingInterval
appliedDiscount {
...AppliedDiscountFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": ContractFilter,
"sort": ContractSort,
"limit": 50,
"page": 1,
"_locale": "abc123"
}
Response
{
"data": {
"contractList": {
"results": [Contract],
"limit": 123,
"page": 987,
"pageCount": 123,
"resultCount": 987
}
}
}
episode
Description
🔐 You must have the following permissions to query this field:
- episode: read
Example
Query
query Episode($id: Int!) {
episode(id: $id) {
id
title
description
publishStart
publishEnd
releaseDate
posterImage
media {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
trailer {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
season {
id
title
description
publishStart
publishEnd
releaseDate
trailer {
...MediaFragment
}
posterImage
extras {
...ExtraFragment
}
episodes {
...EpisodeFragment
}
series {
...SeriesFragment
}
}
extras {
id
title
media {
...MediaFragment
}
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"episode": {
"id": 123,
"title": "abc123",
"description": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"posterImage": "xyz789",
"media": Media,
"trailer": Media,
"season": Season,
"extras": [Extra]
}
}
}
extra
Description
🔐 You must have the following permissions to query this field:
- extra: read
Example
Query
query Extra($id: Int!) {
extra(id: $id) {
id
title
media {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"extra": {
"id": 123,
"title": "xyz789",
"media": Media
}
}
}
feedOverlay
Response
Returns a
FeedOverlayList
Arguments
| Name | Description |
|---|---|
feedType
-
OverlayFeed! | |
id -
Int! | |
source -
OverlaySource |
Example
Query
query FeedOverlay(
$feedType: OverlayFeed!,
$id: Int!,
$source: OverlaySource
) {
feedOverlay(
feedType: $feedType,
id: $id,
source: $source
) {
items
title
}
}
Variables
{"feedType": "rss", "id": 123, "source": "overlay"}
Response
{
"data": {
"feedOverlay": {
"items": ["abc123"],
"title": "abc123"
}
}
}
genre
Description
🔐 You must have the following permissions to query this field:
- genre: read
genreList
Response
Returns a
GenreList
Arguments
| Name | Description |
|---|---|
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
filter -
GenreFilter | |
sort -
GenreListSort |
Example
Query
query GenreList(
$limit: Int,
$page: Int,
$filter: GenreFilter,
$sort: GenreListSort
) {
genreList(
limit: $limit,
page: $page,
filter: $filter,
sort: $sort
) {
results {
id
title
description
}
limit
page
pageCount
resultCount
}
}
Variables
{
"limit": 50,
"page": 1,
"filter": GenreFilter,
"sort": GenreListSort
}
Response
{
"data": {
"genreList": {
"results": [Genre],
"limit": 123,
"page": 123,
"pageCount": 987,
"resultCount": 123
}
}
}
interest
Description
🔐 You must have the following permissions to query this field:
- interest: read
Example
Query
query Interest($id: Int) {
interest(id: $id) {
id
slug
name
mediaList {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"interest": {
"id": 123,
"slug": "xyz789",
"name": "abc123",
"mediaList": MediaList
}
}
}
interestList
Response
Returns an
InterestListType
Arguments
| Name | Description |
|---|---|
filter -
InterestFilter | |
sort -
InterestSort | |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
Example
Query
query InterestList(
$filter: InterestFilter,
$sort: InterestSort,
$limit: Int,
$page: Int
) {
interestList(
filter: $filter,
sort: $sort,
limit: $limit,
page: $page
) {
results {
id
slug
name
mediaList {
...MediaListFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": InterestFilter,
"sort": InterestSort,
"limit": 50,
"page": 1
}
Response
{
"data": {
"interestList": {
"results": [Interest],
"limit": 987,
"page": 123,
"pageCount": 987,
"resultCount": 123
}
}
}
libraryCategories
Description
🔐 You must have the following permissions to query this field:
- libraryCategory: read
Response
Returns
[FrontendLibraryCategory!]
Example
Query
query LibraryCategories {
libraryCategories {
id
title
}
}
Response
{
"data": {
"libraryCategories": [
{"id": 123, "title": "abc123"}
]
}
}
live
Description
Represents the active livestream that is taking over the timeline. Note: the id argument is deprecated and will be ignored
The channel must have the timeline feature enabled to query this field.
Example
Query
query Live($id: Int) {
live(id: $id) {
item {
media {
...TimelineMediaItemFragment
}
overlay {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
timeline {
...MediaTimelineInfoFragment
}
}
livestream {
startTime
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"live": {
"item": TimelineItem,
"livestream": Livestream
}
}
}
liveChatSso
Response
Returns a
LiveChatSso
Arguments
| Name | Description |
|---|---|
mediaId
-
Int! |
Example
Query
query LiveChatSso($mediaId: Int!) {
liveChatSso(mediaId: $mediaId) {
collection {
messages
sentiments
}
userId
writeAccess
nickname
accessToken
firebaseConfig {
apiKey
applicationId
projectId
}
}
}
Variables
{"mediaId": 987}
Response
{
"data": {
"liveChatSso": {
"collection": LiveChatCollection,
"userId": "xyz789",
"writeAccess": true,
"nickname": "abc123",
"accessToken": "abc123",
"firebaseConfig": FirebaseConfig
}
}
}
media
Description
🔐 You must have the following permissions to query this field:
- media: read
Example
Query
query Media($id: Int!) {
media(id: $id) {
id
title
description
author
categories {
id
title
showMainMenu
slug
automatedTrading
description
thumbnail
parent {
...CategoryFragment
}
children {
...CategoryFragment
}
mediaList {
...MediaListFragment
}
vlogList {
...VlogListFragment
}
}
products {
results {
...ProductFragment
}
limit
page
pageCount
resultCount
}
createdAt
updatedAt
publishStart
views {
week
month
year
all
}
thumb
socialThumb
interests {
id
slug
name
mediaList {
...MediaListFragment
}
}
embedURL
keywords
socialNotificationFlags {
facebookLikes
twitterFollows
}
contentType
files {
vimeo {
...VimeoFileTypeFragment
}
image {
...ImageFileTypeFragment
}
hls {
...HlsFileTypeFragment
}
dash {
...DashFileTypeFragment
}
progressive {
...ProgressiveFileTypeFragment
}
rtmp {
...RTMPFileTypeFragment
}
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
enabled
refAppID
preroll
postroll
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
progress {
mediaID
media {
...MediaFragment
}
progress
watched
lastWatched
}
share {
enabled
url
}
subtitles {
results {
...MediaSubtitlesFragment
}
limit
page
pageCount
resultCount
}
spritesheets {
results {
...MediaSpritesheetsFragment
}
limit
page
pageCount
resultCount
}
unlisted
liveChat {
enabled
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
childMediaList {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
}
Variables
{"id": 987}
Response
{
"data": {
"media": {
"id": 123,
"title": "abc123",
"description": "xyz789",
"author": "abc123",
"categories": [Category],
"products": ProductList,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"publishStart": "2007-12-03T10:15:30Z",
"views": MediaViews,
"thumb": "xyz789",
"socialThumb": "xyz789",
"interests": [Interest],
"embedURL": "xyz789",
"keywords": ["abc123"],
"socialNotificationFlags": SocialNotificationFlags,
"contentType": "youtube",
"files": FileType,
"filesProtectedReason": "private",
"duration": 987,
"endedPosition": 123,
"pinned": true,
"private": true,
"automatedTrading": AutomatedTradingType,
"overlays": [OverlayLivestreamActive],
"vttTracks": [MetadataVttTrack],
"related": MediaList,
"progress": MediaProgress,
"share": MediaShare,
"subtitles": MediaSubtitlesList,
"spritesheets": MediaSpritesheetsList,
"unlisted": true,
"liveChat": MediaLiveChatSettings,
"livestreamStartTime": "2007-12-03T10:15:30Z",
"livestreamEndTime": "2007-12-03T10:15:30Z",
"liveTimeshifting": false,
"parentMedia": Media,
"childMediaList": MediaList,
"drmProtected": false,
"drmPolicy": "abc123",
"vmapUrl": "xyz789",
"hasGeneratedVmap": true,
"canonicalUrl": "xyz789"
}
}
}
mediaList
Response
Returns a
MediaList
Arguments
| Name | Description |
|---|---|
filter -
MediaFilter | |
sort -
MediaSort | Sorts the media list, if you want to sort by multiple fields, use orderedSort instead. This field is ignored when orderedSort is set. |
orderedSort
-
[MediaSort] | Sorts the media list by multiple fields, in the order they are provided. When this field is set, the sort field is ignored. |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
options
-
MediaListOptions |
Example
Query
query MediaList(
$filter: MediaFilter,
$sort: MediaSort,
$orderedSort: [MediaSort],
$limit: Int,
$page: Int,
$options: MediaListOptions
) {
mediaList(
filter: $filter,
sort: $sort,
orderedSort: $orderedSort,
limit: $limit,
page: $page,
options: $options
) {
results {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": MediaFilter,
"sort": MediaSort,
"orderedSort": [MediaSort],
"limit": 50,
"page": 1,
"options": MediaListOptions
}
Response
{
"data": {
"mediaList": {
"results": [Media],
"limit": 987,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
}
}
mediaProgress
Response
Returns a
MediaProgress
Arguments
| Name | Description |
|---|---|
mediaID
-
Int! |
Example
Query
query MediaProgress($mediaID: Int!) {
mediaProgress(mediaID: $mediaID) {
mediaID
media {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
progress
watched
lastWatched
}
}
Variables
{"mediaID": 123}
Response
{
"data": {
"mediaProgress": {
"mediaID": 987,
"media": Media,
"progress": 123,
"watched": true,
"lastWatched": "2007-12-03T10:15:30Z"
}
}
}
mediaProgressList
Response
Returns a
MediaProgressList
Arguments
| Name | Description |
|---|---|
cursor -
String | |
limit -
Int | Default = 50 |
filter -
MediaProgressFilter | |
options
-
MediaProgressOptions |
Example
Query
query MediaProgressList(
$cursor: String,
$limit: Int,
$filter: MediaProgressFilter,
$options: MediaProgressOptions
) {
mediaProgressList(
cursor: $cursor,
limit: $limit,
filter: $filter,
options: $options
) {
results {
mediaID
media {
...MediaFragment
}
progress
watched
lastWatched
}
pageInfo {
nextCursor
hasNextPage
}
}
}
Variables
{
"cursor": "xyz789",
"limit": 50,
"filter": MediaProgressFilter,
"options": MediaProgressOptions
}
Response
{
"data": {
"mediaProgressList": {
"results": [MediaProgress],
"pageInfo": PageInfo
}
}
}
mediaRelated
Description
Media items related to the media item of the given ID
Response
Returns a
MediaList!
Arguments
| Name | Description |
|---|---|
id -
Int! | |
filter -
MediaFilter | |
sort -
MediaSort | Sorts the media list, if you want to sort by multiple fields, use orderedSort instead. This field is ignored when orderedSort is set. |
orderedSort
-
[MediaSort] | Sorts the media list by multiple fields, in the order they are provided. When this field is set, the sort field is ignored. |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
options
-
MediaListOptions |
Example
Query
query MediaRelated(
$id: Int!,
$filter: MediaFilter,
$sort: MediaSort,
$orderedSort: [MediaSort],
$limit: Int,
$page: Int,
$options: MediaListOptions
) {
mediaRelated(
id: $id,
filter: $filter,
sort: $sort,
orderedSort: $orderedSort,
limit: $limit,
page: $page,
options: $options
) {
results {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
limit
page
pageCount
resultCount
}
}
Variables
{
"id": 123,
"filter": MediaFilter,
"sort": MediaSort,
"orderedSort": [MediaSort],
"limit": 50,
"page": 1,
"options": MediaListOptions
}
Response
{
"data": {
"mediaRelated": {
"results": [Media],
"limit": 987,
"page": 987,
"pageCount": 123,
"resultCount": 987
}
}
}
movie
Description
🔐 You must have the following permissions to query this field:
- movie: read
Example
Query
query Movie($id: Int!) {
movie(id: $id) {
id
title
description
publishStart
publishEnd
releaseDate
media {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
trailer {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
posterImage
genres {
id
title
description
}
extras {
id
title
media {
...MediaFragment
}
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"movie": {
"id": 123,
"title": "abc123",
"description": "xyz789",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"media": Media,
"trailer": Media,
"posterImage": "xyz789",
"genres": [Genre],
"extras": [Extra]
}
}
}
moviesAndSeriesList
Response
Returns a
MoviesAndSeriesList
Arguments
| Name | Description |
|---|---|
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
filter -
MoviesAndSeriesFilter | |
sort -
MoviesAndSeriesListSort |
Example
Query
query MoviesAndSeriesList(
$limit: Int,
$page: Int,
$filter: MoviesAndSeriesFilter,
$sort: MoviesAndSeriesListSort
) {
moviesAndSeriesList(
limit: $limit,
page: $page,
filter: $filter,
sort: $sort
) {
results {
... on Movie {
...MovieFragment
}
... on Series {
...SeriesFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"limit": 50,
"page": 1,
"filter": MoviesAndSeriesFilter,
"sort": MoviesAndSeriesListSort
}
Response
{
"data": {
"moviesAndSeriesList": {
"results": [Movie],
"limit": 987,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
}
}
paymentServiceProviderList
Response
Returns
[PaymentServiceProvider]
Example
Query
query PaymentServiceProviderList {
paymentServiceProviderList {
id
name
publicApiKey
methods {
id
name
type
supportedPlanTypes
options {
...IssuerArrayFragment
}
}
}
}
Response
{
"data": {
"paymentServiceProviderList": [
{
"id": 987,
"name": "xyz789",
"publicApiKey": "abc123",
"methods": [PaymentMethod]
}
]
}
}
permissions
Description
The list of permissions the querying user has
Response
Returns an
AclPermissions
Example
Query
query Permissions {
permissions {
category {
create
read
update
delete
}
comment {
create
read
update
delete
}
contentPage {
create
read
update
delete
}
contract {
create
read
update
delete
}
discountCode {
create
read
update
delete
}
episode {
create
read
update
delete
}
extra {
create
read
update
delete
}
genre {
create
read
update
delete
}
interest {
create
read
update
delete
}
libraryCategory {
create
read
update
delete
}
media {
create
read
update
delete
}
movie {
create
read
update
delete
}
overlay {
create
read
update
delete
}
plan {
create
read
update
delete
}
product {
create
read
update
delete
}
season {
create
read
update
delete
}
series {
create
read
update
delete
}
slide {
create
read
update
delete
}
slider {
create
read
update
delete
}
transaction {
create
read
update
delete
}
userMedia {
create
read
update
delete
}
vlog {
create
read
update
delete
}
watchLater {
create
read
update
delete
}
analytics {
create
read
update
delete
}
anyComment {
create
read
update
delete
}
chatModeration {
create
read
update
delete
}
file {
create
read
update
delete
}
mediaSpritesheets {
create
read
update
delete
}
mediaSubtitles {
create
read
update
delete
}
purchase {
create
read
update
delete
}
uiBuilder {
create
read
update
delete
}
usageReport {
create
read
update
delete
}
user {
create
read
update
delete
}
userDisplayName {
create
read
update
delete
}
settings {
create
read
update
delete
}
subscription {
create
read
update
delete
}
timeline {
create
read
update
delete
}
}
}
Response
{
"data": {
"permissions": {
"category": AclCrudPermissions,
"comment": AclCrudPermissions,
"contentPage": AclCrudPermissions,
"contract": AclCrudPermissions,
"discountCode": AclCrudPermissions,
"episode": AclCrudPermissions,
"extra": AclCrudPermissions,
"genre": AclCrudPermissions,
"interest": AclCrudPermissions,
"libraryCategory": AclCrudPermissions,
"media": AclCrudPermissions,
"movie": AclCrudPermissions,
"overlay": AclCrudPermissions,
"plan": AclCrudPermissions,
"product": AclCrudPermissions,
"season": AclCrudPermissions,
"series": AclCrudPermissions,
"slide": AclCrudPermissions,
"slider": AclCrudPermissions,
"transaction": AclCrudPermissions,
"userMedia": AclCrudPermissions,
"vlog": AclCrudPermissions,
"watchLater": AclCrudPermissions,
"analytics": AclCrudPermissions,
"anyComment": AclCrudPermissions,
"chatModeration": AclCrudPermissions,
"file": AclCrudPermissions,
"mediaSpritesheets": AclCrudPermissions,
"mediaSubtitles": AclCrudPermissions,
"purchase": AclCrudPermissions,
"uiBuilder": AclCrudPermissions,
"usageReport": AclCrudPermissions,
"user": AclCrudPermissions,
"userDisplayName": AclCrudPermissions,
"settings": AclCrudPermissions,
"subscription": AclCrudPermissions,
"timeline": AclCrudPermissions
}
}
}
product
Description
🔐 You must have the following permissions to query this field:
- product: read
The channel must have the premiumContent feature enabled to query this field.
Example
Query
query Product($id: Int!) {
product(id: $id) {
id
title
description
type
termsOfUse
allowSubmitMedia
preventAds
createdAt
updatedAt
plans {
results {
...PlanFragment
}
limit
page
pageCount
resultCount
}
media {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
interests {
results {
...InterestFragment
}
limit
page
pageCount
resultCount
}
categories {
results {
...CategoryFragment
}
limit
page
pageCount
resultCount
}
includedMedia {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
trailer {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"product": {
"id": 987,
"title": "abc123",
"description": "xyz789",
"type": "singularMedia",
"termsOfUse": "abc123",
"allowSubmitMedia": false,
"preventAds": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"plans": PlanList,
"media": MediaList,
"interests": InterestListType,
"categories": CategoryList,
"includedMedia": MediaList,
"trailer": Media
}
}
}
productList
Description
The channel must have the premiumContent feature enabled to query this field.
Response
Returns a
ProductList
Arguments
| Name | Description |
|---|---|
page -
Int | Default = 1 |
limit -
Int | Default = 50 |
filter -
ProductFilter | |
sort -
ProductListSort |
Example
Query
query ProductList(
$page: Int,
$limit: Int,
$filter: ProductFilter,
$sort: ProductListSort
) {
productList(
page: $page,
limit: $limit,
filter: $filter,
sort: $sort
) {
results {
id
title
description
type
termsOfUse
allowSubmitMedia
preventAds
createdAt
updatedAt
plans {
...PlanListFragment
}
media {
...MediaListFragment
}
interests {
...InterestListTypeFragment
}
categories {
...CategoryListFragment
}
includedMedia {
...MediaListFragment
}
trailer {
...MediaFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"page": 1,
"limit": 50,
"filter": ProductFilter,
"sort": ProductListSort
}
Response
{
"data": {
"productList": {
"results": [Product],
"limit": 123,
"page": 987,
"pageCount": 123,
"resultCount": 987
}
}
}
profile
Response
Returns a
ProfileType!
Example
Query
query Profile {
profile {
id
username
uuid
firstName
lastName
displayName
email
country
registerType
verified
language
interests {
id
slug
name
mediaList {
...MediaListFragment
}
}
roles
userNotificationPreferences {
notificationNewMedia
notificationLivestreamScheduled
notificationInvoice
newsletterSubscribed
}
canSubmitMedia
}
}
Response
{
"data": {
"profile": {
"id": 123,
"username": "abc123",
"uuid": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"displayName": "abc123",
"email": "abc123",
"country": "AF",
"registerType": 123,
"verified": true,
"language": "abc123",
"interests": [Interest],
"roles": ["elearningLessonReports"],
"userNotificationPreferences": NotificationInputs,
"canSubmitMedia": false
}
}
}
requestDetails
Response
Returns a
RequestDetails
Example
Query
query RequestDetails {
requestDetails {
country
}
}
Response
{
"data": {
"requestDetails": {"country": "xyz789"}
}
}
route
Description
🔐 You must have the following permissions to query this field:
- uiBuilder: read
The channel must have the uiBuilder feature enabled to query this field.
Response
Returns a Route
Arguments
| Name | Description |
|---|---|
type -
UIBuilderTypeEnum! | |
routeName
-
String! |
Example
Query
query Route(
$type: UIBuilderTypeEnum!,
$routeName: String!
) {
route(
type: $type,
routeName: $routeName
) {
type
routeName
context
status
ui {
... on UIComponentAccountView {
...UIComponentAccountViewFragment
}
... on AppUIComponentBlock {
...AppUIComponentBlockFragment
}
... on AppUIComponentCategoryMediaCollection {
...AppUIComponentCategoryMediaCollectionFragment
}
... on AppUIComponentCategoryThumbCollection {
...AppUIComponentCategoryThumbCollectionFragment
}
... on AppUIComponentContinueWatching {
...AppUIComponentContinueWatchingFragment
}
... on AppUIComponentImage {
...AppUIComponentImageFragment
}
... on AppUIComponentMarketingSlider {
...AppUIComponentMarketingSliderFragment
}
... on AppUIComponentMediaCollection {
...AppUIComponentMediaCollectionFragment
}
... on AppUIComponentOndemandCollection {
...AppUIComponentOndemandCollectionFragment
}
... on AppUIComponentText {
...AppUIComponentTextFragment
}
... on AppUIComponentTimelinePlayButton {
...AppUIComponentTimelinePlayButtonFragment
}
... on AppUIComponentTimelineSchedule {
...AppUIComponentTimelineScheduleFragment
}
... on UIComponentApp {
...UIComponentAppFragment
}
... on UIComponentBlock {
...UIComponentBlockFragment
}
... on UIComponentBlurredItem {
...UIComponentBlurredItemFragment
}
... on UIComponentBreadcrumb {
...UIComponentBreadcrumbFragment
}
... on UIComponentCategoryTags {
...UIComponentCategoryTagsFragment
}
... on UIComponentContentPagesList {
...UIComponentContentPagesListFragment
}
... on UIComponentCurrentlyPlaying {
...UIComponentCurrentlyPlayingFragment
}
... on UIComponentGridItem {
...UIComponentGridItemFragment
}
... on UIComponentGrid {
...UIComponentGridFragment
}
... on UIComponentHeading {
...UIComponentHeadingFragment
}
... on UIComponentHr {
...UIComponentHrFragment
}
... on UIComponentHtml {
...UIComponentHtmlFragment
}
... on UIComponentIcon {
...UIComponentIconFragment
}
... on UIComponentImage {
...UIComponentImageFragment
}
... on UIComponentItemComments {
...UIComponentItemCommentsFragment
}
... on UIComponentItemInterests {
...UIComponentItemInterestsFragment
}
... on UIComponentItemShare {
...UIComponentItemShareFragment
}
... on UIComponentLastWatchedOrNewMedia {
...UIComponentLastWatchedOrNewMediaFragment
}
... on UIComponentLink {
...UIComponentLinkFragment
}
... on UIComponentMediaItemsCategory {
...UIComponentMediaItemsCategoryFragment
}
... on UIComponentMediaItems {
...UIComponentMediaItemsFragment
}
... on UIComponentOndemandComponent {
...UIComponentOndemandComponentFragment
}
... on UIComponentOndemand {
...UIComponentOndemandFragment
}
... on UIComponentPageMeta {
...UIComponentPageMetaFragment
}
... on UIComponentRelatedVlogItems {
...UIComponentRelatedVlogItemsFragment
}
... on UIComponentRequestPlayer {
...UIComponentRequestPlayerFragment
}
... on UIComponentSearchView {
...UIComponentSearchViewFragment
}
... on UIComponentSettingsContent {
...UIComponentSettingsContentFragment
}
... on UIComponentSocialMediaButtons {
...UIComponentSocialMediaButtonsFragment
}
... on UIComponentText {
...UIComponentTextFragment
}
... on UIComponentThumbBackdrop {
...UIComponentThumbBackdropFragment
}
... on UIComponentVlogCategoriesList {
...UIComponentVlogCategoriesListFragment
}
... on UIComponentVlogCategoryCollection {
...UIComponentVlogCategoryCollectionFragment
}
... on UIComponentVlogItemContent {
...UIComponentVlogItemContentFragment
}
... on UIComponentVlogItemHeader {
...UIComponentVlogItemHeaderFragment
}
... on UIComponentVlogItemsCategory {
...UIComponentVlogItemsCategoryFragment
}
... on UIComponentVlogItems {
...UIComponentVlogItemsFragment
}
... on WebUIComponentMarketingSlider {
...WebUIComponentMarketingSliderFragment
}
}
rootIDs
style
created
}
}
Variables
{"type": "web", "routeName": "xyz789"}
Response
{
"data": {
"route": {
"type": "web",
"routeName": "xyz789",
"context": "xyz789",
"status": "published",
"ui": [UIComponentAccountView],
"rootIDs": [4],
"style": "xyz789",
"created": "2007-12-03T10:15:30Z"
}
}
}
routeList
Description
The channel must have the uiBuilder feature enabled to query this field.
Response
Returns a
RouteList
Arguments
| Name | Description |
|---|---|
type -
UIBuilderTypeEnum! | |
cursor -
String | |
limit -
Int | Default = 50 |
Example
Query
query RouteList(
$type: UIBuilderTypeEnum!,
$cursor: String,
$limit: Int
) {
routeList(
type: $type,
cursor: $cursor,
limit: $limit
) {
results {
type
routeName
context
status
ui {
... on UIComponentAccountView {
...UIComponentAccountViewFragment
}
... on AppUIComponentBlock {
...AppUIComponentBlockFragment
}
... on AppUIComponentCategoryMediaCollection {
...AppUIComponentCategoryMediaCollectionFragment
}
... on AppUIComponentCategoryThumbCollection {
...AppUIComponentCategoryThumbCollectionFragment
}
... on AppUIComponentContinueWatching {
...AppUIComponentContinueWatchingFragment
}
... on AppUIComponentImage {
...AppUIComponentImageFragment
}
... on AppUIComponentMarketingSlider {
...AppUIComponentMarketingSliderFragment
}
... on AppUIComponentMediaCollection {
...AppUIComponentMediaCollectionFragment
}
... on AppUIComponentOndemandCollection {
...AppUIComponentOndemandCollectionFragment
}
... on AppUIComponentText {
...AppUIComponentTextFragment
}
... on AppUIComponentTimelinePlayButton {
...AppUIComponentTimelinePlayButtonFragment
}
... on AppUIComponentTimelineSchedule {
...AppUIComponentTimelineScheduleFragment
}
... on UIComponentApp {
...UIComponentAppFragment
}
... on UIComponentBlock {
...UIComponentBlockFragment
}
... on UIComponentBlurredItem {
...UIComponentBlurredItemFragment
}
... on UIComponentBreadcrumb {
...UIComponentBreadcrumbFragment
}
... on UIComponentCategoryTags {
...UIComponentCategoryTagsFragment
}
... on UIComponentContentPagesList {
...UIComponentContentPagesListFragment
}
... on UIComponentCurrentlyPlaying {
...UIComponentCurrentlyPlayingFragment
}
... on UIComponentGridItem {
...UIComponentGridItemFragment
}
... on UIComponentGrid {
...UIComponentGridFragment
}
... on UIComponentHeading {
...UIComponentHeadingFragment
}
... on UIComponentHr {
...UIComponentHrFragment
}
... on UIComponentHtml {
...UIComponentHtmlFragment
}
... on UIComponentIcon {
...UIComponentIconFragment
}
... on UIComponentImage {
...UIComponentImageFragment
}
... on UIComponentItemComments {
...UIComponentItemCommentsFragment
}
... on UIComponentItemInterests {
...UIComponentItemInterestsFragment
}
... on UIComponentItemShare {
...UIComponentItemShareFragment
}
... on UIComponentLastWatchedOrNewMedia {
...UIComponentLastWatchedOrNewMediaFragment
}
... on UIComponentLink {
...UIComponentLinkFragment
}
... on UIComponentMediaItemsCategory {
...UIComponentMediaItemsCategoryFragment
}
... on UIComponentMediaItems {
...UIComponentMediaItemsFragment
}
... on UIComponentOndemandComponent {
...UIComponentOndemandComponentFragment
}
... on UIComponentOndemand {
...UIComponentOndemandFragment
}
... on UIComponentPageMeta {
...UIComponentPageMetaFragment
}
... on UIComponentRelatedVlogItems {
...UIComponentRelatedVlogItemsFragment
}
... on UIComponentRequestPlayer {
...UIComponentRequestPlayerFragment
}
... on UIComponentSearchView {
...UIComponentSearchViewFragment
}
... on UIComponentSettingsContent {
...UIComponentSettingsContentFragment
}
... on UIComponentSocialMediaButtons {
...UIComponentSocialMediaButtonsFragment
}
... on UIComponentText {
...UIComponentTextFragment
}
... on UIComponentThumbBackdrop {
...UIComponentThumbBackdropFragment
}
... on UIComponentVlogCategoriesList {
...UIComponentVlogCategoriesListFragment
}
... on UIComponentVlogCategoryCollection {
...UIComponentVlogCategoryCollectionFragment
}
... on UIComponentVlogItemContent {
...UIComponentVlogItemContentFragment
}
... on UIComponentVlogItemHeader {
...UIComponentVlogItemHeaderFragment
}
... on UIComponentVlogItemsCategory {
...UIComponentVlogItemsCategoryFragment
}
... on UIComponentVlogItems {
...UIComponentVlogItemsFragment
}
... on WebUIComponentMarketingSlider {
...WebUIComponentMarketingSliderFragment
}
}
rootIDs
style
created
}
pageInfo {
nextCursor
hasNextPage
}
}
}
Variables
{
"type": "web",
"cursor": "abc123",
"limit": 50
}
Response
{
"data": {
"routeList": {
"results": [Route],
"pageInfo": PageInfo
}
}
}
season
Description
🔐 You must have the following permissions to query this field:
- season: read
Example
Query
query Season($id: Int!) {
season(id: $id) {
id
title
description
publishStart
publishEnd
releaseDate
trailer {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
posterImage
extras {
id
title
media {
...MediaFragment
}
}
episodes {
id
title
description
publishStart
publishEnd
releaseDate
posterImage
media {
...MediaFragment
}
trailer {
...MediaFragment
}
season {
...SeasonFragment
}
extras {
...ExtraFragment
}
}
series {
id
title
description
publishStart
publishEnd
releaseDate
trailer {
...MediaFragment
}
posterImage
genres {
...GenreFragment
}
seasons {
...SeasonFragment
}
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"season": {
"id": 123,
"title": "abc123",
"description": "xyz789",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"trailer": Media,
"posterImage": "abc123",
"extras": [Extra],
"episodes": [Episode],
"series": Series
}
}
}
series
Description
🔐 You must have the following permissions to query this field:
- series: read
Example
Query
query Series($id: Int!) {
series(id: $id) {
id
title
description
publishStart
publishEnd
releaseDate
trailer {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
posterImage
genres {
id
title
description
}
seasons {
id
title
description
publishStart
publishEnd
releaseDate
trailer {
...MediaFragment
}
posterImage
extras {
...ExtraFragment
}
episodes {
...EpisodeFragment
}
series {
...SeriesFragment
}
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"series": {
"id": 123,
"title": "xyz789",
"description": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"trailer": Media,
"posterImage": "abc123",
"genres": [Genre],
"seasons": [Season]
}
}
}
settings
Description
🔐 You must have the following permissions to query this field:
- settings: read
Response
Returns a
Settings!
Example
Query
query Settings {
settings {
channel {
name
description
channelType
}
defaultLanguage
languages
analyticsApiUrl
analytics
appState
featuredMedia
googleApiMapsKey
analyticsTrackingIDs {
trackingID
}
googleTagManagerCode
hasHls
store {
ios {
...StoreDetailsFragment
}
android {
...StoreDetailsFragment
}
}
social {
facebook {
...FacebookDetailsFragment
}
twitter {
...SocialDetailsFragment
}
linkedin {
...SocialDetailsFragment
}
googleplus {
...SocialDetailsFragment
}
instagram {
...SocialDetailsFragment
}
tiktok {
...SocialDetailsFragment
}
spotify {
...SocialDetailsFragment
}
youtube {
...SocialDetailsFragment
}
snapchat {
...SocialDetailsFragment
}
pinterest {
...SocialDetailsFragment
}
}
newsletter
enableUserCountryInput
enableQualitySelector
enableCookieConsentNotice
enablePremiumContentIndicator
showOndemandViews
launchScreen {
new
loggedIn
}
notifications {
flags {
...NotificationFlagsFragment
}
inputs {
...NotificationInputsFragment
}
}
mobileApps
versions {
minAPI {
...VersionNumberTypeFragment
}
}
ui {
media {
...MediaSettingsFragment
}
restrictions {
...RestrictionSettingsFragment
}
ondemandCategorizationType
web {
...UITypeFragment
}
mobile {
...UITypeFragment
}
tv {
...UITypeFragment
}
}
hostname
features {
premiumContent {
...PremiumContentFeatureSettingsFragment
}
svod {
...SvodFeatureSettingsFragment
}
elearning {
...ElearningFeatureSettingsFragment
}
b2btv {
...B2btvFeatureSettingsFragment
}
automatedTrading {
...AutomatedTradingFeatureSettingsFragment
}
subtitles {
...SubtitlesFeatureSettingsFragment
}
chapters {
...ChaptersFeatureSettingsFragment
}
metadata {
...MetadataFeatureSettingsFragment
}
geoblocking {
...GeoblockingFeatureSettingsFragment
}
ticketCode {
...TicketCodeFeatureSettingsFragment
}
discountCode {
...DiscountCodeFeatureSettingsFragment
}
submitMedia {
...SubmitMediaSettingsFragment
}
activeDirectoryLogin {
...ActiveDirectoryLoginSettingsFragment
}
uiBuilder {
...UIBuilderFeatureSettingsFragment
}
liveChat {
...LiveChatFeatureSettingsFragment
}
marketingSliders {
...MarketingSlidersFeatureSettingsFragment
}
drm {
...DrmFeatureSettingsFragment
}
liveTimeshifting {
...LiveTimeshiftingFeatureSettingsFragment
}
sentry {
...SentryFeatureSettingsFragment
}
tvApp {
...TvAppFeatureSettingsFragment
}
vlogs {
...VlogsFeatureSettingsFragment
}
contentPages {
...ContentPagesFeatureSettingsFragment
}
timeline {
...TimelineFeatureSettingsFragment
}
frontendUser {
...FrontendUserFeatureSettingsFragment
}
broadcast {
...BroadcastFeatureSettingsTypeFragment
}
transcribe {
...TranscribeFeatureSettingsFragment
}
}
channelProtectedReason
allowMediaInMainCategory
apple {
teamID
appBundleID
signIn {
...SignInWithAppleSettingsFragment
}
}
player {
airplay
autoSelectSubtitles
chromeCast
contextMenu
doubleTapControl
mediaSession
pip
playProgressTracking
vr360
playNextStrategy
streamLogoUrl
timelinePage
}
googleCastApplicationId
drmApiEndpoint
producedContentUrlSigning
interestCount
}
}
Response
{
"data": {
"settings": {
"channel": ChannelInfo,
"defaultLanguage": "abc123",
"languages": ["xyz789"],
"analyticsApiUrl": "xyz789",
"analytics": "abc123",
"appState": "ok",
"featuredMedia": 123,
"googleApiMapsKey": "abc123",
"analyticsTrackingIDs": [AnalyticsSettings],
"googleTagManagerCode": "abc123",
"hasHls": false,
"store": StoreType,
"social": SocialType,
"newsletter": false,
"enableUserCountryInput": true,
"enableQualitySelector": false,
"enableCookieConsentNotice": false,
"enablePremiumContentIndicator": false,
"showOndemandViews": true,
"launchScreen": LaunchScreenSettings,
"notifications": NotificationSettings,
"mobileApps": true,
"versions": VersionType,
"ui": UISettings,
"hostname": "abc123",
"features": FeaturesSettings,
"channelProtectedReason": "geoblocked",
"allowMediaInMainCategory": true,
"apple": AppleSettings,
"player": PlayerSettings,
"googleCastApplicationId": "xyz789",
"drmApiEndpoint": "abc123",
"producedContentUrlSigning": true,
"interestCount": 987
}
}
}
slide
Description
🔐 You must have the following permissions to query this field:
- slide: read
Example
Query
query Slide($id: Int!) {
slide(id: $id) {
id
title
hideTitle
description
hideDescription
image
showDuration
order
cta {
id
title
type
url
media {
...MediaFragment
}
product {
...ProductFragment
}
plan {
...PlanFragment
}
openExternally
}
availableOn
}
}
Variables
{"id": 123}
Response
{
"data": {
"slide": {
"id": 123,
"title": "abc123",
"hideTitle": false,
"description": "abc123",
"hideDescription": false,
"image": "xyz789",
"showDuration": 123,
"order": 123,
"cta": [SlideCta],
"availableOn": ["None"]
}
}
}
slideList
Response
Returns a
SlideList
Arguments
| Name | Description |
|---|---|
page -
Int | Default = 1 |
limit -
Int | Default = 10 |
sliderId
-
Int! | |
filter -
SlideFilter |
Example
Query
query SlideList(
$page: Int,
$limit: Int,
$sliderId: Int!,
$filter: SlideFilter
) {
slideList(
page: $page,
limit: $limit,
sliderId: $sliderId,
filter: $filter
) {
results {
id
title
hideTitle
description
hideDescription
image
showDuration
order
cta {
...SlideCtaFragment
}
availableOn
}
limit
page
pageCount
resultCount
}
}
Variables
{
"page": 1,
"limit": 10,
"sliderId": 987,
"filter": SlideFilter
}
Response
{
"data": {
"slideList": {
"results": [Slide],
"limit": 987,
"page": 123,
"pageCount": 987,
"resultCount": 987
}
}
}
slider
Description
A marketing slider that can hold 10 slides
🔐 You must have the following permissions to query this field:
- slider: read
Example
Query
query Slider($id: Int!) {
slider(id: $id) {
id
title
slides {
id
title
hideTitle
description
hideDescription
image
showDuration
order
cta {
...SlideCtaFragment
}
availableOn
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"slider": {
"id": 123,
"title": "xyz789",
"slides": [Slide]
}
}
}
sliderList
Response
Returns a
SliderList
Arguments
| Name | Description |
|---|---|
page -
Int | Default = 1 |
limit -
Int | Default = 50 |
filter -
SliderFilter |
Example
Query
query SliderList(
$page: Int,
$limit: Int,
$filter: SliderFilter
) {
sliderList(
page: $page,
limit: $limit,
filter: $filter
) {
results {
id
title
slides {
...SlideFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{"page": 1, "limit": 50, "filter": SliderFilter}
Response
{
"data": {
"sliderList": {
"results": [Slider],
"limit": 123,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
}
}
style
Description
🔐 You must have the following permissions to query this field:
- uiBuilder: read
The channel must have the uiBuilder feature enabled to query this field.
Response
Returns a Style
Arguments
| Name | Description |
|---|---|
type -
UIBuilderTypeEnum! |
Example
Query
query Style($type: UIBuilderTypeEnum!) {
style(type: $type) {
type
style
}
}
Variables
{"type": "web"}
Response
{
"data": {
"style": {
"type": "web",
"style": "xyz789"
}
}
}
timeline
Description
Note: the id argument is deprecated and will be ignored
🔐 You must have the following permissions to query this field:
- timeline: read
The channel must have the timeline feature enabled to query this field.
Response
Returns a
TimelineType
Arguments
| Name | Description |
|---|---|
id -
Int |
Example
Query
query Timeline($id: Int) {
timeline(id: $id) {
items {
media {
...TimelineMediaItemFragment
}
overlay {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
timeline {
...MediaTimelineInfoFragment
}
}
overlay {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
timeline {
startTime
totalDuration
lastUpdate
}
share {
message
url
enabled
}
automatedTrading {
refID
refAppID
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"timeline": {
"items": [TimelineItem],
"overlay": [OverlayLivestreamActive],
"timeline": TimelineInfo,
"share": Share,
"automatedTrading": TimelineAutomatedTradingType
}
}
}
transaction
Description
The authenticated user's transaction of the given ID
🔐 You must have the following permissions to query this field:
- transaction: read
Response
Returns a
Transaction
Arguments
| Name | Description |
|---|---|
id -
Int! |
Example
Query
query Transaction($id: Int!) {
transaction(id: $id) {
id
amountInCents
currency
provider
method
status
reason
contracts {
results {
...ContractFragment
}
limit
page
pageCount
resultCount
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"transaction": {
"id": 123,
"amountInCents": 987,
"currency": "USD",
"provider": "cardGate",
"method": "Bancontact",
"status": "pending",
"reason": "authSuccess",
"contracts": ContractList
}
}
}
userInterests
Description
The interests of the authenticated user
🔐 You must have the following permissions to query this field:
- interest: read
Response
Returns
[Interest]
Example
Query
query UserInterests {
userInterests {
id
slug
name
mediaList {
results {
...MediaFragment
}
limit
page
pageCount
resultCount
}
}
}
Response
{
"data": {
"userInterests": [
{
"id": 123,
"slug": "abc123",
"name": "xyz789",
"mediaList": MediaList
}
]
}
}
userMediaGetUploadUrl
Description
Gets credentials to upload user media to S3.
The channel must have the submitMedia feature enabled to query this field.
Response
Returns an
UploadUserMediaUploadUrl
Example
Query
query UserMediaGetUploadUrl {
userMediaGetUploadUrl {
Credentials {
AccessKeyID
SecretAccessKey
SessionToken
Expiration
}
Region
S3 {
Bucket
Key
}
}
}
Response
{
"data": {
"userMediaGetUploadUrl": {
"Credentials": Credentials,
"Region": "abc123",
"S3": S3
}
}
}
userMediaSubmissionAllowed
Description
Whether or not uploading user generated content is allowed, based on the rate limits set for the current channel.
The channel must have the submitMedia feature enabled to query this field.
Response
Returns a
UserMediaSubmissionAllowStatus
Example
Query
query UserMediaSubmissionAllowed {
userMediaSubmissionAllowed {
allowed
reason
}
}
Response
{
"data": {
"userMediaSubmissionAllowed": {
"allowed": true,
"reason": "xyz789"
}
}
}
userNotificationPreferences
Description
Gets the authenticated user's notification preferences. Note: the userID argument is deprecated and will be ignored.
Response
Returns a
NotificationInputs
Arguments
| Name | Description |
|---|---|
userID -
Int |
Example
Query
query UserNotificationPreferences($userID: Int) {
userNotificationPreferences(userID: $userID) {
notificationNewMedia
notificationLivestreamScheduled
notificationInvoice
newsletterSubscribed
}
}
Variables
{"userID": 123}
Response
{
"data": {
"userNotificationPreferences": {
"notificationNewMedia": NotificationBitmaskType,
"notificationLivestreamScheduled": NotificationBitmaskType,
"notificationInvoice": NotificationBitmaskType,
"newsletterSubscribed": NotificationBitmaskType
}
}
}
vlog
Description
Gets the vlog.
🔐 You must have the following permissions to query this field:
- vlog: read
The channel must have the vlogs feature enabled to query this field.
Example
Query
query Vlog($slug: String!) {
vlog(slug: $slug) {
commentCount
createdAt
updatedAt
publishStart
id
media {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
contentText
description
allowComments
slug
commentList {
results {
...CommentTypeFragment
}
limit
page
pageCount
resultCount
}
related {
results {
...VlogListItemFragment
}
limit
page
pageCount
resultCount
}
}
}
Variables
{"slug": "abc123"}
Response
{
"data": {
"vlog": {
"commentCount": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"publishStart": "2007-12-03T10:15:30Z",
"id": 987,
"media": Media,
"contentText": "abc123",
"description": "xyz789",
"allowComments": true,
"slug": "abc123",
"commentList": CommentList,
"related": VlogList
}
}
}
vlogList
Description
Gets the list of vlogs.
The channel must have the vlogs feature enabled to query this field.
Response
Returns a
VlogList
Arguments
| Name | Description |
|---|---|
filter -
VlogFilter | |
sort -
VlogSort | |
limit -
Int | |
page -
Int |
Example
Query
query VlogList(
$filter: VlogFilter,
$sort: VlogSort,
$limit: Int,
$page: Int
) {
vlogList(
filter: $filter,
sort: $sort,
limit: $limit,
page: $page
) {
results {
title
commentCount
createdAt
updatedAt
publishStart
id
media {
...MediaFragment
}
contentText
description
allowComments
slug
commentList {
...CommentListFragment
}
related {
...VlogListFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": VlogFilter,
"sort": VlogSort,
"limit": 123,
"page": 123
}
Response
{
"data": {
"vlogList": {
"results": [VlogListItem],
"limit": 987,
"page": 123,
"pageCount": 123,
"resultCount": 987
}
}
}
vlogRelated
Description
Gets vlogs related to the given vlog.
The channel must have the vlogs feature enabled to query this field.
Response
Returns a
VlogList
Arguments
| Name | Description |
|---|---|
slug -
String! | |
filter -
VlogFilter | |
sort -
VlogSort | |
limit -
Int | |
page -
Int |
Example
Query
query VlogRelated(
$slug: String!,
$filter: VlogFilter,
$sort: VlogSort,
$limit: Int,
$page: Int
) {
vlogRelated(
slug: $slug,
filter: $filter,
sort: $sort,
limit: $limit,
page: $page
) {
results {
title
commentCount
createdAt
updatedAt
publishStart
id
media {
...MediaFragment
}
contentText
description
allowComments
slug
commentList {
...CommentListFragment
}
related {
...VlogListFragment
}
}
limit
page
pageCount
resultCount
}
}
Variables
{
"slug": "xyz789",
"filter": VlogFilter,
"sort": VlogSort,
"limit": 987,
"page": 123
}
Response
{
"data": {
"vlogRelated": {
"results": [VlogListItem],
"limit": 123,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
}
}
watchLaterList
Response
Returns a
WatchLaterMediaList
Arguments
| Name | Description |
|---|---|
filter -
MediaFilter | |
sort -
MediaSort | Sorts the media list, if you want to sort by multiple fields, use orderedSort instead. This field is ignored when orderedSort is set. |
orderedSort
-
[MediaSort] | Sorts the media list by multiple fields, in the order they are provided. When this field is set, the sort field is ignored. |
limit -
Int | Default = 50 |
page -
Int | Default = 1 |
options
-
MediaListOptions |
Example
Query
query WatchLaterList(
$filter: MediaFilter,
$sort: MediaSort,
$orderedSort: [MediaSort],
$limit: Int,
$page: Int,
$options: MediaListOptions
) {
watchLaterList(
filter: $filter,
sort: $sort,
orderedSort: $orderedSort,
limit: $limit,
page: $page,
options: $options
) {
results {
id
title
description
author
categories {
...CategoryFragment
}
products {
...ProductListFragment
}
createdAt
updatedAt
publishStart
views {
...MediaViewsFragment
}
thumb
socialThumb
interests {
...InterestFragment
}
embedURL
keywords
socialNotificationFlags {
...SocialNotificationFlagsFragment
}
contentType
files {
...FileTypeFragment
}
filesProtectedReason
duration
endedPosition
pinned
private
automatedTrading {
...AutomatedTradingTypeFragment
}
overlays {
... on OverlayLivestreamActive {
...OverlayLivestreamActiveFragment
}
... on OverlayMap {
...OverlayMapFragment
}
... on OverlayBookBuy {
...OverlayBookBuyFragment
}
... on OverlayTwitter {
...OverlayTwitterFragment
}
... on OverlayInfo {
...OverlayInfoFragment
}
... on OverlayRSS {
...OverlayRSSFragment
}
... on OverlayAutomatedTrading {
...OverlayAutomatedTradingFragment
}
... on OverlayReact {
...OverlayReactFragment
}
... on OverlayLowerThird {
...OverlayLowerThirdFragment
}
... on OverlayLink {
...OverlayLinkFragment
}
... on OverlayArea {
...OverlayAreaFragment
}
... on OverlaySeekTo {
...OverlaySeekToFragment
}
... on OverlayECommerce {
...OverlayECommerceFragment
}
}
vttTracks {
... on MetadataVttTrack {
...MetadataVttTrackFragment
}
... on ChaptersVttTrack {
...ChaptersVttTrackFragment
}
... on OverlaysVttTrack {
...OverlaysVttTrackFragment
}
}
related {
...MediaListFragment
}
progress {
...MediaProgressFragment
}
share {
...MediaShareFragment
}
subtitles {
...MediaSubtitlesListFragment
}
spritesheets {
...MediaSpritesheetsListFragment
}
unlisted
liveChat {
...MediaLiveChatSettingsFragment
}
livestreamStartTime
livestreamEndTime
liveTimeshifting
parentMedia {
...MediaFragment
}
childMediaList {
...MediaListFragment
}
drmProtected
drmPolicy
vmapUrl
hasGeneratedVmap
canonicalUrl
}
limit
page
pageCount
resultCount
}
}
Variables
{
"filter": MediaFilter,
"sort": MediaSort,
"orderedSort": [MediaSort],
"limit": 50,
"page": 1,
"options": MediaListOptions
}
Response
{
"data": {
"watchLaterList": {
"results": [Media],
"limit": 987,
"page": 987,
"pageCount": 987,
"resultCount": 987
}
}
}
Mutations
activateAccount
Response
Returns an
ActivateAccount
Example
Query
mutation ActivateAccount(
$email: String!,
$token: String!
) {
activateAccount(
email: $email,
token: $token
) {
id
authToken
uuid
}
}
Variables
{
"email": "xyz789",
"token": "abc123"
}
Response
{
"data": {
"activateAccount": {
"id": 123,
"authToken": "xyz789",
"uuid": "xyz789"
}
}
}
addToWatchLater
Description
🔐 You must have the following permissions to query this field:
- watchLater: update
Example
Query
mutation AddToWatchLater(
$mediaID: Int,
$movieID: Int,
$seriesID: Int
) {
addToWatchLater(
mediaID: $mediaID,
movieID: $movieID,
seriesID: $seriesID
)
}
Variables
{"mediaID": 123, "movieID": 123, "seriesID": 123}
Response
{"data": {"addToWatchLater": false}}
appleLogin
Response
Returns a Login
Arguments
| Name | Description |
|---|---|
token -
String! | The token given by Apple's login process |
device -
AppleLoginDevice | |
register
-
AppleLoginRegisterInput |
Example
Query
mutation AppleLogin(
$token: String!,
$device: AppleLoginDevice,
$register: AppleLoginRegisterInput
) {
appleLogin(
token: $token,
device: $device,
register: $register
) {
authToken
id
uuid
verified
registerType
}
}
Variables
{
"token": "abc123",
"device": "web",
"register": AppleLoginRegisterInput
}
Response
{
"data": {
"appleLogin": {
"authToken": "xyz789",
"id": "xyz789",
"uuid": "xyz789",
"verified": false,
"registerType": 987
}
}
}
cancelContract
Description
Cancels the given contract of the authenticated user
Response
Returns a
CancelContract
Example
Query
mutation CancelContract(
$contractID: Int!,
$remarkMessage: String
) {
cancelContract(
contractID: $contractID,
remarkMessage: $remarkMessage
) {
success
}
}
Variables
{
"contractID": 123,
"remarkMessage": "abc123"
}
Response
{"data": {"cancelContract": {"success": true}}}
changePassword
Response
Returns a
changePassword
Example
Query
mutation ChangePassword(
$email: String!,
$password: String!,
$passwordToken: String!
) {
changePassword(
email: $email,
password: $password,
passwordToken: $passwordToken
) {
success
}
}
Variables
{
"email": "xyz789",
"password": "xyz789",
"passwordToken": "xyz789"
}
Response
{"data": {"changePassword": {"success": true}}}
checkDiscountCode
Description
Checks whether the logged in user can apply the specified discount code to the specified plan.
🔐 You must have the following permissions to query this field:
- discountCode: read
The channel must have the discountCode feature enabled to query this field.
Response
Returns a
DiscountCodeCheckResult
Example
Query
mutation CheckDiscountCode(
$discountCode: String!,
$planID: Int!
) {
checkDiscountCode(
discountCode: $discountCode,
planID: $planID
) {
status
appliedDiscount {
discountCode {
...DiscountCodeFragment
}
plan {
...PlanFragment
}
discountedPlanPrice
}
}
}
Variables
{"discountCode": "abc123", "planID": 123}
Response
{
"data": {
"checkDiscountCode": {
"status": "ok",
"appliedDiscount": AppliedDiscountInfo
}
}
}
createComment
Description
Creates a comment.
🔐 You must have the following permissions to query this field:
- comment: create
The channel must have the vlogs feature enabled to query this field.
Response
Returns a
CreateCommentType
Example
Query
mutation CreateComment(
$vlogSlug: String!,
$body: String!,
$parent: Int
) {
createComment(
vlogSlug: $vlogSlug,
body: $body,
parent: $parent
) {
type
id
success
}
}
Variables
{
"vlogSlug": "xyz789",
"body": "xyz789",
"parent": 123
}
Response
{
"data": {
"createComment": {
"type": "abc123",
"id": 123,
"success": false
}
}
}
createPurchaseTransaction
Description
Creates contract/transaction entities in the database to prepare for a payment by the requested PSP
Response
Returns a
PurchasePlan
Arguments
| Name | Description |
|---|---|
plans -
[Int]! | |
paymentServiceProvider
-
ProviderEnumType! | |
paymentMethod
-
PSPMethodValueType! | |
options
-
PurchaseOptions |
Example
Query
mutation CreatePurchaseTransaction(
$plans: [Int]!,
$paymentServiceProvider: ProviderEnumType!,
$paymentMethod: PSPMethodValueType!,
$options: PurchaseOptions
) {
createPurchaseTransaction(
plans: $plans,
paymentServiceProvider: $paymentServiceProvider,
paymentMethod: $paymentMethod,
options: $options
) {
transaction {
id
amountInCents
currency
provider
method
status
reason
contracts {
...ContractListFragment
}
}
detail {
... on PaymentIntentDetail {
...PaymentIntentDetailFragment
}
... on SetupIntentDetail {
...SetupIntentDetailFragment
}
}
}
}
Variables
{
"plans": [123],
"paymentServiceProvider": "cardGate",
"paymentMethod": "Bancontact",
"options": PurchaseOptions
}
Response
{
"data": {
"createPurchaseTransaction": {
"transaction": Transaction,
"detail": PaymentIntentDetail
}
}
}
deleteComment
Description
Deletes a comment. Requires anyComment.delete permission when deleting a comment of another user.
🔐 You must have the following permissions to query this field:
- comment: delete
The channel must have the vlogs feature enabled to query this field.
Response
Returns a
DeleteCommentType
Example
Query
mutation DeleteComment(
$vlogSlug: String,
$id: Int!
) {
deleteComment(
vlogSlug: $vlogSlug,
id: $id
) {
success
}
}
Variables
{"vlogSlug": "xyz789", "id": 987}
Response
{"data": {"deleteComment": {"success": false}}}
deleteUser
facebookRegister
Response
Returns a Login!
Arguments
| Name | Description |
|---|---|
accessToken
-
String! | An access token gained from Facebook to authenticate a user with our Facebook app |
place -
Place | |
newsletterSubscribed
-
Boolean | |
deviceType
-
DeviceEnum | |
resendActivation
-
Boolean | Whether the activation mail should be sent if the user's email is not validated yet |
Example
Query
mutation FacebookRegister(
$accessToken: String!,
$place: Place,
$newsletterSubscribed: Boolean,
$deviceType: DeviceEnum,
$resendActivation: Boolean
) {
facebookRegister(
accessToken: $accessToken,
place: $place,
newsletterSubscribed: $newsletterSubscribed,
deviceType: $deviceType,
resendActivation: $resendActivation
) {
authToken
id
uuid
verified
registerType
}
}
Variables
{
"accessToken": "xyz789",
"place": Place,
"newsletterSubscribed": true,
"deviceType": "standard",
"resendActivation": false
}
Response
{
"data": {
"facebookRegister": {
"authToken": "xyz789",
"id": "xyz789",
"uuid": "abc123",
"verified": true,
"registerType": 123
}
}
}
forgotPassword
Response
Returns a
ForgotPassword
Arguments
| Name | Description |
|---|---|
email -
String! |
Example
Query
mutation ForgotPassword($email: String!) {
forgotPassword(email: $email) {
success
}
}
Variables
{"email": "abc123"}
Response
{"data": {"forgotPassword": {"success": false}}}
logAdPlayout
Response
Returns a
LogAdPlayout
Arguments
| Name | Description |
|---|---|
info -
AdPlayoutInfoInput! |
Example
Query
mutation LogAdPlayout($info: AdPlayoutInfoInput!) {
logAdPlayout(info: $info) {
success
}
}
Variables
{"info": AdPlayoutInfoInput}
Response
{"data": {"logAdPlayout": {"success": false}}}
login
Response
Returns a Login
Example
Query
mutation Login(
$username: String!,
$password: String!,
$resendActivation: Boolean
) {
login(
username: $username,
password: $password,
resendActivation: $resendActivation
) {
authToken
id
uuid
verified
registerType
}
}
Variables
{
"username": "xyz789",
"password": "xyz789",
"resendActivation": true
}
Response
{
"data": {
"login": {
"authToken": "xyz789",
"id": "abc123",
"uuid": "abc123",
"verified": true,
"registerType": 123
}
}
}
logout
register
Response
Returns a
Register
Example
Query
mutation Register(
$email: String!,
$firstName: String!,
$lastName: String!,
$password: String!,
$newsletterSubscribed: Boolean!,
$acceptedTerms: Boolean!,
$countryCode: Countries,
$language: Languages,
$place: Place,
$deviceType: DeviceEnum
) {
register(
email: $email,
firstName: $firstName,
lastName: $lastName,
password: $password,
newsletterSubscribed: $newsletterSubscribed,
acceptedTerms: $acceptedTerms,
countryCode: $countryCode,
language: $language,
place: $place,
deviceType: $deviceType
) {
authToken
id
uuid
verified
}
}
Variables
{
"email": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"password": "abc123",
"newsletterSubscribed": false,
"acceptedTerms": false,
"countryCode": "AF",
"language": "en",
"place": Place,
"deviceType": "standard"
}
Response
{
"data": {
"register": {
"authToken": "abc123",
"id": 987,
"uuid": "abc123",
"verified": false
}
}
}
registerDevice
Description
Registers the authenticated user's device so that it may receive notifcations
Response
Returns a
RegisterDevice!
Arguments
| Name | Description |
|---|---|
token -
String! | |
deviceType
-
DeviceEnum! |
Example
Query
mutation RegisterDevice(
$token: String!,
$deviceType: DeviceEnum!
) {
registerDevice(
token: $token,
deviceType: $deviceType
) {
success
}
}
Variables
{
"token": "xyz789",
"deviceType": "standard"
}
Response
{"data": {"registerDevice": {"success": false}}}
removeFromWatchLater
Description
🔐 You must have the following permissions to query this field:
- watchLater: update
Example
Query
mutation RemoveFromWatchLater(
$mediaID: Int,
$movieID: Int,
$seriesID: Int
) {
removeFromWatchLater(
mediaID: $mediaID,
movieID: $movieID,
seriesID: $seriesID
)
}
Variables
{"mediaID": 123, "movieID": 987, "seriesID": 987}
Response
{"data": {"removeFromWatchLater": false}}
requestUserDeletion
Response
Returns a
Boolean
Example
Query
mutation RequestUserDeletion {
requestUserDeletion
}
Response
{"data": {"requestUserDeletion": false}}
storeMediaProgress
Example
Query
mutation StoreMediaProgress(
$mediaID: Int!,
$progress: Int!,
$watched: Boolean!
) {
storeMediaProgress(
mediaID: $mediaID,
progress: $progress,
watched: $watched
)
}
Variables
{"mediaID": 123, "progress": 123, "watched": true}
Response
{"data": {"storeMediaProgress": true}}
submitUserMedia
Description
🔐 You must have the following permissions to query this field:
- userMedia: create
Response
Returns a
SubmitUserMedia
Example
Query
mutation SubmitUserMedia(
$title: String!,
$description: String,
$key: String,
$libraryCategory: Int!,
$duration: Int!,
$deviceType: DeviceEnum!
) {
submitUserMedia(
title: $title,
description: $description,
key: $key,
libraryCategory: $libraryCategory,
duration: $duration,
deviceType: $deviceType
) {
success
}
}
Variables
{
"title": "xyz789",
"description": "xyz789",
"key": "xyz789",
"libraryCategory": 123,
"duration": 123,
"deviceType": "standard"
}
Response
{"data": {"submitUserMedia": {"success": false}}}
tokenLogin
Description
Token login for external login methods
Example
Query
mutation TokenLogin($token: String!) {
tokenLogin(token: $token) {
authToken
id
uuid
verified
registerType
}
}
Variables
{"token": "xyz789"}
Response
{
"data": {
"tokenLogin": {
"authToken": "abc123",
"id": "abc123",
"uuid": "abc123",
"verified": true,
"registerType": 987
}
}
}
unregisterDevice
Description
Unregisters the authenticated user's device so that it won't receive notifcations anymore
Response
Returns an
UnregisterDevice!
Arguments
| Name | Description |
|---|---|
token -
String! | |
deviceType
-
DeviceEnum! |
Example
Query
mutation UnregisterDevice(
$token: String!,
$deviceType: DeviceEnum!
) {
unregisterDevice(
token: $token,
deviceType: $deviceType
) {
success
}
}
Variables
{
"token": "xyz789",
"deviceType": "standard"
}
Response
{"data": {"unregisterDevice": {"success": true}}}
updateComment
Description
Updates a comment. Requires anyComment.update permission when updating a comment of another user.
🔐 You must have the following permissions to query this field:
- comment: update
The channel must have the vlogs feature enabled to query this field.
Response
Returns an
UpdateCommentType
Example
Query
mutation UpdateComment(
$vlogSlug: String!,
$body: String!,
$id: Int!
) {
updateComment(
vlogSlug: $vlogSlug,
body: $body,
id: $id
) {
success
}
}
Variables
{
"vlogSlug": "abc123",
"body": "xyz789",
"id": 123
}
Response
{"data": {"updateComment": {"success": true}}}
updateUser
Response
Returns an
UpdateUser
Arguments
| Name | Description |
|---|---|
email -
String | |
firstName
-
String! | |
lastName
-
String! | |
displayName
-
String | |
password
-
String | |
oldPassword
-
String | |
interests
-
[String] | Deprecated. Please update to interestIDs |
interestIDs
-
[Int] | |
country
-
Countries | |
language
-
Languages | |
locale -
Languages | Deprecated. Locale not used anymore |
Example
Query
mutation UpdateUser(
$email: String,
$firstName: String!,
$lastName: String!,
$displayName: String,
$password: String,
$oldPassword: String,
$interests: [String],
$interestIDs: [Int],
$country: Countries,
$language: Languages,
$locale: Languages
) {
updateUser(
email: $email,
firstName: $firstName,
lastName: $lastName,
displayName: $displayName,
password: $password,
oldPassword: $oldPassword,
interests: $interests,
interestIDs: $interestIDs,
country: $country,
language: $language,
locale: $locale
) {
user {
id
username
uuid
firstName
lastName
displayName
email
country
registerType
verified
language
interests {
...InterestFragment
}
roles
userNotificationPreferences {
...NotificationInputsFragment
}
canSubmitMedia
}
success
}
}
Variables
{
"email": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"displayName": "xyz789",
"password": "abc123",
"oldPassword": "abc123",
"interests": ["xyz789"],
"interestIDs": [123],
"country": "AF",
"language": "en",
"locale": "en"
}
Response
{
"data": {
"updateUser": {"user": ProfileType, "success": false}
}
}
updateUserNotificationPreferences
Description
Updates the authenticated user's notification preferences. Note: the userID argument is deprecated and will be ignored.
Response
Returns an
UpdateNotificationsType
Arguments
| Name | Description |
|---|---|
userID -
Int | |
newsletterSubscribed
-
NotificationBitmaskType | |
notificationNewMedia
-
NotificationBitmaskType | |
notificationLivestreamScheduled
-
NotificationBitmaskType | |
notificationInvoice
-
NotificationBitmaskType |
Example
Query
mutation UpdateUserNotificationPreferences(
$userID: Int,
$newsletterSubscribed: NotificationBitmaskType,
$notificationNewMedia: NotificationBitmaskType,
$notificationLivestreamScheduled: NotificationBitmaskType,
$notificationInvoice: NotificationBitmaskType
) {
updateUserNotificationPreferences(
userID: $userID,
newsletterSubscribed: $newsletterSubscribed,
notificationNewMedia: $notificationNewMedia,
notificationLivestreamScheduled: $notificationLivestreamScheduled,
notificationInvoice: $notificationInvoice
) {
success
}
}
Variables
{
"userID": 987,
"newsletterSubscribed": NotificationBitmaskType,
"notificationNewMedia": NotificationBitmaskType,
"notificationLivestreamScheduled": NotificationBitmaskType,
"notificationInvoice": NotificationBitmaskType
}
Response
{"data": {"updateUserNotificationPreferences": {"success": true}}}
verifyTransaction
Description
Verifies the transactionID of the payment service provider and returns if the payment was successful
🔐 You must have the following permissions to query this field:
- transaction: read
Response
Returns a
Transaction
Example
Query
mutation VerifyTransaction(
$transactionID: Int!,
$providerPaymentSourceID: String
) {
verifyTransaction(
transactionID: $transactionID,
providerPaymentSourceID: $providerPaymentSourceID
) {
id
amountInCents
currency
provider
method
status
reason
contracts {
results {
...ContractFragment
}
limit
page
pageCount
resultCount
}
}
}
Variables
{
"transactionID": 123,
"providerPaymentSourceID": "xyz789"
}
Response
{
"data": {
"verifyTransaction": {
"id": 123,
"amountInCents": 987,
"currency": "USD",
"provider": "cardGate",
"method": "Bancontact",
"status": "pending",
"reason": "authSuccess",
"contracts": ContractList
}
}
}
Types
AclCrudPermissions
AclPermissions
Description
ACL permissions of various resource types
Fields
Example
{
"category": AclCrudPermissions,
"comment": AclCrudPermissions,
"contentPage": AclCrudPermissions,
"contract": AclCrudPermissions,
"discountCode": AclCrudPermissions,
"episode": AclCrudPermissions,
"extra": AclCrudPermissions,
"genre": AclCrudPermissions,
"interest": AclCrudPermissions,
"libraryCategory": AclCrudPermissions,
"media": AclCrudPermissions,
"movie": AclCrudPermissions,
"overlay": AclCrudPermissions,
"plan": AclCrudPermissions,
"product": AclCrudPermissions,
"season": AclCrudPermissions,
"series": AclCrudPermissions,
"slide": AclCrudPermissions,
"slider": AclCrudPermissions,
"transaction": AclCrudPermissions,
"userMedia": AclCrudPermissions,
"vlog": AclCrudPermissions,
"watchLater": AclCrudPermissions,
"analytics": AclCrudPermissions,
"anyComment": AclCrudPermissions,
"chatModeration": AclCrudPermissions,
"file": AclCrudPermissions,
"mediaSpritesheets": AclCrudPermissions,
"mediaSubtitles": AclCrudPermissions,
"purchase": AclCrudPermissions,
"uiBuilder": AclCrudPermissions,
"usageReport": AclCrudPermissions,
"user": AclCrudPermissions,
"userDisplayName": AclCrudPermissions,
"settings": AclCrudPermissions,
"subscription": AclCrudPermissions,
"timeline": AclCrudPermissions
}
ActivateAccount
ActiveDirectoryLoginSettings
Description
Settings for the ActiveDirectoryLogin feature
Example
{
"enabled": true,
"tenant": "abc123",
"clientID": "xyz789",
"clientSecret": "abc123"
}
AdErrorInput
Fields
| Input Field | Description |
|---|---|
errorCode
-
Int | |
errorMessage
-
String | |
errorType
-
AdErrorTypeEnum |
Example
{
"errorCode": 123,
"errorMessage": "xyz789",
"errorType": "LOAD"
}
AdErrorTypeEnum
Description
Ad Error Type
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"LOAD"
AdEventTypeEnum
Description
Ad Event Type
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"AD_BREAK_ENDED"
AdOptionsInput
AdPlayoutInfoInput
Description
Form input for logging an advertisement playout
Fields
| Input Field | Description |
|---|---|
isRequested
-
Boolean | Whether the advertisement playout has been requested by the Tradecast SPA |
adType -
AdTypeEnum | |
hasLoaded
-
Boolean | |
adUrl -
String | |
error -
AdErrorInput | |
hasPlayed
-
Boolean | |
hasStopped
-
Boolean | |
isSkipped
-
Boolean | |
isDiscarded
-
Boolean | Whether the advertisement playout has been discared, e.g. by dismissing the PiP (Picture-in-Picture) |
userIsInAdFreePeriod
-
Boolean | |
options
-
AdOptionsInput | |
overlayID
-
Int | |
mediaID
-
Int | |
appVersion
-
String | |
userAgent
-
String | |
adEvents
-
[AdEventTypeEnum] |
Example
{
"isRequested": false,
"adType": "preRoll",
"hasLoaded": false,
"adUrl": "xyz789",
"error": AdErrorInput,
"hasPlayed": false,
"hasStopped": false,
"isSkipped": true,
"isDiscarded": false,
"userIsInAdFreePeriod": true,
"options": AdOptionsInput,
"overlayID": 987,
"mediaID": 987,
"appVersion": "xyz789",
"userAgent": "xyz789",
"adEvents": ["AD_BREAK_ENDED"]
}
AdProviderEnum
Description
Supported Ad providers
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"ImproveDigital"
AdTypeEnum
Description
Ad Type
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"preRoll"
AnalyticsSettings
Fields
| Field Name | Description |
|---|---|
trackingID
-
String |
Example
{"trackingID": "xyz789"}
AppStateEnum
Description
App state
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"ok"
AppUIComponentBlock
Description
An App Block UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentBlockProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentBlockProps
}
AppUIComponentBlockProps
AppUIComponentCategoryMediaCollection
Description
A CategoryMediaCollection UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentCategoryMediaCollectionProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentCategoryMediaCollectionProps
}
AppUIComponentCategoryMediaCollectionProps
Description
A CategoryMediaCollection UI component's props
Example
{
"canShowMore": true,
"isHorizontal": true,
"title": "xyz789",
"showCollectionHeader": true,
"categoryID": 123,
"cardClassName": "abc123",
"headerClassName": "xyz789"
}
AppUIComponentCategoryThumbCollection
Description
A CategoryThumbCollection UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentCategoryThumbCollectionProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentCategoryThumbCollectionProps
}
AppUIComponentCategoryThumbCollectionProps
Description
A CategoryThumbCollection UI component's props
Example
{
"canShowMore": true,
"title": "xyz789",
"showCollectionHeader": true,
"categoryID": 123,
"cardClassName": "abc123",
"headerClassName": "xyz789"
}
AppUIComponentContinueWatching
Description
Continue watching UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentContinueWatchingProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentContinueWatchingProps
}
AppUIComponentContinueWatchingProps
AppUIComponentImage
Description
An Image UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentImageProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentImageProps
}
AppUIComponentImageProps
Description
An Image UI component's props
Fields
| Field Name | Description |
|---|---|
src -
String! | |
resizeMode
-
AppUIComponentImageResizeModeEnumType! | |
className
-
String |
Example
{
"src": "abc123",
"resizeMode": "contain",
"className": "xyz789"
}
AppUIComponentImageResizeModeEnumType
Description
Possible different values of an Image UI component's resizeMode prop
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
|
Example
"contain"
AppUIComponentMarketingSlider
Description
A MarketingSlider UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentMarketingSliderProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentMarketingSliderProps
}
AppUIComponentMarketingSliderProps
AppUIComponentMediaCollection
Description
A MediaCollection UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentMediaCollectionProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentMediaCollectionProps
}
AppUIComponentMediaCollectionProps
Description
A MediaCollection UI component's props
Example
{
"type": "popular",
"canShowMore": true,
"isHorizontal": false,
"title": "xyz789",
"showCollectionHeader": true,
"cardClassName": "abc123",
"headerClassName": "xyz789"
}
AppUIComponentMediaCollectionPropsTypePropertyEnum
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"popular"
AppUIComponentOndemandCollection
Description
An OndemandCollection UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIOndemandCollectionProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": AppUIOndemandCollectionProps
}
AppUIComponentText
Description
A Text UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentTextProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentTextProps
}
AppUIComponentTextProps
Description
A Text UI component's props
Fields
| Field Name | Description |
|---|---|
text -
String! | |
className
-
String | |
type -
AppUIComponentTextTypeEnum! |
Example
{
"text": "xyz789",
"className": "abc123",
"type": "paragraph"
}
AppUIComponentTextTypeEnum
Description
Possible different values of a Text UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"paragraph"
AppUIComponentTimelinePlayButton
AppUIComponentTimelineSchedule
Description
An App Timeline Schedule UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
AppUIComponentTimelineScheduleProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": AppUIComponentTimelineScheduleProps
}
AppUIComponentTimelineScheduleProps
Description
An App Timeline Schedule UI component's props
Example
{
"isHorizontal": true,
"showCollectionHeader": true,
"title": "xyz789",
"cardClassName": "abc123",
"headerClassName": "abc123",
"type": "compact"
}
AppUIComponentTimelineScheduleTypeEnum
Description
Possible different values of a Timeline Schedule UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"compact"
AppUIOndemandCollectionProps
AppleLoginDevice
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"web"
AppleLoginRegisterInput
AppleSettings
Description
The channel's Apple settings
Fields
| Field Name | Description |
|---|---|
teamID -
String! | |
appBundleID
-
String | |
signIn -
SignInWithAppleSettings! |
Example
{
"teamID": "xyz789",
"appBundleID": "xyz789",
"signIn": SignInWithAppleSettings
}
AppliedDiscount
Description
Information about an applied discount on an existing contract
Fields
| Field Name | Description |
|---|---|
discountCode
-
DiscountCode! | The discount code that was used to apply the discount 🔐 You must have the following permissions to query this field:
|
appliedDiscountInCents
-
Int! | The applied discount in cents |
currency
-
CurrencyEnum! | Currency of the applied discount |
Example
{
"discountCode": DiscountCode,
"appliedDiscountInCents": 987,
"currency": "USD"
}
AppliedDiscountInfo
Description
Information about a discount applied to a plan
Fields
| Field Name | Description |
|---|---|
discountCode
-
DiscountCode! | The discount code that was used to apply the discount 🔐 You must have the following permissions to query this field:
|
plan -
Plan! | The plan to which the discount is applied 🔐 You must have the following permissions to query this field:
|
discountedPlanPrice
-
Int! | The new price of the plan after the discount is applied. The price is multiplied by 10 to the power of decimal places the currency of the plan has (e.g. Currency being EUR/USD and price 101 stands for € 1.01) |
Example
{
"discountCode": DiscountCode,
"plan": Plan,
"discountedPlanPrice": 123
}
AutomatedTradingEnabledEnum
Description
Possible types of automated trading setting
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"inherit"
AutomatedTradingFeatureSettings
Description
Settings for the Automated Trading feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Automated Trading feature is enabled |
provider
-
AdProviderEnum | Ad provider |
webUrl -
String | Web placement base Url |
mobileUrl
-
String | Mobile placement base Url |
ctvUrl -
String | Ctv placement base Url |
Example
{
"enabled": false,
"provider": "ImproveDigital",
"webUrl": "xyz789",
"mobileUrl": "abc123",
"ctvUrl": "xyz789"
}
AutomatedTradingType
B2btvFeatureSettings
Description
Settings for the B2B TV feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the B2B TV feature is enabled |
Example
{"enabled": false}
BookBuyEnum
Description
Either book or buy
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"buy"
Boolean
Description
The Boolean scalar type represents
true or false.
Example
true
BroadcastFeatureSettingsType
Description
Settings for the broadcasting feature
Example
{"enabled": true, "basicLimit": 123, "premiumLimit": 987}
CancelContract
Description
Feedback given when canceling a contract
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": true}
Category
Description
A category aggregates media related to a subject
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
showMainMenu
-
Boolean! | Whether the category is shown in the hamburger menu or footer (dependant on channel layout) |
slug -
String! | |
automatedTrading
-
AutomatedTradingEnabledEnum! | |
description
-
String | |
thumbnail
-
String | |
Arguments | |
parent -
Category | 🔐 You must have the following permissions to query this field:
|
children
-
[Category!] | 🔐 You must have the following permissions to query this field:
|
mediaList
-
MediaList | |
Arguments
| |
vlogList
-
VlogList | Gets the vlog list for this category. The channel must have the vlogs feature enabled to query this field. |
Arguments | |
Example
{
"id": 123,
"title": "abc123",
"showMainMenu": true,
"slug": "abc123",
"automatedTrading": "inherit",
"description": "xyz789",
"thumbnail": "abc123",
"parent": Category,
"children": [Category],
"mediaList": MediaList,
"vlogList": VlogList
}
CategoryFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Fields
| Input Field | Description |
|---|---|
id -
[Int] | Category ID |
title -
[String] | Category title |
showMainMenu
-
Boolean | True or false based on whether the category shows in the main menu (0 = false, 1 = true) |
categoryType
-
CategoryTypes | Category type by name |
slug -
[String] | Category slug |
Example
{
"id": [123],
"title": ["xyz789"],
"showMainMenu": true,
"categoryType": "vlog",
"slug": ["abc123"]
}
CategoryFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
CategoryFieldType | Filters on equality |
neq -
CategoryFieldType | Filters on non-equality |
gt -
CategoryFieldType | Filters on greater than |
lt -
CategoryFieldType | Filters on less than |
like -
CategoryFieldType | Filters on string similarity |
nlike -
CategoryFieldType | Filters on non-string similarity |
Example
{
"search": "abc123",
"eq": CategoryFieldType,
"neq": CategoryFieldType,
"gt": CategoryFieldType,
"lt": CategoryFieldType,
"like": CategoryFieldType,
"nlike": CategoryFieldType
}
CategoryList
Description
A wrapper with pagination data for the category list
Fields
| Field Name | Description |
|---|---|
results
-
[Category!] | 🔐 You must have the following permissions to query this field:
|
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [Category],
"limit": 123,
"page": 987,
"pageCount": 987,
"resultCount": 123
}
CategorySort
CategoryTypes
Description
Category type to filter on
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"vlog"
ChannelInfo
Description
Represents the info connected to a channel
Fields
| Field Name | Description |
|---|---|
name -
String | |
description
-
String | |
channelType
-
ChannelTypeEnum! |
Example
{
"name": "abc123",
"description": "abc123",
"channelType": "generic"
}
ChannelProtectedReasonEnum
Description
Possible reasons the channel may be protected
Values
| Enum Value | Description |
|---|---|
|
Example
"geoblocked"
ChannelTypeEnum
Description
Type of channel
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"generic"
ChaptersFeatureSettings
Description
Settings for the Chapters feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Chapters feature is enabled |
Example
{"enabled": true}
ChaptersVttTrack
Description
A WebVTT track to define chapters in media
Example
{
"id": 123,
"media": Media,
"label": "abc123",
"url": "abc123",
"type": "metadata",
"language": "xyz789"
}
CommentFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Fields
| Input Field | Description |
|---|---|
id -
[Int] | Comment item ID |
status -
[CommentStatusEnum] | Comment status |
parent -
[Int] | Comment's parent ID |
body -
[String] | Comment body |
Example
{
"id": [123],
"status": ["standard"],
"parent": [987],
"body": ["xyz789"]
}
CommentFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
CommentFieldType | Filters on equality |
neq -
CommentFieldType | Filters on non-equality |
gt -
CommentFieldType | Filters on greater than |
lt -
CommentFieldType | Filters on less than |
like -
CommentFieldType | Filters on string similarity |
nlike -
CommentFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": CommentFieldType,
"neq": CommentFieldType,
"gt": CommentFieldType,
"lt": CommentFieldType,
"like": CommentFieldType,
"nlike": CommentFieldType
}
CommentList
Description
Comment list wrapper
Fields
| Field Name | Description |
|---|---|
results
-
[CommentType!] | |
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [CommentType],
"limit": 987,
"page": 987,
"pageCount": 123,
"resultCount": 123
}
CommentSort
CommentStatusEnum
Description
Possible comment statuses
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
|
Example
"standard"
CommentType
Description
A vlog's comment
Fields
| Field Name | Description |
|---|---|
parent -
Int | |
user -
UserInfo | |
createdAt
-
DateTime | |
updatedAt
-
DateTime | |
childCount
-
Int | |
children
-
[CommentType!] | |
id -
Int! | |
body -
String! | |
status -
CommentStatusEnum |
Example
{
"parent": 987,
"user": UserInfo,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"childCount": 987,
"children": [CommentType],
"id": 987,
"body": "abc123",
"status": "standard"
}
ContentEnum
Description
Possible different content types
Values
| Enum Value | Description |
|---|---|
| YouTube is no longer supported |
| |
| |
| |
| |
| |
|
Example
"youtube"
ContentPageEnum
Description
Possible types of content page
Values
| Enum Value | Description |
|---|---|
| A standard content page |
| A content page for displaying the channel's disclaimer |
| A content page for displaying the channel's terms and conditions |
| A content page that is used to show a splash screen to visitors as a call to register |
| A content page for displaying the channel's privacy policy |
Example
"standard"
ContentPageType
Description
Describes a HTML page to be shown to the users
Fields
| Field Name | Description |
|---|---|
id -
Int | |
title -
String | |
body -
String | |
device -
DeviceEnum | |
displayLoggedin
-
ContentPermissionsEnum | |
urlPath
-
String | |
publishStart
-
DateTime | |
showMainMenu
-
Boolean | |
type -
ContentPageEnum |
Example
{
"id": 987,
"title": "xyz789",
"body": "abc123",
"device": "standard",
"displayLoggedin": "all",
"urlPath": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"showMainMenu": true,
"type": "standard"
}
ContentPagesFeatureSettings
Description
Settings for the content pages feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the content pages feature is enabled |
Example
{"enabled": false}
ContentPermissionsEnum
Description
Possible types of content page permission
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"all"
Contract
Description
Represents a plan purchase made by a user
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
status -
ContractStatusEnum! | |
plan -
Plan | 🔐 You must have the following permissions to query this field:
|
currency
-
CurrencyEnum! | |
priceInCents
-
Int! | |
priceInCentsIncludingTax
-
Int! | |
taxRate
-
Int! | |
originalPriceInCents
-
Int! | |
isTrial
-
Boolean! | |
startDate
-
DateTime! | |
endDate
-
DateTime | |
interval
-
SubscriptionIntervalEnum | |
intervalValue
-
Int! | |
billingInterval
-
SubscriptionIntervalEnum | |
appliedDiscount
-
AppliedDiscount | The channel must have the discountCode feature enabled to query this field. |
Example
{
"id": 123,
"status": "active",
"plan": Plan,
"currency": "USD",
"priceInCents": 987,
"priceInCentsIncludingTax": 987,
"taxRate": 987,
"originalPriceInCents": 987,
"isTrial": true,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"interval": "day",
"intervalValue": 123,
"billingInterval": "day",
"appliedDiscount": AppliedDiscount
}
ContractFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Example
{"id": [987], "active": true, "isTrial": false, "productID": 987, "planID": 123}
ContractFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
status -
[ContractStatusEnum] | Filter contracts on certain statuses |
eq -
ContractFieldType | Filters on equality |
neq -
ContractFieldType | Filters on non-equality |
gt -
ContractFieldType | Filters on greater than |
lt -
ContractFieldType | Filters on less than |
like -
ContractFieldType | Filters on string similarity |
nlike -
ContractFieldType | Filter on non-string similarity |
Example
{
"search": "xyz789",
"status": ["active"],
"eq": ContractFieldType,
"neq": ContractFieldType,
"gt": ContractFieldType,
"lt": ContractFieldType,
"like": ContractFieldType,
"nlike": ContractFieldType
}
ContractList
Description
A wrapper with pagination data for the contract list
Fields
| Field Name | Description |
|---|---|
results
-
[Contract!] | 🔐 You must have the following permissions to query this field:
|
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [Contract],
"limit": 987,
"page": 987,
"pageCount": 123,
"resultCount": 123
}
ContractSort
ContractStatusEnum
Description
Possible contract statuses
Values
| Enum Value | Description |
|---|---|
| |
| When the customer has not terminated the contract, but has no access to services provided by contract. |
| When the customer has terminated the contract, but the end date has not been reached yet. |
| When the contract reached its end date, regardless of it being terminated by the customer. |
Example
"active"
Countries
Description
An ISO 3166-1 alpha-2 country code
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"AF"
CreateCommentType
Credentials
CurrencyEnum
Description
Supported currencies
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"USD"
DashFileType
DashFileTypePublic
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z,
compliant with the date-time format outlined in
section 5.6 of the RFC 3339 profile of the ISO 8601 standard
for representation of dates and times using the Gregorian
calendar.
Example
"2007-12-03T10:15:30Z"
DeleteCommentType
Description
Feedback after deleting a comment
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": true}
DeviceEnum
Description
Possible different devices
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"standard"
DiscountCode
Description
A discount code
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
code -
String! | |
type -
DiscountTypeEnum! | |
currency
-
CurrencyEnum | |
amount -
Int | |
percentage
-
Float |
Example
{
"id": 123,
"code": "xyz789",
"type": "flat",
"currency": "USD",
"amount": 987,
"percentage": 123.45
}
DiscountCodeCheckResult
Description
The result of a discount code check
Fields
| Field Name | Description |
|---|---|
status -
DiscountCodeCheckStatus! | |
appliedDiscount
-
AppliedDiscountInfo | Information about the discount that would be applied to the plan if the discount code is used. Only returned if status is Ok. |
Example
{"status": "ok", "appliedDiscount": AppliedDiscountInfo}
DiscountCodeCheckStatus
Description
The resulting status of a discount code check
Values
| Enum Value | Description |
|---|---|
| The discount code can be applied to the specified plan. |
| The discount code has a maximum number of times it can be used. This limit has been reached, so it can't be used anymore. |
| The discount code has expired. |
| The discount code cannot be applied to the specified plan, but may be valid for others. |
| The discount code has been discontinued. It can't be used anymore. |
| The discount code is invalid. It cannot be applied for any plan. |
Example
"ok"
DiscountCodeFeatureSettings
Description
Settings for the Discount Code feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Discount Code feature is enabled |
Example
{"enabled": true}
DiscountTypeEnum
Description
Possible different discount types
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"flat"
DrmFeatureSettings
ElearningFeatureSettings
Description
Settings for the eLearning feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the eLearning feature is enabled |
Example
{"enabled": true}
Episode
Description
An episode of a Series. Grouped with other Episodes inside a Season.
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
publishStart
-
DateTime! | |
publishEnd
-
DateTime | |
releaseDate
-
DateTime | |
posterImage
-
String! | |
Arguments | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
trailer
-
Media | 🔐 You must have the following permissions to query this field:
|
season -
Season! | 🔐 You must have the following permissions to query this field:
|
extras -
[Extra!]! | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 123,
"title": "xyz789",
"description": "xyz789",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"posterImage": "xyz789",
"media": Media,
"trailer": Media,
"season": Season,
"extras": [Extra]
}
Extra
Description
Extra video content outside the main content of a movie or series. For example: teasers, trailers, recaps, behind-the-scenes footage, and bloopers.
Example
{
"id": 123,
"title": "xyz789",
"media": Media
}
FacebookDetails
FeaturesSettings
Description
Settings and enabled status for toggleable features
Fields
Example
{
"premiumContent": PremiumContentFeatureSettings,
"svod": SvodFeatureSettings,
"elearning": ElearningFeatureSettings,
"b2btv": B2btvFeatureSettings,
"automatedTrading": AutomatedTradingFeatureSettings,
"subtitles": SubtitlesFeatureSettings,
"chapters": ChaptersFeatureSettings,
"metadata": MetadataFeatureSettings,
"geoblocking": GeoblockingFeatureSettings,
"ticketCode": TicketCodeFeatureSettings,
"discountCode": DiscountCodeFeatureSettings,
"submitMedia": SubmitMediaSettings,
"activeDirectoryLogin": ActiveDirectoryLoginSettings,
"uiBuilder": UIBuilderFeatureSettings,
"liveChat": LiveChatFeatureSettings,
"marketingSliders": MarketingSlidersFeatureSettings,
"drm": DrmFeatureSettings,
"liveTimeshifting": LiveTimeshiftingFeatureSettings,
"sentry": SentryFeatureSettings,
"tvApp": TvAppFeatureSettings,
"vlogs": VlogsFeatureSettings,
"contentPages": ContentPagesFeatureSettings,
"timeline": TimelineFeatureSettings,
"frontendUser": FrontendUserFeatureSettings,
"broadcast": BroadcastFeatureSettingsType,
"transcribe": TranscribeFeatureSettings
}
FeedOverlayList
FileProtectedReasonEnum
Description
Possible reasons of protection for media files
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"private"
FileType
Description
A media item's files
Fields
| Field Name | Description |
|---|---|
vimeo -
VimeoFileType | |
image -
ImageFileType | |
hls -
HlsFileType | |
dash -
DashFileType | |
progressive
-
[ProgressiveFileType] | |
rtmp -
RTMPFileType |
Example
{
"vimeo": VimeoFileType,
"image": ImageFileType,
"hls": HlsFileType,
"dash": DashFileType,
"progressive": [ProgressiveFileType],
"rtmp": RTMPFileType
}
FirebaseConfig
Float
Description
The Float scalar type represents signed
double-precision fractional values as specified by
IEEE 754.
Example
123.45
ForgotPassword
Description
Feedback after using the forgot password function
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
FrontendLibraryCategory
FrontendUserFeatureSettings
Description
Settings for the frontend user feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the frontend user feature is enabled |
Example
{"enabled": true}
Genre
GenreFieldType
GenreFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
GenreFieldType | Filters on equality |
neq -
GenreFieldType | Filters on non-equality |
gt -
GenreFieldType | Filters on greater than |
lt -
GenreFieldType | Filters on less than |
like -
GenreFieldType | Filters on string similarity |
nlike -
GenreFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": GenreFieldType,
"neq": GenreFieldType,
"gt": GenreFieldType,
"lt": GenreFieldType,
"like": GenreFieldType,
"nlike": GenreFieldType
}
GenreList
Description
A wrapper with pagination data for a genre list
Example
{
"results": [Genre],
"limit": 987,
"page": 987,
"pageCount": 987,
"resultCount": 987
}
GenreListSort
Fields
| Input Field | Description |
|---|---|
field -
GenreListSortFields! | |
direction
-
Order |
Example
{"field": "id", "direction": "asc"}
GenreListSortFields
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"id"
GeoblockingFeatureSettings
Description
Settings for the Geoblocking feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Geoblocking feature is enabled |
Example
{"enabled": false}
HlsFileType
Description
Represents hls data
Fields
| Field Name | Description |
|---|---|
url -
String |
Example
{"url": "xyz789"}
HlsFileTypePublic
Description
Represents hls data (with public cacheOptions)
Fields
| Field Name | Description |
|---|---|
url -
String |
Example
{"url": "xyz789"}
ID
Description
The ID scalar type represents a unique
identifier, often used to refetch an object or as key for a
cache. The ID type appears in a JSON response as a String;
however, it is not intended to be human-readable. When
expected as an input type, any string (such as
"4") or integer (such as
4) input value will be accepted as an ID.
Example
4
ImageFileType
Description
Represents image file data
Fields
| Field Name | Description |
|---|---|
url -
String |
Example
{"url": "xyz789"}
ImageFileTypePublic
Description
Represents image file data (with public cacheOptions)
Fields
| Field Name | Description |
|---|---|
url -
String |
Example
{"url": "xyz789"}
ImageFormats
Description
Imageformats to get
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"jpg"
Int
Description
The Int scalar type represents non-fractional
signed whole numeric values. Int can represent values between
-(2^31) and 2^31 - 1.
Example
123
Interest
Description
An interest aggregates media related to a subject
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
slug -
String | |
name -
String | |
mediaList
-
MediaList | |
Arguments
| |
Example
{
"id": 987,
"slug": "xyz789",
"name": "abc123",
"mediaList": MediaList
}
InterestFieldType
InterestFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
InterestFieldType | Filters on equality |
neq -
InterestFieldType | Filters on non-equality |
gt -
InterestFieldType | Filters on greater than |
lt -
InterestFieldType | Filters on less than |
like -
InterestFieldType | Filters on string similarity |
nlike -
InterestFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": InterestFieldType,
"neq": InterestFieldType,
"gt": InterestFieldType,
"lt": InterestFieldType,
"like": InterestFieldType,
"nlike": InterestFieldType
}
InterestListType
Description
Interest list wrapper
Fields
| Field Name | Description |
|---|---|
results
-
[Interest!] | 🔐 You must have the following permissions to query this field:
|
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [Interest],
"limit": 987,
"page": 987,
"pageCount": 123,
"resultCount": 987
}
InterestSort
Issuer
IssuerArray
Description
A payment method's issuer list
Fields
| Field Name | Description |
|---|---|
issuerID
-
[Issuer] |
Example
{"issuerID": [Issuer]}
Languages
Description
Language codes
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
|
Example
"en"
LaunchScreenSettings
Description
The channel's launch screen settings
Fields
| Field Name | Description |
|---|---|
new -
LaunchScreenType | |
loggedIn
-
LaunchScreenType |
Example
{"new": "none", "loggedIn": "none"}
LaunchScreenType
Description
Possible ways to set launchscreen
Values
| Enum Value | Description |
|---|---|
| |
| |
| Call to action to register |
|
Example
"none"
Live
Description
Represents when a livestream is active
Fields
| Field Name | Description |
|---|---|
item -
TimelineItem | |
livestream
-
Livestream |
Example
{
"item": TimelineItem,
"livestream": Livestream
}
LiveChatCollection
LiveChatFeatureSettings
Description
Settings for the live chat feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the live chat feature is enabled |
Example
{"enabled": false}
LiveChatSso
Description
SSO credentials for using the firebase live chat
Fields
| Field Name | Description |
|---|---|
collection
-
LiveChatCollection! | |
userId -
String | |
writeAccess
-
Boolean! | |
nickname
-
String | |
accessToken
-
String! | |
firebaseConfig
-
FirebaseConfig! |
Example
{
"collection": LiveChatCollection,
"userId": "xyz789",
"writeAccess": false,
"nickname": "abc123",
"accessToken": "abc123",
"firebaseConfig": FirebaseConfig
}
LiveTimeshiftingFeatureSettings
Description
Settings for the Live Timeshifting feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the livestream timeshifting feature is enabled |
Example
{"enabled": false}
Livestream
Description
A livestream's info
Fields
| Field Name | Description |
|---|---|
startTime
-
Int |
Example
{"startTime": 987}
LogAdPlayout
Description
Stores a log of an advertisement playout
Fields
| Field Name | Description |
|---|---|
success
-
Boolean |
Example
{"success": true}
Login
Description
Represents the information gained after logging in
Example
{
"authToken": "abc123",
"id": "abc123",
"uuid": "abc123",
"verified": false,
"registerType": 987
}
Logout
Description
Feedback after logging out
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
MarketingSlidersFeatureSettings
Description
Settings for the marketing sliders feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the marketing sliders feature is enabled |
Example
{"enabled": false}
Media
Description
A media item that can be shown to users
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
Arguments
| |
author -
String | |
categories
-
[Category!] | The categories that this media item belongs to 🔐 You must have the following permissions to query this field:
|
products
-
ProductList! | The products that contain this media item |
createdAt
-
DateTime | |
updatedAt
-
DateTime | |
publishStart
-
DateTime | |
views -
MediaViews! | |
thumb -
String | |
Arguments | |
socialThumb
-
String | |
Arguments | |
interests
-
[Interest!] | The interests that this media item belongs to 🔐 You must have the following permissions to query this field:
|
embedURL
-
String! | |
keywords
-
[String!] | |
socialNotificationFlags
-
SocialNotificationFlags! | |
contentType
-
ContentEnum! | |
files -
FileType | |
filesProtectedReason
-
FileProtectedReasonEnum | |
duration
-
Int! | The duration of the media item in seconds |
endedPosition
-
Int! | The end position of the video in seconds. Used to determine if a user has finished watching a video |
pinned -
Boolean! | Whether this media item is marked as pinned by the channel |
private
-
Boolean! | Whether the media is private or not, so that unauthenticated users can't see it |
automatedTrading
-
AutomatedTradingType! | |
overlays
-
[Overlay!] | 🔐 You must have the following permissions to query this field:
|
vttTracks
-
[VttTrack!] | |
related
-
MediaList | |
Arguments
| |
progress
-
MediaProgress! | The authenticated user's progress on this video |
share -
MediaShare! | |
subtitles
-
MediaSubtitlesList! | |
spritesheets
-
MediaSpritesheetsList! | |
unlisted
-
Boolean | |
liveChat
-
MediaLiveChatSettings! | |
livestreamStartTime
-
DateTime | Date and time that a livestream is planned to start at. |
livestreamEndTime
-
DateTime | Date and time that a livestream is planned to end at. |
liveTimeshifting
-
Boolean! | Whether a livestream allows timeshifting (rewinding the active live stream and jumping in at an earlier point) |
parentMedia
-
Media | 🔐 You must have the following permissions to query this field:
|
childMediaList
-
MediaList | |
Arguments
| |
drmProtected
-
Boolean | Whether the media item is protected by DRM |
drmPolicy
-
String | The DRM license policy JSON as string according to the license policy specification v2.0 (https://pallycon.com/docs/en/multidrm/license/license-token/#license-policy-json) |
vmapUrl
-
String | The URL to the media item's VMAP XML. Will be null if the user shouldn't see advertisements (e.g. with an ad preventing product) |
hasGeneratedVmap
-
Boolean | Whether the media's VMAP is generated based on the media's overlays |
canonicalUrl
-
String | The canonical URL of the media item, used for SEO |
Example
{
"id": 123,
"title": "xyz789",
"description": "abc123",
"author": "abc123",
"categories": [Category],
"products": ProductList,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"publishStart": "2007-12-03T10:15:30Z",
"views": MediaViews,
"thumb": "abc123",
"socialThumb": "abc123",
"interests": [Interest],
"embedURL": "xyz789",
"keywords": ["abc123"],
"socialNotificationFlags": SocialNotificationFlags,
"contentType": "youtube",
"files": FileType,
"filesProtectedReason": "private",
"duration": 987,
"endedPosition": 987,
"pinned": false,
"private": false,
"automatedTrading": AutomatedTradingType,
"overlays": [OverlayLivestreamActive],
"vttTracks": [MetadataVttTrack],
"related": MediaList,
"progress": MediaProgress,
"share": MediaShare,
"subtitles": MediaSubtitlesList,
"spritesheets": MediaSpritesheetsList,
"unlisted": true,
"liveChat": MediaLiveChatSettings,
"livestreamStartTime": "2007-12-03T10:15:30Z",
"livestreamEndTime": "2007-12-03T10:15:30Z",
"liveTimeshifting": true,
"parentMedia": Media,
"childMediaList": MediaList,
"drmProtected": false,
"drmPolicy": "xyz789",
"vmapUrl": "abc123",
"hasGeneratedVmap": false,
"canonicalUrl": "xyz789"
}
MediaFieldType
Description
Fields that can be filtered on. Note: only the first item in the array is used for filters other than 'eq' and 'neq'
Fields
| Input Field | Description |
|---|---|
id -
[Int] | Media item ID |
categoryID
-
[Int] | Category ID |
publishStart
-
[DateTime] | Date string from the start of the publish |
contentType
-
[ContentEnum] | Media content type by ID |
featured
-
Boolean | True or false based on whether the media is featured (0 = false, 1 = true) |
amountViewsAll
-
[Int] | Total amount of views |
interestID
-
[Int] | Interest ID |
private
-
Boolean | True or false based on whether the media is private, will only work when filtering on equality |
keyword
-
[String] | Keyword on the media item, only works in ES enabled environments |
livestreamStartTime
-
DateTime | Date and time that a livestream is planned to start at. |
livestreamEndTime
-
DateTime | Date and time that a livestream is planned to end at. |
drmProtected
-
Boolean |
Example
{
"id": [123],
"categoryID": [987],
"publishStart": ["2007-12-03T10:15:30Z"],
"contentType": ["youtube"],
"featured": false,
"amountViewsAll": [123],
"interestID": [987],
"private": true,
"keyword": ["abc123"],
"livestreamStartTime": "2007-12-03T10:15:30Z",
"livestreamEndTime": "2007-12-03T10:15:30Z",
"drmProtected": false
}
MediaFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
searchFields
-
[MediaSearchField!] | Fields to use when performing a search. Will default to a predetermined set of search fields. |
eq -
MediaFieldType | Filters on equality |
neq -
MediaFieldType | Filters on non-equality |
gt -
MediaFieldType | Filters on greater than |
lt -
MediaFieldType | Filters on less than |
like -
MediaFieldType | Filters on string similarity |
nlike -
MediaFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"searchFields": [MediaSearchField],
"eq": MediaFieldType,
"neq": MediaFieldType,
"gt": MediaFieldType,
"lt": MediaFieldType,
"like": MediaFieldType,
"nlike": MediaFieldType
}
MediaList
Description
A wrapper with pagination data for the media list
Example
{
"results": [Media],
"limit": 987,
"page": 123,
"pageCount": 123,
"resultCount": 987
}
MediaListOptions
MediaLiveChatSettings
Description
Media live chat settings
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the live chat is enabled for this media item |
Example
{"enabled": false}
MediaProgress
Description
A user's progress on a media item
Example
{
"mediaID": 123,
"media": Media,
"progress": 987,
"watched": false,
"lastWatched": "2007-12-03T10:15:30Z"
}
MediaProgressFilter
Fields
| Input Field | Description |
|---|---|
watched
-
Boolean |
Example
{"watched": true}
MediaProgressList
Description
List of media progress items
Fields
| Field Name | Description |
|---|---|
results
-
[MediaProgress!]! | |
pageInfo
-
PageInfo! | Information to aid in pagination. |
Example
{
"results": [MediaProgress],
"pageInfo": PageInfo
}
MediaProgressOptions
MediaSearchField
Description
Search field input for media
Fields
| Input Field | Description |
|---|---|
field -
MediaSearchFieldsEnum! | |
boost -
Int |
Example
{"field": "title", "boost": 987}
MediaSearchFieldsEnum
Description
Searchable fields on media
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"title"
MediaSettings
MediaSort
Description
Opt-in sorting
Example
{
"id": "asc",
"category": "asc",
"publishStart": "asc",
"pinned": "asc",
"featured": "asc",
"amountViewsAll": "asc",
"amountViewsYear": "asc",
"amountViewsMonth": "asc",
"amountViewsWeek": "asc",
"livestreamStartTime": "asc",
"livestreamEndTime": "asc"
}
MediaSpritesheets
Description
A media item's spritesheets entity with the preview images that are shown when a user scrubs over the video
Example
{
"id": 123,
"sprites": 123,
"columns": 987,
"rows": 987,
"height": 987,
"width": 123,
"spriteHeight": 123,
"spriteWidth": 123,
"part": 123,
"url": "xyz789",
"type": "xyz789",
"thumb": "xyz789",
"media": Media
}
MediaSpritesheetsList
Description
A list of media spritesheets
Fields
| Field Name | Description |
|---|---|
results
-
[MediaSpritesheets!] | |
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [MediaSpritesheets],
"limit": 123,
"page": 987,
"pageCount": 987,
"resultCount": 987
}
MediaSubtitles
Description
A media item's subtitles
Example
{
"id": 123,
"label": "abc123",
"language": "abc123",
"url": "xyz789",
"media": Media
}
MediaSubtitlesList
Description
A list of media subtitles
Fields
| Field Name | Description |
|---|---|
results
-
[MediaSubtitles!] | |
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [MediaSubtitles],
"limit": 123,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
MediaTimelineInfo
Description
A timeline media item's info
Fields
| Field Name | Description |
|---|---|
offset -
Int |
Example
{"offset": 123}
MediaViews
MetadataFeatureSettings
Description
Settings for the Metadata feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Metadata feature is enabled |
Example
{"enabled": false}
MetadataVttTrack
Description
A WebVTT track to supply metadata to the player
Fields
| Field Name | Description |
|---|---|
id -
Int | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
label -
String | |
url -
String | |
type -
VttTrackTypeEnum |
Example
{
"id": 123,
"media": Media,
"label": "xyz789",
"url": "abc123",
"type": "metadata"
}
Movie
Description
A movie
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
publishStart
-
DateTime! | |
publishEnd
-
DateTime | |
releaseDate
-
DateTime | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
trailer
-
Media | 🔐 You must have the following permissions to query this field:
|
posterImage
-
String! | |
Arguments | |
genres -
[Genre!]! | 🔐 You must have the following permissions to query this field:
|
extras -
[Extra!]! | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 123,
"title": "xyz789",
"description": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"media": Media,
"trailer": Media,
"posterImage": "abc123",
"genres": [Genre],
"extras": [Extra]
}
MoviesAndSeriesFieldType
MoviesAndSeriesFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
MoviesAndSeriesFieldType | Filters on equality |
neq -
MoviesAndSeriesFieldType | Filters on non-equality |
gt -
MoviesAndSeriesFieldType | Filters on greater than |
lt -
MoviesAndSeriesFieldType | Filters on less than |
like -
MoviesAndSeriesFieldType | Filters on string similarity |
nlike -
MoviesAndSeriesFieldType | Filters on non-string similarity |
Example
{
"search": "abc123",
"eq": MoviesAndSeriesFieldType,
"neq": MoviesAndSeriesFieldType,
"gt": MoviesAndSeriesFieldType,
"lt": MoviesAndSeriesFieldType,
"like": MoviesAndSeriesFieldType,
"nlike": MoviesAndSeriesFieldType
}
MoviesAndSeriesList
Description
A wrapper with pagination data for a movies and series list
Fields
| Field Name | Description |
|---|---|
results
-
[MoviesAndSeriesUnion!] | 🔐 You must have the following permissions to query this field:
|
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [Movie],
"limit": 987,
"page": 123,
"pageCount": 987,
"resultCount": 987
}
MoviesAndSeriesListSort
Fields
| Input Field | Description |
|---|---|
field -
MoviesAndSeriesListSortFields! | |
direction
-
Order |
Example
{"field": "id", "direction": "asc"}
MoviesAndSeriesListSortFields
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"id"
MoviesAndSeriesUnion
NotificationBitmaskType
Description
An integer between 0 and 3 marking the
notification settings. 0 = no notifications; 1 =
pushnotifications; 2 = e-mail notifications; 3 = push and
e-mail notifications.
Example
NotificationBitmaskType
NotificationFlags
NotificationInputs
Description
Represents a user's notification settings
Fields
| Field Name | Description |
|---|---|
notificationNewMedia
-
NotificationBitmaskType! | Notification setting based on the bitmask value found in flags |
notificationLivestreamScheduled
-
NotificationBitmaskType! | Notification setting based on the bitmask value found in flags |
notificationInvoice
-
NotificationBitmaskType! | Notification setting based on the bitmask value found in flags |
newsletterSubscribed
-
NotificationBitmaskType! | Notification setting based on the bitmask value found in flags |
Example
{
"notificationNewMedia": NotificationBitmaskType,
"notificationLivestreamScheduled": NotificationBitmaskType,
"notificationInvoice": NotificationBitmaskType,
"newsletterSubscribed": NotificationBitmaskType
}
NotificationSettings
Description
The channel's notification settings
Fields
| Field Name | Description |
|---|---|
flags -
NotificationFlags | |
inputs -
NotificationInputs |
Example
{
"flags": NotificationFlags,
"inputs": NotificationInputs
}
OndemandCategorizationEnum
Description
Possible types of ondemand categorization
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"category"
Order
Description
Direction to filter on on said key (asc/desc)
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"asc"
Overlay
Description
An overlay which shows over a media item or the timeline
Example
OverlayLivestreamActive
OverlayAction
Description
The action of an overlay
Types
| Union Types |
|---|
Example
OverlayActionSeek
OverlayActionOpenLink
Description
Action instructing to open a URL when performed
Fields
| Field Name | Description |
|---|---|
url -
String! |
Example
{"url": "xyz789"}
OverlayActionPostMessage
Description
Action instructing to post it's message when performed
Fields
| Field Name | Description |
|---|---|
message
-
String! |
Example
{"message": "abc123"}
OverlayActionSeek
Description
Action instructing to seek to it's value when performed
Fields
| Field Name | Description |
|---|---|
time -
Float! |
Example
{"time": 987.65}
OverlayArea
Description
An overlay to show a clickable area
Fields
| Field Name | Description |
|---|---|
event -
OverlayAreaEventEnum | |
vertices
-
[Position!]! | |
action -
OverlayAction | |
image -
String | |
Arguments | |
imagePosition
-
Position! | |
id -
Int! | |
startTime
-
Float! | |
stopTime
-
Float! | |
type -
OverlayEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"event": "seek",
"vertices": [Position],
"action": OverlayActionSeek,
"image": "abc123",
"imagePosition": Position,
"id": 123,
"startTime": 987.65,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayAreaEventEnum
Description
Supported types of events for area overlays
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"seek"
OverlayAutomatedTrading
Description
An overlay of the type automated trading which shows an advertisement if the Automated Trading feature is enabled
Example
{
"id": 987,
"startTime": 123.45,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayBookBuy
Description
An overlay to show an URL to book or buy something
Fields
| Field Name | Description |
|---|---|
number -
BookBuyEnum | |
url -
String | |
id -
Int! | |
startTime
-
Float! | |
stopTime
-
Float! | |
type -
OverlayEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"number": "buy",
"url": "abc123",
"id": 987,
"startTime": 987.65,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayECommerce
Description
An overlay to show an e-commerce product
Fields
| Field Name | Description |
|---|---|
title -
String | |
url -
String | |
image -
String | |
Arguments | |
price -
Float | |
discountedPrice
-
Float | |
id -
Int! | |
startTime
-
Float! | |
stopTime
-
Float! | |
type -
OverlayEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"title": "abc123",
"url": "abc123",
"image": "abc123",
"price": 987.65,
"discountedPrice": 987.65,
"id": 987,
"startTime": 123.45,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayEnum
Description
Possible types of overlays
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"livestreamActive"
OverlayFeed
Description
Possible types of feed overlay
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"rss"
OverlayFeedData
OverlayInfo
Description
An overlay to show a text block with information
Example
{
"body": "abc123",
"id": 987,
"startTime": 987.65,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayInterfaceType
Description
Set of properties every type of overlay has
Example
{
"id": 123,
"startTime": 123.45,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayLink
Description
An overlay to show a link
Example
{
"title": "abc123",
"url": "abc123",
"icon": "abc123",
"id": 987,
"startTime": 123.45,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayLivestreamActive
Description
An overlay that shows when a livestream is active. Currently not available in the VMS, so support is limited
Example
{
"id": "xyz789",
"startTime": 987.65,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayLowerThird
Description
An overlay of the type lower third. Currently not available in the VMS, so support is limited
Example
{
"subject": "abc123",
"title": "xyz789",
"description": "xyz789",
"position": 987,
"id": 987,
"startTime": 123.45,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayMap
Description
An overlay to show a position on a map
Example
{
"zoom": 123,
"lat": 123.45,
"lng": 123.45,
"body": "abc123",
"imageUrl": "abc123",
"id": 987,
"startTime": 123.45,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayRSS
Description
An overlay to show an RSS feed
Fields
| Field Name | Description |
|---|---|
data -
OverlayFeedData | |
id -
Int! | |
startTime
-
Float! | |
stopTime
-
Float! | |
type -
OverlayEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"data": OverlayFeedData,
"id": 123,
"startTime": 123.45,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlayReact
Description
An overlay for users to add a reaction to the media using the user submitted media flow
Example
{
"id": 987,
"startTime": 987.65,
"stopTime": 123.45,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlaySeekTo
Description
An overlay to automatically seek to a specific timestamp
Example
{
"seekTime": 123.45,
"id": 987,
"startTime": 987.65,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlaySource
Description
Possible types of overlay source
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"overlay"
OverlayTwitter
Description
An overlay to show a Twitter feed
Fields
| Field Name | Description |
|---|---|
body -
String | |
data -
OverlayFeedData | |
id -
Int! | |
startTime
-
Float! | |
stopTime
-
Float! | |
type -
OverlayEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"body": "xyz789",
"data": OverlayFeedData,
"id": 123,
"startTime": 123.45,
"stopTime": 987.65,
"type": "livestreamActive",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"media": Media
}
OverlaysVttTrack
Description
A WebVTT track to supply the media's overlays
Fields
| Field Name | Description |
|---|---|
id -
Int | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
label -
String | |
url -
String | |
type -
VttTrackTypeEnum |
Example
{
"id": 987,
"media": Media,
"label": "abc123",
"url": "abc123",
"type": "metadata"
}
PSPMethodValueType
Description
Possible types of payment methods
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"Bancontact"
PageInfo
PageUIComponent
PaymentIntentDetail
Description
An intent for a direct payment
Fields
| Field Name | Description |
|---|---|
clientSecret
-
String! |
Example
{"clientSecret": "xyz789"}
PaymentMethod
Description
A payment service provider describing possible payment service providers
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
name -
String | |
type -
PSPMethodValueType | |
supportedPlanTypes
-
[PlanTypeEnum!] | |
options
-
IssuerArray |
Example
{
"id": 123,
"name": "abc123",
"type": "Bancontact",
"supportedPlanTypes": ["subscription"],
"options": IssuerArray
}
PaymentServiceProvider
Description
Info of a payment service provider enabled for this channel
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
name -
String | |
publicApiKey
-
String | |
methods
-
[PaymentMethod!] |
Example
{
"id": 987,
"name": "abc123",
"publicApiKey": "abc123",
"methods": [PaymentMethod]
}
Place
Plan
Description
A way for users to buy a product
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
product
-
Product! | 🔐 You must have the following permissions to query this field:
|
title -
String! | |
description
-
String! | |
currency
-
CurrencyEnum! | |
price -
Int! | Price multiplied by 10 to the power of decimal places the currency has (e.g. EUR/USD currency is stored in cents, so price 101 stands for €1.01) |
termsOfUse
-
String | |
renewable
-
Boolean! | |
type -
PlanTypeEnum! | |
interval
-
SubscriptionIntervalEnum | |
intervalValue
-
Int! | |
trialInterval
-
SubscriptionTrialIntervalEnum | |
trialIntervalValue
-
Int | |
trialMode
-
SubscriptionTrialModeOnlyEnum | |
trialPrice
-
Int | Price multiplied by 10 to the power of decimal places the currency has (e.g. EUR/USD currency is stored in cents, so price 101 stands for €1.01) |
status -
PlanStatusEnum! | |
createdAt
-
DateTime! | |
updatedAt
-
DateTime! | |
protectedReason
-
PlanProtectedReasonEnum | |
usages -
Int! | Amount of times this plan has been bought since tracking started, plans bought before this feature will not count towards its usages |
maxUsages
-
Int | Max amount of usages allowed for this plan, new purchases will be blocked once a plan's usages count is equal (or higher) than its max usages |
soldOut
-
Boolean! | Whether a plan will still be allowed to be purchased according to its usages |
Example
{
"id": 123,
"product": Product,
"title": "abc123",
"description": "abc123",
"currency": "USD",
"price": 987,
"termsOfUse": "xyz789",
"renewable": true,
"type": "subscription",
"interval": "day",
"intervalValue": 987,
"trialInterval": "trialDay",
"trialIntervalValue": 123,
"trialMode": "trialModeStrict",
"trialPrice": 123,
"status": "active",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"protectedReason": "geoblocked",
"usages": 123,
"maxUsages": 123,
"soldOut": false
}
PlanList
Description
A wrapper with pagination data for a plan list
Example
{
"results": [Plan],
"limit": 987,
"page": 987,
"pageCount": 123,
"resultCount": 987
}
PlanListSort
PlanProtectedReasonEnum
Description
Possible reasons a plan may be protected
Values
| Enum Value | Description |
|---|---|
|
Example
"geoblocked"
PlanStatusEnum
Description
Supported plan status values
Values
| Enum Value | Description |
|---|---|
| |
| Plan can no longer be bought, nor will contracts of it be renewed |
Example
"active"
PlanTypeEnum
Description
Supported plan types
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"subscription"
PlatformSettings
Description
A platform's page UI component
Fields
| Field Name | Description |
|---|---|
home -
[PageUIComponent] | |
ondemand
-
[PageUIComponent] | |
watch -
[PageUIComponent] |
Example
{
"home": [PageUIComponent],
"ondemand": [PageUIComponent],
"watch": [PageUIComponent]
}
PlayNextStrategyEnum
Description
Specifies behaviour of player after finishing an on demand media item
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"nextInCategory"
PlayerSettings
Description
This channel's settings for the Tradecast Player
Fields
| Field Name | Description |
|---|---|
airplay
-
Boolean | Whether AirPlay can be used |
autoSelectSubtitles
-
Boolean | Whether subtitles are automatically selected |
chromeCast
-
Boolean | Whether ChromeCast can be used |
contextMenu
-
Boolean | Whether the custom contextmenu (that shows on a right click) is shown |
doubleTapControl
-
Boolean | Whether seek backwards/forwards controls are enabled by double tapping the left/right side of the player |
mediaSession
-
Boolean | Whether the Media Session API is enabled |
pip -
Boolean | Whether PiP (Picture-in-Picture) is enabled |
playProgressTracking
-
Boolean | Whether the player sends the playback progress to the storeMediaProgress mutation or storeMediaProgress REST endpoint |
vr360 -
Boolean | Whether 360 degree (VR) videos can be played |
playNextStrategy
-
PlayNextStrategyEnum | The behaviour when a media item is done playing |
streamLogoUrl
-
String | The URL to the logo used for streams |
timelinePage
-
TimelinePageEnum | Specifies the page where the timeline should be located |
Example
{
"airplay": true,
"autoSelectSubtitles": false,
"chromeCast": true,
"contextMenu": true,
"doubleTapControl": true,
"mediaSession": true,
"pip": true,
"playProgressTracking": false,
"vr360": true,
"playNextStrategy": "nextInCategory",
"streamLogoUrl": "xyz789",
"timelinePage": "home"
}
Position
PremiumContentFeatureSettings
Description
Settings for the Premium Content feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Premium Content feature is enabled |
Example
{"enabled": true}
Product
Description
A product which aggregates media that can be bought via a plan
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
type -
ProductTypeEnum! | |
termsOfUse
-
String | |
allowSubmitMedia
-
Boolean! | Whether product owners are allowed to submit media (only used when submitMedia is productProtected) |
preventAds
-
Boolean! | Whether product owners will no longer see advertisements on the entire channel |
createdAt
-
DateTime | |
updatedAt
-
DateTime | |
plans -
PlanList | |
Arguments | |
media -
MediaList | |
Arguments | |
interests
-
InterestListType | |
Arguments | |
categories
-
CategoryList | |
Arguments | |
includedMedia
-
MediaList | |
Arguments
| |
trailer
-
Media | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 987,
"title": "xyz789",
"description": "abc123",
"type": "singularMedia",
"termsOfUse": "abc123",
"allowSubmitMedia": true,
"preventAds": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"plans": PlanList,
"media": MediaList,
"interests": InterestListType,
"categories": CategoryList,
"includedMedia": MediaList,
"trailer": Media
}
ProductCategoryFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Fields
| Input Field | Description |
|---|---|
categoryID
-
[Int] | Category aggregated by the product |
Example
{"categoryID": [123]}
ProductCategoryFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
ProductCategoryFieldType | Filters on equality |
neq -
ProductCategoryFieldType | Filters on non-equality |
gt -
ProductCategoryFieldType | Filters on greater than |
lt -
ProductCategoryFieldType | Filters on less than |
like -
ProductCategoryFieldType | Filters on string similarity |
nlike -
ProductCategoryFieldType | Filters on non-string similarity |
Example
{
"search": "abc123",
"eq": ProductCategoryFieldType,
"neq": ProductCategoryFieldType,
"gt": ProductCategoryFieldType,
"lt": ProductCategoryFieldType,
"like": ProductCategoryFieldType,
"nlike": ProductCategoryFieldType
}
ProductCategorySort
Description
Opt-in sorting
Fields
| Input Field | Description |
|---|---|
categoryID
-
Order |
Example
{"categoryID": "asc"}
ProductFieldType
ProductFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
ProductFieldType | Filters on equality |
neq -
ProductFieldType | Filters on non-equality |
gt -
ProductFieldType | Filters on greater than |
lt -
ProductFieldType | Filters on less than |
like -
ProductFieldType | Filters on string similarity |
nlike -
ProductFieldType | Filters on non-string similarity |
Example
{
"search": "abc123",
"eq": ProductFieldType,
"neq": ProductFieldType,
"gt": ProductFieldType,
"lt": ProductFieldType,
"like": ProductFieldType,
"nlike": ProductFieldType
}
ProductInterestFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Fields
| Input Field | Description |
|---|---|
interestID
-
[Int] | Interest aggregated by the product |
Example
{"interestID": [123]}
ProductInterestFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
ProductInterestFieldType | Filters on equality |
neq -
ProductInterestFieldType | Filters on non-equality |
gt -
ProductInterestFieldType | Filters on greater than |
lt -
ProductInterestFieldType | Filters on less than |
like -
ProductInterestFieldType | Filters on string similarity |
nlike -
ProductInterestFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": ProductInterestFieldType,
"neq": ProductInterestFieldType,
"gt": ProductInterestFieldType,
"lt": ProductInterestFieldType,
"like": ProductInterestFieldType,
"nlike": ProductInterestFieldType
}
ProductInterestSort
Description
Opt-in sorting
Fields
| Input Field | Description |
|---|---|
interestID
-
Order |
Example
{"interestID": "asc"}
ProductList
Description
A wrapper with pagination data for a product list
Example
{
"results": [Product],
"limit": 123,
"page": 123,
"pageCount": 123,
"resultCount": 123
}
ProductListSort
ProductMediaFieldType
Description
Fields that can be filtered on. Note: only the first item in the array is used for filters other than 'eq' and 'neq'
Fields
| Input Field | Description |
|---|---|
mediaID
-
[Int] | Media aggregated by the product |
Example
{"mediaID": [123]}
ProductMediaFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
ProductMediaFieldType | Filters on equality |
neq -
ProductMediaFieldType | Filters on non-equality |
gt -
ProductMediaFieldType | Filters on greater than |
lt -
ProductMediaFieldType | Filters on less than |
like -
ProductMediaFieldType | Filters on string similarity |
nlike -
ProductMediaFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": ProductMediaFieldType,
"neq": ProductMediaFieldType,
"gt": ProductMediaFieldType,
"lt": ProductMediaFieldType,
"like": ProductMediaFieldType,
"nlike": ProductMediaFieldType
}
ProductMediaSort
Description
Opt-in sorting
Fields
| Input Field | Description |
|---|---|
mediaID
-
Order |
Example
{"mediaID": "asc"}
ProductTypeEnum
Description
Possible types of products
Values
| Enum Value | Description |
|---|---|
| Product can only contain a single media item |
| Product may contain multiple media items |
Example
"singularMedia"
ProfileType
Description
A profile is an individual's account as represented to the user
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
username
-
String! | |
uuid -
String! | |
firstName
-
String | |
lastName
-
String | |
displayName
-
String | |
email -
String | |
country
-
Countries | |
registerType
-
Int | The method the user registered. Email = 1, Facebook = 2, OAuth = 3, Custom = 4, Apple = 5. Custom is meant for channel specific login methods |
verified
-
Boolean | |
language
-
String | |
interests
-
[Interest!] | 🔐 You must have the following permissions to query this field:
|
roles -
[UserRoleEnum!] | |
userNotificationPreferences
-
NotificationInputs | |
canSubmitMedia
-
Boolean! |
Example
{
"id": 987,
"username": "xyz789",
"uuid": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"displayName": "xyz789",
"email": "xyz789",
"country": "AF",
"registerType": 123,
"verified": false,
"language": "xyz789",
"interests": [Interest],
"roles": ["elearningLessonReports"],
"userNotificationPreferences": NotificationInputs,
"canSubmitMedia": false
}
ProgressiveFileType
ProgressiveFileTypePublic
ProviderEnumType
Description
Possible provider types
Values
| Enum Value | Description |
|---|---|
| |
| |
| This stripe provider is no longer supported as payment provider, please use the newer Stripe Payment Intents provider. |
| |
|
Example
"cardGate"
PublicFileType
Description
A media item's files (when always public)
Fields
| Field Name | Description |
|---|---|
vimeo -
VimeoFileTypePublic | |
image -
ImageFileTypePublic | |
hls -
HlsFileTypePublic | |
dash -
DashFileTypePublic | |
progressive
-
[ProgressiveFileTypePublic] | |
rtmp -
RTMPFileTypePublic |
Example
{
"vimeo": VimeoFileTypePublic,
"image": ImageFileTypePublic,
"hls": HlsFileTypePublic,
"dash": DashFileTypePublic,
"progressive": [ProgressiveFileTypePublic],
"rtmp": RTMPFileTypePublic
}
PurchaseDetailUnion
Types
| Union Types |
|---|
Example
PaymentIntentDetail
PurchaseOptions
Description
Options for the
createPurchaseTransaction mutation. The
issuerID, successRedirect,
failureRedirect, pendingRedirect,
cancelRedirect, and locale fields
are currently not used since the
createPurchaseTransaction mutation does not
handle cardgate payments.
Fields
| Input Field | Description |
|---|---|
issuerID
-
String | Mandatory when payment service provider is cardgate and paymentMethod is IDEAL |
successRedirect
-
String | Mandatory when payment service provider is cardgate |
failureRedirect
-
String | Mandatory when payment service provider is cardgate |
pendingRedirect
-
String | |
cancelRedirect
-
String | |
locale -
Languages | |
discountCode
-
String | The discount code to apply to the purchase. Requires the Discount Code feature to be enabled |
Example
{
"issuerID": "xyz789",
"successRedirect": "xyz789",
"failureRedirect": "xyz789",
"pendingRedirect": "xyz789",
"cancelRedirect": "xyz789",
"locale": "en",
"discountCode": "abc123"
}
PurchasePlan
Description
Feedback after creating a purchase entry for a plan
Fields
| Field Name | Description |
|---|---|
transaction
-
Transaction! | 🔐 You must have the following permissions to query this field:
|
detail -
PurchaseDetailUnion | Extra detailed information differing based on payment service and method that was used. |
Example
{
"transaction": Transaction,
"detail": PaymentIntentDetail
}
RTMPFileType
RTMPFileTypePublic
Register
RegisterDevice
Description
Feedback when registering a device
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
RequestDetails
Description
Retrieve details about the client performing the request
Fields
| Field Name | Description |
|---|---|
country
-
String | The requesting user's country, formatted in ISO 3166-1 alpha-2 |
Example
{"country": "abc123"}
RestrictionSettings
Route
Description
A route to a page made using the visual UI builder
Fields
| Field Name | Description |
|---|---|
type -
UIBuilderTypeEnum! | |
routeName
-
String! | |
context
-
String | The context which the components are in. Custom routes do not have a context set. |
status -
RouteStatusEnum! | |
ui -
[UIComponent!]! | |
rootIDs
-
[ID!]! | The root components of the UI |
style -
String | Custom CSS for the route |
created
-
DateTime | Created date of the routeHistory item used for this active route |
Example
{
"type": "web",
"routeName": "abc123",
"context": "abc123",
"status": "published",
"ui": [UIComponentAccountView],
"rootIDs": [4],
"style": "abc123",
"created": "2007-12-03T10:15:30Z"
}
RouteList
RouteStatusEnum
Description
Possible different Route statuses
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"published"
S3
Season
Description
A Season of a Series. Contains zero or more Episodes.
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
publishStart
-
DateTime! | |
publishEnd
-
DateTime | |
releaseDate
-
DateTime | |
trailer
-
Media | 🔐 You must have the following permissions to query this field:
|
posterImage
-
String! | |
Arguments | |
extras -
[Extra!]! | 🔐 You must have the following permissions to query this field:
|
episodes
-
[Episode!]! | 🔐 You must have the following permissions to query this field:
|
series -
Series! | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 987,
"title": "xyz789",
"description": "abc123",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"trailer": Media,
"posterImage": "abc123",
"extras": [Extra],
"episodes": [Episode],
"series": Series
}
SentryFeatureSettings
Description
Settings for the sentry feature
Fields
| Field Name | Description |
|---|---|
admin -
SentryPlatformSettingsType! | Sentry settings for the admin |
reactNative
-
SentryPlatformSettingsType! | Sentry settings for react-native |
spa -
SentryPlatformSettingsType! | Sentry settings for the spa |
Example
{
"admin": SentryPlatformSettingsType,
"reactNative": SentryPlatformSettingsType,
"spa": SentryPlatformSettingsType
}
SentryPlatformSettingsType
Series
Description
A series. Contains zero or more Seasons, which each contain zero or more Episodes.
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
description
-
String! | |
publishStart
-
DateTime! | |
publishEnd
-
DateTime | |
releaseDate
-
DateTime | |
trailer
-
Media | 🔐 You must have the following permissions to query this field:
|
posterImage
-
String! | |
Arguments | |
genres -
[Genre!]! | 🔐 You must have the following permissions to query this field:
|
seasons
-
[Season!]! | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 987,
"title": "abc123",
"description": "xyz789",
"publishStart": "2007-12-03T10:15:30Z",
"publishEnd": "2007-12-03T10:15:30Z",
"releaseDate": "2007-12-03T10:15:30Z",
"trailer": Media,
"posterImage": "xyz789",
"genres": [Genre],
"seasons": [Season]
}
Settings
Description
The settings of a channel
Fields
| Field Name | Description |
|---|---|
channel
-
ChannelInfo! | |
defaultLanguage
-
String! | Primary/default language of the channel (BCP 47 compliant tag) |
languages
-
[String!]! | All languages supported by the channel, including default language (BCP 47 compliant tags) |
analyticsApiUrl
-
String | |
analytics
-
String | Tradecast's Google Analytics tracking ID |
appState
-
AppStateEnum! | |
Arguments
| |
featuredMedia
-
Int | The media to show in the featured media component (if the component is available) |
googleApiMapsKey
-
String! | |
analyticsTrackingIDs
-
[AnalyticsSettings!]! | |
googleTagManagerCode
-
String | |
hasHls -
Boolean! | |
store -
StoreType! | |
social -
SocialType! | |
newsletter
-
Boolean! | Whether the user can opt into newsletters |
enableUserCountryInput
-
Boolean! | Whether the country selector is shown during registering/account editing |
enableQualitySelector
-
Boolean! | Whether the player's quality selector is enabled |
enableCookieConsentNotice
-
Boolean! | |
enablePremiumContentIndicator
-
Boolean! | Whether a premium content indicator is shown on a media item's thumbnail |
showOndemandViews
-
Boolean! | Whether the viewcount is shown on media items |
launchScreen
-
LaunchScreenSettings! | The launch screens to show for new users and authenticated users |
notifications
-
NotificationSettings! | |
mobileApps
-
Boolean! | Whether this channel has mobile apps |
versions
-
VersionType! | |
ui -
UISettings | |
hostname
-
String! | |
features
-
FeaturesSettings! | |
channelProtectedReason
-
ChannelProtectedReasonEnum | |
allowMediaInMainCategory
-
Boolean! | Whether media is allowed in top-level categories |
apple -
AppleSettings | |
player -
PlayerSettings! | |
googleCastApplicationId
-
String | |
drmApiEndpoint
-
String | |
producedContentUrlSigning
-
Boolean! | Whether URL signing is enabled for produced content |
interestCount
-
Int! | The amount of interests present on the channel. |
Example
{
"channel": ChannelInfo,
"defaultLanguage": "xyz789",
"languages": ["abc123"],
"analyticsApiUrl": "xyz789",
"analytics": "xyz789",
"appState": "ok",
"featuredMedia": 987,
"googleApiMapsKey": "xyz789",
"analyticsTrackingIDs": [AnalyticsSettings],
"googleTagManagerCode": "abc123",
"hasHls": true,
"store": StoreType,
"social": SocialType,
"newsletter": true,
"enableUserCountryInput": true,
"enableQualitySelector": true,
"enableCookieConsentNotice": false,
"enablePremiumContentIndicator": false,
"showOndemandViews": false,
"launchScreen": LaunchScreenSettings,
"notifications": NotificationSettings,
"mobileApps": false,
"versions": VersionType,
"ui": UISettings,
"hostname": "xyz789",
"features": FeaturesSettings,
"channelProtectedReason": "geoblocked",
"allowMediaInMainCategory": true,
"apple": AppleSettings,
"player": PlayerSettings,
"googleCastApplicationId": "abc123",
"drmApiEndpoint": "xyz789",
"producedContentUrlSigning": true,
"interestCount": 123
}
SetupIntentDetail
Description
An intent for a payment setup, e.g. to setup recurring payments
Fields
| Field Name | Description |
|---|---|
clientSecret
-
String! |
Example
{"clientSecret": "abc123"}
SignInWithAppleSettings
Slide
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
hideTitle
-
Boolean! | |
description
-
String! | |
hideDescription
-
Boolean! | |
image -
String | |
Arguments | |
showDuration
-
Int! | |
order -
Int! | |
cta -
[SlideCta!]! | |
availableOn
-
[SlideAvailableOnEnum!]! | |
Example
{
"id": 987,
"title": "abc123",
"hideTitle": false,
"description": "xyz789",
"hideDescription": false,
"image": "abc123",
"showDuration": 987,
"order": 123,
"cta": [SlideCta],
"availableOn": ["None"]
}
SlideAvailableOnEnum
Description
Platforms a slide can be available on
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"None"
SlideCta
Description
The action that gets invoked when the user clicks on the CTA button. The URL, media, product or plan field should be used depending on the CTA's type
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
title -
String! | |
type -
SlideCtaTypeEnum! | |
url -
String | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
product
-
Product | 🔐 You must have the following permissions to query this field:
|
plan -
Plan | 🔐 You must have the following permissions to query this field:
|
openExternally
-
Boolean! | Whether the CTA's target is opened in a new tab or in the same tab |
Example
{
"id": 987,
"title": "xyz789",
"type": "Media",
"url": "abc123",
"media": Media,
"product": Product,
"plan": Plan,
"openExternally": true
}
SlideCtaTypeEnum
Description
Types of slide Ctas
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"Media"
SlideFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Example
{
"id": [123],
"availableOnWeb": false,
"availableOnIos": false,
"availableOnAndroid": true
}
SlideFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
SlideFieldType | Filters on equality |
neq -
SlideFieldType | Filters on non-equality |
gt -
SlideFieldType | Filters on greater than |
lt -
SlideFieldType | Filters on less than |
like -
SlideFieldType | Filters on string similarity |
nlike -
SlideFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": SlideFieldType,
"neq": SlideFieldType,
"gt": SlideFieldType,
"lt": SlideFieldType,
"like": SlideFieldType,
"nlike": SlideFieldType
}
SlideList
Description
A wrapper with pagination data for the slide list
Example
{
"results": [Slide],
"limit": 987,
"page": 987,
"pageCount": 987,
"resultCount": 987
}
Slider
SliderFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Example
{
"id": [123],
"hasSlideAvailableOnWeb": false,
"hasSlideAvailableOnIos": true,
"hasSlideAvailableOnAndroid": false
}
SliderFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
SliderFieldType | Filters on equality |
neq -
SliderFieldType | Filters on non-equality |
gt -
SliderFieldType | Filters on greater than |
lt -
SliderFieldType | Filters on less than |
like -
SliderFieldType | Filters on string similarity |
nlike -
SliderFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": SliderFieldType,
"neq": SliderFieldType,
"gt": SliderFieldType,
"lt": SliderFieldType,
"like": SliderFieldType,
"nlike": SliderFieldType
}
SliderList
Description
A wrapper with pagination data for the slider list
Example
{
"results": [Slider],
"limit": 123,
"page": 987,
"pageCount": 987,
"resultCount": 987
}
SocialDetails
Description
The channel's socialmedia details
Fields
| Field Name | Description |
|---|---|
url -
String |
Example
{"url": "xyz789"}
SocialNotificationFlags
SocialType
Description
The channel's types of social media
Fields
| Field Name | Description |
|---|---|
facebook
-
FacebookDetails | |
twitter
-
SocialDetails | |
linkedin
-
SocialDetails | |
googleplus
-
SocialDetails | |
instagram
-
SocialDetails | |
tiktok -
SocialDetails | |
spotify
-
SocialDetails | |
youtube
-
SocialDetails | |
snapchat
-
SocialDetails | |
pinterest
-
SocialDetails |
Example
{
"facebook": FacebookDetails,
"twitter": SocialDetails,
"linkedin": SocialDetails,
"googleplus": SocialDetails,
"instagram": SocialDetails,
"tiktok": SocialDetails,
"spotify": SocialDetails,
"youtube": SocialDetails,
"snapchat": SocialDetails,
"pinterest": SocialDetails
}
StoreDetails
StoreType
Description
Possible types of store (iOS/iTunes or android/playstore)
Fields
| Field Name | Description |
|---|---|
ios -
StoreDetails | |
android
-
StoreDetails |
Example
{
"ios": StoreDetails,
"android": StoreDetails
}
String
Description
The String scalar type represents textual data,
represented as UTF-8 character sequences. The String type is
most often used by GraphQL to represent free-form
human-readable text.
Example
"xyz789"
Style
Description
Styling object
Fields
| Field Name | Description |
|---|---|
type -
UIBuilderTypeEnum! | |
style -
String! |
Example
{"type": "web", "style": "abc123"}
SubmitMediaSettings
SubmitUserMedia
Description
Feedback when submitting user media
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
SubscriptionIntervalEnum
Description
Possible subscription interval types
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"day"
SubscriptionTrialIntervalEnum
Description
Possible subscription trial interval types
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"trialDay"
SubscriptionTrialModeOnlyEnum
Description
Possible trial mode types
Values
| Enum Value | Description |
|---|---|
| A strict way to handle trial periods on subscriptions. To prevent abuse, customers must pay 1 cent before the trial period will be active. |
| A way to avoid the payment wall. Customers can activate a trial period for each channel account. |
Example
"trialModeStrict"
SubtitlesFeatureSettings
Description
Settings for the Subtitles feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Subtitle feature is enabled |
Example
{"enabled": false}
SvodFeatureSettings
Description
Settings for the SVOD feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the SVOD feature is enabled |
Example
{"enabled": true}
ThumbType
TicketCodeFeatureSettings
Description
Settings for the Ticket Code feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the Ticket Code feature is enabled |
Example
{"enabled": false}
TimelineAutomatedTradingType
TimelineFeatureSettings
Description
Settings for the timeline feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the timeline feature is enabled |
Example
{"enabled": true}
TimelineInfo
TimelineItem
Description
A timeline item links a position on the timeline to a media item
Fields
| Field Name | Description |
|---|---|
media -
TimelineMediaItem | |
overlay
-
[Overlay!] | 🔐 You must have the following permissions to query this field:
|
timeline
-
MediaTimelineInfo |
Example
{
"media": TimelineMediaItem,
"overlay": [OverlayLivestreamActive],
"timeline": MediaTimelineInfo
}
TimelineMediaItem
Description
Represents a media item in the timeline
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
contentURL
-
String | |
duration
-
Int | |
title -
String! | |
description
-
String! | |
epg -
Boolean! | |
epgTitle
-
String | |
epgSubtitle
-
String | |
epgStart
-
Int | |
epgDuration
-
Int | |
createdAt
-
DateTime | |
contentType
-
ContentEnum | |
thumb -
String | |
Arguments | |
socialNotificationFlags
-
SocialNotificationFlags! | |
category
-
Category | 🔐 You must have the following permissions to query this field:
|
automatedTrading
-
AutomatedTradingType | The channel must have the automatedTrading feature enabled to query this field. |
files -
PublicFileType | |
filesProtectedReason
-
FileProtectedReasonEnum | Only query timeline files protected reason when needed since it's quite heavy to fetch |
interests
-
[Interest] | 🔐 You must have the following permissions to query this field:
|
Example
{
"id": 123,
"contentURL": "abc123",
"duration": 987,
"title": "abc123",
"description": "abc123",
"epg": true,
"epgTitle": "abc123",
"epgSubtitle": "xyz789",
"epgStart": 987,
"epgDuration": 123,
"createdAt": "2007-12-03T10:15:30Z",
"contentType": "youtube",
"thumb": "abc123",
"socialNotificationFlags": SocialNotificationFlags,
"category": Category,
"automatedTrading": AutomatedTradingType,
"files": PublicFileType,
"filesProtectedReason": "private",
"interests": [Interest]
}
TimelinePageEnum
Description
Possible pages where the timeline can be located
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"home"
TimelineType
Description
Represents a TV-like timeline with it's media and overlay items
Fields
| Field Name | Description |
|---|---|
items -
[TimelineItem!] | |
overlay
-
[Overlay!] | 🔐 You must have the following permissions to query this field:
|
timeline
-
TimelineInfo | |
share -
Share | |
automatedTrading
-
TimelineAutomatedTradingType | The channel must have the automatedTrading feature enabled to query this field. |
Example
{
"items": [TimelineItem],
"overlay": [OverlayLivestreamActive],
"timeline": TimelineInfo,
"share": Share,
"automatedTrading": TimelineAutomatedTradingType
}
Transaction
Description
Represents a transaction made by the user
Fields
| Field Name | Description |
|---|---|
id -
Int! | |
amountInCents
-
Int! | |
currency
-
CurrencyEnum! | |
provider
-
ProviderEnumType! | |
method -
PSPMethodValueType! | |
status -
TransactionStatusEnum! | |
reason -
TransactionReasonEnum | |
contracts
-
ContractList | |
Example
{
"id": 987,
"amountInCents": 123,
"currency": "USD",
"provider": "cardGate",
"method": "Bancontact",
"status": "pending",
"reason": "authSuccess",
"contracts": ContractList
}
TransactionReasonEnum
Description
Possible transaction reasons
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"authSuccess"
TransactionStatusEnum
Description
Possible transaction statuses
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
|
Example
"pending"
TranscribeFeatureSettings
Description
Settings for the transcribe feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the transcribe feature is enabled |
Example
{"enabled": true}
TvAppFeatureSettings
Description
Settings for the tv app feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the tv app feature is enabled |
Example
{"enabled": true}
UIBuilderFeatureSettings
Description
Settings for the UI Builder feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the UI Builder is enabled |
Example
{"enabled": false}
UIBuilderTypeEnum
Description
Possible types of UI builder content
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"web"
UIComponent
Types
| Union Types |
|---|
Example
UIComponentAccountView
UIComponentAccountView
Description
An AccountView UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentAccountViewProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentAccountViewProps
}
UIComponentAccountViewProps
Description
An AccountView UI component's props
Fields
| Field Name | Description |
|---|---|
keepOpenAfterLogin
-
Boolean! |
Example
{"keepOpenAfterLogin": false}
UIComponentApp
Description
An App UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentAppProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentAppProps
}
UIComponentAppProps
Description
An App UI component's props
Fields
| Field Name | Description |
|---|---|
type -
UIComponentAppStoreTypeEnum! |
Example
{"type": "ios"}
UIComponentAppStoreTypeEnum
Description
Possible different values of an App UI component's storeType prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"ios"
UIComponentBlock
Description
A Block UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentBlockProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentBlockProps
}
UIComponentBlockProps
Description
A Block UI component's props
Example
{
"inline": true,
"className": "abc123",
"type": "container",
"fluid": false,
"of": 987.65,
"to": 987.65,
"children": [4]
}
UIComponentBlockTypeEnum
Description
Possible different values of a Block UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"container"
UIComponentBlurredItem
Description
A BlurredItem UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentBlurredItemProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentBlurredItemProps
}
UIComponentBlurredItemProps
Description
A BlurredItem UI component's props
Fields
| Field Name | Description |
|---|---|
thumb -
String! | |
type -
UIComponentBlurredItemTypeEnum! | |
thumbs -
UIComponentBlurredItemThumbs! |
Example
{
"thumb": "xyz789",
"type": "currentPlayingItem",
"thumbs": UIComponentBlurredItemThumbs
}
UIComponentBlurredItemThumbs
UIComponentBlurredItemTypeEnum
Description
Possible different values of a BlurredItem UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"currentPlayingItem"
UIComponentBreadcrumb
Description
A Breadcrumb UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentBreadcrumbProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentBreadcrumbProps
}
UIComponentBreadcrumbContextPropertyEnum
Description
Possible different values of a Breadcrumb UI component's context prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"vlogItemBreadcrumb"
UIComponentBreadcrumbProps
Description
A Breadcrumb UI component's props
Fields
| Field Name | Description |
|---|---|
contextProperty
-
UIComponentBreadcrumbContextPropertyEnum! |
Example
{"contextProperty": "vlogItemBreadcrumb"}
UIComponentCategoryTags
Description
A CategoryTags UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentCategoryTagsProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentCategoryTagsProps
}
UIComponentCategoryTagsContextPropertyEnum
Description
Possible different values of a CategoryTags UI component's context prop
Values
| Enum Value | Description |
|---|---|
|
Example
"mediaItemCategories"
UIComponentCategoryTagsProps
Description
A CategoryTags UI component's props
Fields
| Field Name | Description |
|---|---|
contextProperty
-
UIComponentCategoryTagsContextPropertyEnum! |
Example
{"contextProperty": "mediaItemCategories"}
UIComponentContentPagesList
Description
A ContentPagesList UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentContentPagesListProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentContentPagesListProps
}
UIComponentContentPagesListProps
Description
A ContentPagesList UI component's props
Fields
| Field Name | Description |
|---|---|
useHeader
-
Boolean |
Example
{"useHeader": true}
UIComponentCurrentlyPlaying
UIComponentGrid
Description
A Grid UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentGridProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentGridProps
}
UIComponentGridItem
Description
A GridItem UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentGridItemProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentGridItemProps
}
UIComponentGridItemProps
Description
A GridItem UI component's props
Example
{
"xs": 123.45,
"xsOffset": 987.65,
"sm": 987.65,
"smOffset": 987.65,
"md": 123.45,
"mdOffset": 987.65,
"lg": 987.65,
"lgOffset": 123.45,
"children": ["4"]
}
UIComponentGridProps
UIComponentHeading
Description
A Heading UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentHeadingProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentHeadingProps
}
UIComponentHeadingContextPropertyEnum
Description
Possible different values of a Heading UI component's context prop
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
"mediaItemTitle"
UIComponentHeadingProps
Description
A Heading UI component's props
Fields
| Field Name | Description |
|---|---|
type -
UIComponentHeadingTypeEnum! | |
translation
-
String | |
title -
String | |
className
-
String | |
children
-
[ID!] | |
contextProperty
-
UIComponentHeadingContextPropertyEnum |
Example
{
"type": "h1",
"translation": "xyz789",
"title": "abc123",
"className": "abc123",
"children": ["4"],
"contextProperty": "mediaItemTitle"
}
UIComponentHeadingTypeEnum
Description
Possible different values of a Heading UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
"h1"
UIComponentHr
Description
A Hr UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentHrProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentHrProps
}
UIComponentHrProps
Description
A Hr UI component's props
Fields
| Field Name | Description |
|---|---|
className
-
String |
Example
{"className": "abc123"}
UIComponentHtml
Description
A Html UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentHtmlProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentHtmlProps
}
UIComponentHtmlProps
UIComponentIcon
Description
An Icon UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentIconProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentIconProps
}
UIComponentIconProps
Description
An Icon UI component's props
Fields
| Field Name | Description |
|---|---|
className
-
String |
Example
{"className": "abc123"}
UIComponentImage
Description
An Image UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentImageProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentImageProps
}
UIComponentImageProps
Description
An Image UI component's props
Fields
| Field Name | Description |
|---|---|
className
-
String | |
src -
String | |
alt -
String | |
type -
UIComponentImageTypeEnum |
Example
{
"className": "xyz789",
"src": "abc123",
"alt": "abc123",
"type": "channelLogo"
}
UIComponentImageTypeEnum
Description
Possible different values of an Image UI component's type prop
Values
| Enum Value | Description |
|---|---|
|
Example
"channelLogo"
UIComponentInterface
Description
Common interface shared by all UI components
Possible Types
| UIComponentInterface Types |
|---|
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z"
}
UIComponentItemComments
Description
An ItemComments UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentItemCommentsProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentItemCommentsProps
}
UIComponentItemCommentsContextPropertyEnum
Description
Possible different values of an ItemComments UI component's context prop
Values
| Enum Value | Description |
|---|---|
|
Example
"vlogItemComments"
UIComponentItemCommentsProps
Description
An ItemComments UI component's props
Fields
| Field Name | Description |
|---|---|
contextProperty
-
UIComponentItemCommentsContextPropertyEnum! |
Example
{"contextProperty": "vlogItemComments"}
UIComponentItemInterests
Description
A ItemInterests UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentItemInterestsProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentItemInterestsProps
}
UIComponentItemInterestsContextPropertyEnum
Description
Possible different values of a ItemInterests UI component's context prop
Values
| Enum Value | Description |
|---|---|
|
Example
"mediaItemInterests"
UIComponentItemInterestsProps
Description
A ItemInterests UI component's props
Fields
| Field Name | Description |
|---|---|
contextProperty
-
UIComponentItemInterestsContextPropertyEnum! |
Example
{"contextProperty": "mediaItemInterests"}
UIComponentLastWatchedOrNewMedia
UIComponentLink
Description
A Link UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentLinkProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentLinkProps
}
UIComponentLinkEvent
UIComponentLinkProps
Description
A Link UI component's props
Example
{
"href": "xyz789",
"preventDefault": true,
"noFocus": false,
"className": "xyz789",
"target": "abc123",
"external": false,
"rel": "xyz789",
"replace": false,
"disabled": true,
"children": [4],
"event": UIComponentLinkEvent
}
UIComponentMediaItems
Description
A MediaItems UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentMediaItemsProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentMediaItemsProps
}
UIComponentMediaItemsCategory
Description
A MediaItemsCategory UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentMediaItemsCategoryProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentMediaItemsCategoryProps
}
UIComponentMediaItemsCategoryProps
Description
A MediaItemsCategory UI component's props
Example
{
"hideTitle": false,
"hideShowMore": false,
"title": "xyz789",
"subtitle": "xyz789",
"linksTo": "xyz789",
"requestParams": UIComponentRequestParams,
"className": "xyz789",
"categoryID": 987
}
UIComponentMediaItemsProps
Description
A MediaItems UI component's props
Fields
| Field Name | Description |
|---|---|
hideTitle
-
Boolean | |
hideShowMore
-
Boolean | |
title -
String | |
subtitle
-
String | |
linksTo
-
String | |
requestParams
-
UIComponentRequestParams | |
className
-
String | |
contextProperty
-
UIComponentMediaItemsPropsContextPropertyEnum! | |
noAutoLimit
-
Boolean | |
disableNavigationSection
-
Boolean |
Example
{
"hideTitle": false,
"hideShowMore": false,
"title": "abc123",
"subtitle": "xyz789",
"linksTo": "xyz789",
"requestParams": UIComponentRequestParams,
"className": "abc123",
"contextProperty": "featuredMedia",
"noAutoLimit": true,
"disableNavigationSection": true
}
UIComponentMediaItemsPropsContextPropertyEnum
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
"featuredMedia"
UIComponentOndemand
Description
An Ondemand UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentOndemandProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentOndemandProps
}
UIComponentOndemandComponent
UIComponentOndemandProps
Description
An Ondemand UI component's props
Fields
| Field Name | Description |
|---|---|
hideFilters
-
Boolean |
Example
{"hideFilters": false}
UIComponentPageMeta
Description
A PageMeta UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentPageMetaProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentPageMetaProps
}
UIComponentPageMetaLink
UIComponentPageMetaMeta
UIComponentPageMetaProps
Description
A PageMeta UI component's props
Fields
| Field Name | Description |
|---|---|
title -
String! | |
link -
[UIComponentPageMetaLink] | |
meta -
[UIComponentPageMetaMeta] | |
rootClassName
-
String | |
lockControlsVisible
-
Boolean |
Example
{
"title": "xyz789",
"link": [UIComponentPageMetaLink],
"meta": [UIComponentPageMetaMeta],
"rootClassName": "xyz789",
"lockControlsVisible": true
}
UIComponentRelatedVlogItems
Description
A RelatedVlogItems UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentRelatedVlogItemsProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentRelatedVlogItemsProps
}
UIComponentRelatedVlogItemsContextPropertyEnum
Description
Possible different values of a RelatedVlogItems UI component's context prop
Values
| Enum Value | Description |
|---|---|
|
Example
"relatedVlogItems"
UIComponentRelatedVlogItemsProps
Description
A RelatedVlogItems UI component's props
Fields
| Field Name | Description |
|---|---|
hideFilters
-
Boolean | |
contextProperty
-
UIComponentRelatedVlogItemsContextPropertyEnum! |
Example
{"hideFilters": false, "contextProperty": "relatedVlogItems"}
UIComponentRequestParams
Description
A UI component's RequestParams
Fields
| Field Name | Description |
|---|---|
sort -
UIComponentRequestParamsSortEnum | |
order -
Order | |
limit -
Int | |
keywords
-
String | |
interestID
-
Int | |
categoryID
-
Int | |
page -
Int | |
contentType
-
ContentEnum |
Example
{
"sort": "id",
"order": "asc",
"limit": 123,
"keywords": "abc123",
"interestID": 123,
"categoryID": 987,
"page": 987,
"contentType": "youtube"
}
UIComponentRequestParamsSortEnum
Description
Possible different values of a UI component's RequestParams sort field
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
"id"
UIComponentRequestPlayer
Description
A RequestPlayer UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentRequestPlayerProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentRequestPlayerProps
}
UIComponentRequestPlayerPositionEnum
Description
Possible different values of a RequestPlayer UI component's position prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"absolute"
UIComponentRequestPlayerProps
Description
A RequestPlayer UI component's props
Fields
| Field Name | Description |
|---|---|
hidden -
Boolean | |
stop -
Boolean | |
position
-
UIComponentRequestPlayerPositionEnum | |
playLinear
-
Boolean | |
playOndemand
-
Int |
Example
{
"hidden": true,
"stop": true,
"position": "absolute",
"playLinear": false,
"playOndemand": 123
}
UIComponentSearchView
Description
A SearchView UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentSearchViewProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentSearchViewProps
}
UIComponentSearchViewProps
UIComponentSettingsContent
UIComponentSocialMediaButtons
UIComponentText
Description
A Text UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentTextProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentTextProps
}
UIComponentTextContextPropertyEnum
Description
Possible different values of a Text UI component's context prop
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
|
Example
"mediaItemDescription"
UIComponentTextProps
Description
A Text UI component's props
Fields
| Field Name | Description |
|---|---|
translation
-
String | |
text -
String | |
className
-
String | |
type -
UIComponentTextTypeEnum! | |
contextProperty
-
UIComponentTextContextPropertyEnum |
Example
{
"translation": "abc123",
"text": "abc123",
"className": "xyz789",
"type": "paragraph",
"contextProperty": "mediaItemDescription"
}
UIComponentTextTypeEnum
Description
Possible different values of a Text UI component's type prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"paragraph"
UIComponentThumbBackdrop
UIComponentVlogCategoriesList
Description
A VlogCategoriesList UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentVlogCategoriesListProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentVlogCategoriesListProps
}
UIComponentVlogCategoriesListProps
Description
A VlogCategoriesList UI component's props
Example
{
"filterMainMenu": true,
"className": "xyz789",
"baseUrl": "abc123",
"onlyTopLevel": false,
"itemClassName": "xyz789"
}
UIComponentVlogCategoryCollection
UIComponentVlogItemContent
Description
A VlogItemContent UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentVlogItemsContentProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentVlogItemsContentProps
}
UIComponentVlogItemHeader
UIComponentVlogItems
Description
A VlogItems UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentVlogItemsProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": UIComponentVlogItemsProps
}
UIComponentVlogItemsCategory
Description
A VlogItemsCategory UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
UIComponentVlogItemsCategoryProps! |
Example
{
"id": 4,
"created": "2007-12-03T10:15:30Z",
"props": UIComponentVlogItemsCategoryProps
}
UIComponentVlogItemsCategoryProps
Description
A VlogItemsCategory UI component's props
Example
{
"hideTitle": true,
"hideShowMore": false,
"title": "abc123",
"subtitle": "abc123",
"linksTo": "xyz789",
"requestParams": UIComponentRequestParams,
"className": "xyz789",
"categoryID": 987
}
UIComponentVlogItemsContentProps
Description
A VlogItemsContent UI component's props
Fields
| Field Name | Description |
|---|---|
className
-
String |
Example
{"className": "xyz789"}
UIComponentVlogItemsProps
Description
A VlogItems UI component's props
Fields
| Field Name | Description |
|---|---|
hideTitle
-
Boolean | |
hideShowMore
-
Boolean | |
requestParams
-
UIComponentRequestParams | |
noAutoLimit
-
Boolean | |
className
-
String |
Example
{
"hideTitle": false,
"hideShowMore": false,
"requestParams": UIComponentRequestParams,
"noAutoLimit": false,
"className": "xyz789"
}
UISettings
Description
The channel's UI settings
Fields
| Field Name | Description |
|---|---|
media -
MediaSettings | |
restrictions
-
RestrictionSettings | |
ondemandCategorizationType
-
OndemandCategorizationEnum | |
web -
UIType | |
mobile -
UIType | |
tv -
UIType |
Example
{
"media": MediaSettings,
"restrictions": RestrictionSettings,
"ondemandCategorizationType": "category",
"web": UIType,
"mobile": UIType,
"tv": UIType
}
UIType
Description
The Possible types of UI components
Fields
| Field Name | Description |
|---|---|
pages -
PlatformSettings |
Example
{"pages": PlatformSettings}
UnregisterDevice
Description
Feedback when unregistering a device
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": true}
UpdateCommentType
Description
Feedback after updating a comment
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
UpdateNotificationsType
Description
Feedback when updating notification settings
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}
UpdateUser
Description
Feedback after updating a user
Fields
| Field Name | Description |
|---|---|
user -
ProfileType! | |
success
-
Boolean! |
Example
{"user": ProfileType, "success": false}
UploadUserMediaUploadUrl
Description
Represents the data needed to upload media
Fields
| Field Name | Description |
|---|---|
Credentials
-
Credentials! | |
Region -
String! | |
S3 -
S3! |
Example
{
"Credentials": Credentials,
"Region": "xyz789",
"S3": S3
}
UserInfo
UserMediaSubmissionAllowStatus
UserRoleEnum
Description
Possible user roles
Values
| Enum Value | Description |
|---|---|
| |
| |
| |
| |
|
Example
"elearningLessonReports"
VersionNumberType
VersionType
Description
The channel's version
Fields
| Field Name | Description |
|---|---|
minAPI -
VersionNumberType! |
Example
{"minAPI": VersionNumberType}
VimeoFileType
VimeoFileTypePublic
VlogFieldType
Description
Fields that can be filtered on. Note. arrays are only supported for 'eq' and 'neq' filters
Fields
| Input Field | Description |
|---|---|
id -
[Int] | Vlog item ID |
mediaCategory
-
[Int] | Media category based on category ID |
slug -
[String] | Vlog item slug |
modified
-
[String] | Date string from when the vlog item was last modified |
created
-
[String] | Date string from when the vlog item was created |
amountViewsAll
-
[Int] | Total amount of views |
Example
{
"id": [987],
"mediaCategory": [123],
"slug": ["abc123"],
"modified": ["abc123"],
"created": ["xyz789"],
"amountViewsAll": [987]
}
VlogFilter
Description
Opt-in filtering
Fields
| Input Field | Description |
|---|---|
search -
String | String LIKE search through title, tags and body |
eq -
VlogFieldType | Filters on equality |
neq -
VlogFieldType | Filters on non-equality |
gt -
VlogFieldType | Filters on greater than |
lt -
VlogFieldType | Filters on less than |
like -
VlogFieldType | Filters on string similarity |
nlike -
VlogFieldType | Filters on non-string similarity |
Example
{
"search": "xyz789",
"eq": VlogFieldType,
"neq": VlogFieldType,
"gt": VlogFieldType,
"lt": VlogFieldType,
"like": VlogFieldType,
"nlike": VlogFieldType
}
VlogList
Description
Vlog list wrapper
Fields
| Field Name | Description |
|---|---|
results
-
[VlogListItem!] | 🔐 You must have the following permissions to query this field:
|
limit -
Int! | |
page -
Int! | |
pageCount
-
Int! | |
resultCount
-
Int |
Example
{
"results": [VlogListItem],
"limit": 987,
"page": 987,
"pageCount": 987,
"resultCount": 123
}
VlogListItem
Description
Describes an article-like wrapper around a media item
Fields
| Field Name | Description |
|---|---|
title -
String | |
commentCount
-
Int! | |
createdAt
-
DateTime | |
updatedAt
-
DateTime | |
publishStart
-
DateTime | |
id -
Int! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
contentText
-
String | |
description
-
String | A shorter version of the vlog's contentText, limited to a total of 255 characters (including ellipsis) |
allowComments
-
Boolean! | |
slug -
String! | |
commentList
-
CommentList | Gets a list of comments for the vlog. The channel must have the vlogs feature enabled to query this field. |
Arguments | |
related
-
VlogList | Gets the vlogs related to this vlog. The channel must have the vlogs feature enabled to query this field. |
Arguments | |
Example
{
"title": "xyz789",
"commentCount": 123,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"publishStart": "2007-12-03T10:15:30Z",
"id": 123,
"media": Media,
"contentText": "abc123",
"description": "xyz789",
"allowComments": true,
"slug": "abc123",
"commentList": CommentList,
"related": VlogList
}
VlogSort
Description
Opt-in sorting
Example
{
"id": "asc",
"mediaCategory": "asc",
"modified": "asc",
"created": "asc",
"amountViewsAll": "asc",
"mediaTitle": "asc",
"vlogPublishStart": "asc"
}
VlogType
Description
Describes a vlog item build around a media item
Fields
| Field Name | Description |
|---|---|
commentCount
-
Int! | |
createdAt
-
DateTime | |
updatedAt
-
DateTime | |
publishStart
-
DateTime | |
id -
Int! | |
media -
Media | 🔐 You must have the following permissions to query this field:
|
contentText
-
String | |
description
-
String | A shorter version of the vlog's contentText, limited to a total of 255 characters (including ellipsis) |
allowComments
-
Boolean! | |
slug -
String! | |
commentList
-
CommentList | Gets a list of comments for the vlog. The channel must have the vlogs feature enabled to query this field. |
Arguments | |
related
-
VlogList | Gets the vlogs related to this vlog. The channel must have the vlogs feature enabled to query this field. |
Arguments | |
Example
{
"commentCount": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"publishStart": "2007-12-03T10:15:30Z",
"id": 987,
"media": Media,
"contentText": "xyz789",
"description": "abc123",
"allowComments": false,
"slug": "xyz789",
"commentList": CommentList,
"related": VlogList
}
VlogsFeatureSettings
Description
Settings for the vlogs feature
Fields
| Field Name | Description |
|---|---|
enabled
-
Boolean! | Whether the vlogs feature is enabled |
Example
{"enabled": false}
VttTrack
Description
A WebVtt track associated with a media item
Types
| Union Types |
|---|
Example
MetadataVttTrack
VttTrackInterfaceType
Description
Set of properties every type of vttTrack has
Fields
| Field Name | Description |
|---|---|
id -
Int | |
media -
Media | |
label -
String | |
url -
String | |
type -
VttTrackTypeEnum |
Possible Types
| VttTrackInterfaceType Types |
|---|
Example
{
"id": 987,
"media": Media,
"label": "xyz789",
"url": "xyz789",
"type": "metadata"
}
VttTrackTypeEnum
Description
Possible types of a VttTrack
Values
| Enum Value | Description |
|---|---|
| |
| |
|
Example
"metadata"
WatchLaterMediaList
Description
A wrapper with pagination data for the media list
Example
{
"results": [Media],
"limit": 123,
"page": 987,
"pageCount": 987,
"resultCount": 123
}
WebUIComponentMarketingSlider
Description
A MarketingSlider UI component
Fields
| Field Name | Description |
|---|---|
id -
ID! | |
created
-
DateTime | |
props -
WebUIComponentMarketingSliderProps! |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"props": WebUIComponentMarketingSliderProps
}
WebUIComponentMarketingSliderProps
Description
A MarketingSlider UI component's props
Example
{
"spaceBetween": 987.65,
"slidesPerView": 123.45,
"controlsPositionRatio": 123.45,
"logoLoadingAnimation": true,
"fluidContent": false,
"disableAspectRatio": true,
"sliderID": 123,
"showNumSlides": true,
"swiperProgress": "tiles"
}
WebUIComponentMarketingSliderSwiperProgressEnum
Description
Possible different values of a swiperProgress prop
Values
| Enum Value | Description |
|---|---|
| |
|
Example
"tiles"
changePassword
Description
Feedback after changing a user's password
Fields
| Field Name | Description |
|---|---|
success
-
Boolean! |
Example
{"success": false}