AudiencePlayer API Documentation
USER SCHEMA
You are currently viewing the documentation for the AudiencePlayer GraphQL API USER SCHEMA, version 31.11.4, 2025-11-25 13:41:57 UTC.
☞ View the documentation for the ADMIN SCHEMA
Queries
Article
Description
Query article
Response
Returns an Article
Example
Query
query Article(
$id: Int,
$locale: String,
$url_slug: String,
$full_url_slug: String
) {
Article(
id: $id,
locale: $locale,
url_slug: $url_slug,
full_url_slug: $full_url_slug
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...ArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AssetFragment
}
categories {
...CategoryListedAsRelationFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...ProductListedAsRelationFragment
}
upsell_products {
...ProductListedAsRelationFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
featured_on_categories {
...CategoryListedAsRelationFragment
}
recommended_articles {
...ArticleRelatedFragment
}
children {
...ArticleFragment
}
entitling_subscriptions {
...SubscriptionListedFragment
}
}
}
Variables
{
"id": 42,
"locale": "string",
"url_slug": "string",
"full_url_slug": "string"
}
Response
{
"data": {
"Article": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"featured_on_categories": [
CategoryListedAsRelation
],
"recommended_articles": [ArticleRelated],
"children": [Article],
"entitling_subscriptions": [SubscriptionListed]
}
}
}
ArticleEntitlingResources
Description
Query entitling resources (products and subscriptions) for given article
Response
Returns an ArticleEntitlingResources
Arguments
| Name | Description |
|---|---|
locale - String
|
|
platform_context - PlatformContextEnum
|
The platform context determines the displayed text content (e.g. subscription titles and texts). Default = web |
id - Int
|
The article ID for which to fetch the entitling resources |
is_include_children - Boolean
|
Include products/subscriptions for level-1 children of given article id (e.g. the "seasons" of an series-article id, but not the level-2 "episodes"). Default = false |
is_hide_user_entitlements - Boolean
|
Hide resources for which the user is already entitled. Default = false |
is_include_secondary_credit_entitlements - Boolean
|
Include resources that provide secondary entitlements, e.g. through a subscription that provides credits. Default = true |
is_intersect_with_subscription_pricing - Boolean
|
The entitling subscriptions are filtered on the available subscriptions published on the pricing page. Default = true |
Example
Query
query ArticleEntitlingResources(
$locale: String,
$platform_context: PlatformContextEnum,
$id: Int,
$is_include_children: Boolean,
$is_hide_user_entitlements: Boolean,
$is_include_secondary_credit_entitlements: Boolean,
$is_intersect_with_subscription_pricing: Boolean
) {
ArticleEntitlingResources(
locale: $locale,
platform_context: $platform_context,
id: $id,
is_include_children: $is_include_children,
is_hide_user_entitlements: $is_hide_user_entitlements,
is_include_secondary_credit_entitlements: $is_include_secondary_credit_entitlements,
is_intersect_with_subscription_pricing: $is_intersect_with_subscription_pricing
) {
subscriptions {
...SubscriptionListedFragment
}
products {
...ProductListedFragment
}
}
}
Variables
{
"locale": "string",
"platform_context": "web",
"id": 42,
"is_include_children": false,
"is_hide_user_entitlements": false,
"is_include_secondary_credit_entitlements": true,
"is_intersect_with_subscription_pricing": true
}
Response
{
"data": {
"ArticleEntitlingResources": {
"subscriptions": [SubscriptionListed],
"products": [ProductListed]
}
}
}
ArticleLatestNomadic
Description
Query latest nomadic article
Response
Returns an Article
Example
Query
query ArticleLatestNomadic(
$root_id: Int,
$locale: String,
$is_fallback_to_first_eligible_article: Boolean
) {
ArticleLatestNomadic(
root_id: $root_id,
locale: $locale,
is_fallback_to_first_eligible_article: $is_fallback_to_first_eligible_article
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...ArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AssetFragment
}
categories {
...CategoryListedAsRelationFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...ProductListedAsRelationFragment
}
upsell_products {
...ProductListedAsRelationFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
featured_on_categories {
...CategoryListedAsRelationFragment
}
recommended_articles {
...ArticleRelatedFragment
}
children {
...ArticleFragment
}
entitling_subscriptions {
...SubscriptionListedFragment
}
}
}
Variables
{
"root_id": 42,
"locale": "string",
"is_fallback_to_first_eligible_article": true
}
Response
{
"data": {
"ArticleLatestNomadic": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"featured_on_categories": [
CategoryListedAsRelation
],
"recommended_articles": [ArticleRelated],
"children": [Article],
"entitling_subscriptions": [SubscriptionListed]
}
}
}
ArticleList
Description
Query list of articles with pagination
Response
Returns an ArticlesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
parent_id - Int
|
|
parent_ids - [Int]
|
|
ancestor_id - Int
|
The article ancestor id the article is a descendant of |
category_id - Int
|
The category id the article belongs to |
category_ids - [Int]
|
The category ids (XOR) the article belongs to |
article_ids - [Int]
|
The article ids to be fetched |
type - ArticleTypeEnum
|
Article type |
types - [ArticleTypeEnum]
|
The types to filter resources on (filter type: "where in") |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "published_at", "published_from", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
list_filter - ArticleListFilterTypeEnum
|
Article list filter type |
Example
Query
query ArticleList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$parent_id: Int,
$parent_ids: [Int],
$ancestor_id: Int,
$category_id: Int,
$category_ids: [Int],
$article_ids: [Int],
$type: ArticleTypeEnum,
$types: [ArticleTypeEnum],
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$list_filter: ArticleListFilterTypeEnum
) {
ArticleList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
parent_id: $parent_id,
parent_ids: $parent_ids,
ancestor_id: $ancestor_id,
category_id: $category_id,
category_ids: $category_ids,
article_ids: $article_ids,
type: $type,
types: $types,
sort_by: $sort_by,
filter_by: $filter_by,
list_filter: $list_filter
) {
items {
...ArticleListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"parent_id": 42,
"parent_ids": [42],
"ancestor_id": 42,
"category_id": 42,
"category_ids": [42],
"article_ids": [42],
"type": "episode",
"types": ["episode"],
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"list_filter": "trending"
}
Response
{
"data": {
"ArticleList": {
"items": [ArticleListed],
"pagination": Pagination
}
}
}
AuthenticationStatus
Description
Query authentication status
Response
Returns a Boolean
Example
Query
query AuthenticationStatus {
AuthenticationStatus
}
Response
{"data": {"AuthenticationStatus": false}}
Category
Response
Returns a Category
Example
Query
query Category(
$id: Int,
$locale: String,
$url_slug: String,
$full_url_slug: String
) {
Category(
id: $id,
locale: $locale,
url_slug: $url_slug,
full_url_slug: $full_url_slug
) {
id
project_id
name
url_slug
full_url_slug
canonical_url
type
metas {
...CategoryMetaFragment
}
articles {
...ArticleListedAsRelationFragment
}
products {
...ProductListedAsRelationFragment
}
featured_articles {
...ArticleFeaturedFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
videos {
...FileFragment
}
parent_id
child_metas
created_at
updated_at
posters {
...FileFragment
}
}
}
Variables
{
"id": 42,
"locale": "string",
"url_slug": "string",
"full_url_slug": "string"
}
Response
{
"data": {
"Category": {
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [CategoryMeta],
"articles": [ArticleListedAsRelation],
"products": [ProductListedAsRelation],
"featured_articles": [ArticleFeatured],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"posters": [File]
}
}
}
CategoryList
Response
Returns a CategoriesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
parent_id - Int
|
|
parent_ids - [Int]
|
|
category_ids - [Int]
|
The category ids to be fetched |
type - CategoryTypeEnum
|
Category type |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
list_filter - CategoryListFilterTypeEnum
|
Category list filter type |
Example
Query
query CategoryList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$parent_id: Int,
$parent_ids: [Int],
$category_ids: [Int],
$type: CategoryTypeEnum,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$list_filter: CategoryListFilterTypeEnum
) {
CategoryList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
parent_id: $parent_id,
parent_ids: $parent_ids,
category_ids: $category_ids,
type: $type,
sort_by: $sort_by,
filter_by: $filter_by,
list_filter: $list_filter
) {
items {
...CategoryListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"parent_id": 42,
"parent_ids": [42],
"category_ids": [42],
"type": "article_label",
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"list_filter": "article_taggable"
}
Response
{
"data": {
"CategoryList": {
"items": [CategoryListed],
"pagination": Pagination
}
}
}
ClientPayloadVerify
Description
Verify given client payload
Response
Returns a ClientPayload
Example
Query
query ClientPayloadVerify(
$project_id: Int,
$client_id: String,
$client_secret: String,
$payload: String
) {
ClientPayloadVerify(
project_id: $project_id,
client_id: $client_id,
client_secret: $client_secret,
payload: $payload
) {
payload
status
}
}
Variables
{
"project_id": 42,
"client_id": "string",
"client_secret": "string",
"payload": "string"
}
Response
{
"data": {
"ClientPayloadVerify": {
"payload": "string",
"status": "string"
}
}
}
ClientUser
Description
Query user details of given user
Response
Returns a User
Example
Query
query ClientUser(
$currency: PaymentProviderCurrencyEnum,
$project_id: Int,
$client_id: String,
$client_secret: String,
$id: Int,
$email: String
) {
ClientUser(
currency: $currency,
project_id: $project_id,
client_id: $client_id,
client_secret: $client_secret,
id: $id,
email: $email
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...UserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...UserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
}
}
Variables
{
"currency": "CREDIT",
"project_id": 42,
"client_id": "string",
"client_secret": "string",
"id": 42,
"email": "string"
}
Response
{
"data": {
"ClientUser": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
}
}
Config
Description
Query configuration for user scope
Response
Returns a Config
Arguments
| Name | Description |
|---|---|
platform_context - PlatformContextEnum
|
|
operator_context - OperatorContextEnum
|
Default = web |
device_type - DeviceTypeEnum
|
|
locale - String
|
|
geo_region_code - String
|
Example
Query
query Config(
$platform_context: PlatformContextEnum,
$operator_context: OperatorContextEnum,
$device_type: DeviceTypeEnum,
$locale: String,
$geo_region_code: String
) {
Config(
platform_context: $platform_context,
operator_context: $operator_context,
device_type: $device_type,
locale: $locale,
geo_region_code: $geo_region_code
) {
environment
locale
geo_region_code
project_id
is_authenticated
has_subscriptions
has_auto_canonical_urls
has_credits
has_metric_action_fulfilment_notifications
has_subscription_payment_registration_integration
has_subscription_payment_pricing_before_registration
has_subscription_credit_integration
has_entitlements
has_geo_restrictions
has_article_favourites
has_article_ratings
has_article_nomadics
has_article_series_nomadics
has_article_entitlements
has_article_history
has_article_recommendations
has_article_offline_downloads
has_article_purchase_buttons
has_product_purchase_affiliation_categories
has_subscription_purchase_affiliation_categories
has_product_checkout_cart_in_menu
has_checkout_combined_login_registration
is_affiliation_category_selection_required
max_concurrent_vod_stream_num
streampulse_completion_ratio
encryption_fairplay_certificate_url
article_ribbon_settings {
...StructureKeyValueStringPairFragment
}
article_offline_download_settings {
...StructureKeyValueStringPairFragment
}
article_recently_added_ttl
article_nomadic_visibility_ttl
article_nomadic_visibility_max_num
article_history_visibility_max_num
platform {
...ConfigPlatformEnvironmentFragment
}
urls {
...StructureKeyValueStringPairFragment
}
base_url_slugs {
...ConfigBaseUrlSlugFragment
}
locale_translations
locale_regions {
...LocaleRegionFragment
}
image_resize_resolutions {
...ImageResolutionFragment
}
social_media_channels {
...StructureKeyValueStringPairFragment
}
social_media_sharing_channels
subscriptions {
...SubscriptionListedFragment
}
general_credit_upsell_products {
...ProductListedAsRelationFragment
}
payment_providers {
...PaymentProviderListedFragment
}
oauth_providers {
...OauthProviderListedFragment
}
language_tags {
...LanguageTagFragment
}
menus {
...MenuFragment
}
pages {
...PageFragment
}
auth_pages {
...AuthPageFragment
}
metric_actions {
...MetricActionFragment
}
notification_topics {
...NotificationTopicFragment
}
genders {
...GenderFragment
}
gender_types
article_asset_linked_types
article_types
category_types
page_types
page_component_types
page_component_element_types
voucher_claimable_product_types
voucher_claimable_subscription_types
amount_balance_purchasable_product_types
amount_balance_purchasable_subscription_types
user_consent_types
}
}
Variables
{
"platform_context": "web",
"operator_context": "web",
"device_type": "unknown",
"locale": "string",
"geo_region_code": "string"
}
Response
{
"data": {
"Config": {
"environment": "string",
"locale": "string",
"geo_region_code": "nl",
"project_id": 42,
"is_authenticated": true,
"has_subscriptions": false,
"has_auto_canonical_urls": "https://url.example.com",
"has_credits": false,
"has_metric_action_fulfilment_notifications": true,
"has_subscription_payment_registration_integration": true,
"has_subscription_payment_pricing_before_registration": true,
"has_subscription_credit_integration": true,
"has_entitlements": false,
"has_geo_restrictions": true,
"has_article_favourites": true,
"has_article_ratings": false,
"has_article_nomadics": true,
"has_article_series_nomadics": false,
"has_article_entitlements": false,
"has_article_history": false,
"has_article_recommendations": false,
"has_article_offline_downloads": true,
"has_article_purchase_buttons": true,
"has_product_purchase_affiliation_categories": false,
"has_subscription_purchase_affiliation_categories": true,
"has_product_checkout_cart_in_menu": false,
"has_checkout_combined_login_registration": true,
"is_affiliation_category_selection_required": true,
"max_concurrent_vod_stream_num": 42,
"streampulse_completion_ratio": 987.65,
"encryption_fairplay_certificate_url": "https://url.example.com",
"article_ribbon_settings": [
StructureKeyValueStringPair
],
"article_offline_download_settings": [
StructureKeyValueStringPair
],
"article_recently_added_ttl": 42,
"article_nomadic_visibility_ttl": 42,
"article_nomadic_visibility_max_num": 42,
"article_history_visibility_max_num": 42,
"platform": ConfigPlatformEnvironment,
"urls": ["https://url.example.com"],
"base_url_slugs": ["url-slug-string"],
"locale_translations": ["string"],
"locale_regions": [LocaleRegion],
"image_resize_resolutions": [ImageResolution],
"social_media_channels": [
StructureKeyValueStringPair
],
"social_media_sharing_channels": [
"string"
],
"subscriptions": [SubscriptionListed],
"general_credit_upsell_products": [
ProductListedAsRelation
],
"payment_providers": [PaymentProviderListed],
"oauth_providers": [OauthProviderListed],
"language_tags": [LanguageTag],
"menus": [Menu],
"pages": [Page],
"auth_pages": [AuthPage],
"metric_actions": [MetricAction],
"notification_topics": [NotificationTopic],
"genders": [Gender],
"gender_types": ["string"],
"article_asset_linked_types": ["film"],
"article_types": ["string"],
"category_types": ["string"],
"page_types": ["string"],
"page_component_types": ["string"],
"page_component_element_types": [
"string"
],
"voucher_claimable_product_types": [
"string"
],
"voucher_claimable_subscription_types": [
"string"
],
"amount_balance_purchasable_product_types": [
"string"
],
"amount_balance_purchasable_subscription_types": [
"string"
],
"user_consent_types": ["string"]
}
}
}
DeviceList
Response
Returns a DevicesListedWithPagination
Example
Query
query DeviceList {
DeviceList {
items {
...DeviceListedFragment
}
pagination {
...PaginationFragment
}
}
}
Response
{
"data": {
"DeviceList": {
"items": [DeviceListed],
"pagination": Pagination
}
}
}
GeoRegionList
Response
Returns a GeoRegionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "code", "is_country", "name" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query GeoRegionList(
$search: String,
$locale: String,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
GeoRegionList(
search: $search,
locale: $locale,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...GeoRegionListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"GeoRegionList": {
"items": [GeoRegionListed],
"pagination": Pagination
}
}
}
Menu
Description
Query page details
Example
Query
query Menu(
$id: Int,
$locale: String
) {
Menu(
id: $id,
locale: $locale
) {
id
project_id
name
platform_contexts
locale_regions {
...LocaleRegionFragment
}
geo_regions {
...GeoRegionFragment
}
components {
...MenuComponentFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"Menu": {
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [MenuComponent]
}
}
}
NotificationTopic
Description
Query notification topic
Response
Returns a NotificationTopic
Example
Query
query NotificationTopic(
$id: Int,
$locale: String
) {
NotificationTopic(
id: $id,
locale: $locale
) {
id
remote_notification_topic_id
project_id
name
title
description
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"NotificationTopic": {
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string"
}
}
}
NotificationTopicList
Description
Query list of notification topics with pagination
Response
Returns a NotificationTopicsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query NotificationTopicList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
NotificationTopicList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...NotificationTopicFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"NotificationTopicList": {
"items": [NotificationTopic],
"pagination": Pagination
}
}
}
OauthProviderList
Response
Returns an OauthProvidersListedWithPagination
Example
Query
query OauthProviderList(
$limit: Int,
$offset: Int
) {
OauthProviderList(
limit: $limit,
offset: $offset
) {
items {
...OauthProviderListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"limit": 42, "offset": 42}
Response
{
"data": {
"OauthProviderList": {
"items": [OauthProviderListed],
"pagination": Pagination
}
}
}
Page
Description
Query page details
Response
Returns a Page
Arguments
| Name | Description |
|---|---|
id - Int
|
|
locale - String
|
Specify the preferred locale in which to retrieve translatable metadata |
url_slug - String
|
|
full_url_slug - String
|
|
geo_region_code - String
|
Specify the preferred geo-region for which to retrieve the page (only applicable when trying to match by "url_slug" or "full_url_slug") |
Example
Query
query Page(
$id: Int,
$locale: String,
$url_slug: String,
$full_url_slug: String,
$geo_region_code: String
) {
Page(
id: $id,
locale: $locale,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
geo_region_code: $geo_region_code
) {
id
project_id
category_id
parent_id
name
url_slug
full_url_slug
canonical_url
title
type
is_in_sitemap
platform_contexts
locale_regions {
...LocaleRegionFragment
}
geo_regions {
...GeoRegionFragment
}
metas {
...PageMetaFragment
}
components {
...PageComponentFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
geo_region_code
locale
}
}
Variables
{
"id": 42,
"locale": "string",
"url_slug": "string",
"full_url_slug": "string",
"geo_region_code": "string"
}
Response
{
"data": {
"Page": {
"id": 42,
"project_id": 42,
"category_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"title": "string",
"type": "account_delete",
"is_in_sitemap": true,
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"metas": [PageMeta],
"components": [PageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"geo_region_code": "nl",
"locale": "string"
}
}
}
PageList
Response
Returns a PagesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
parent_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
platform_context - PlatformContextEnum
|
Example
Query
query PageList(
$search: String,
$locale: String,
$parent_id: Int,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$platform_context: PlatformContextEnum
) {
PageList(
search: $search,
locale: $locale,
parent_id: $parent_id,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
platform_context: $platform_context
) {
items {
...PageListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"parent_id": 42,
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"platform_context": "web"
}
Response
{
"data": {
"PageList": {
"items": [PageListed],
"pagination": Pagination
}
}
}
PaymentArgumentsValidate
Deprecated in favour of the combined checkout cart mutation "UserPurchaseIntentAcquire", which can be run with dry-run argument to validate the purchase intent
Description
Validate payment arguments before conducting a payment
Response
Returns a PaymentArgumentsValidate
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
Default = null |
is_use_amount_balance - Boolean
|
Default = false |
is_solo_validation - Boolean
|
Default = false |
voucher_code - String
|
|
currency - String
|
|
subscription_id - Int
|
Default = null |
product_stack - [ProductStackInput]
|
Default = null |
locale - String
|
Example
Query
query PaymentArgumentsValidate(
$payment_provider_id: Int,
$is_use_amount_balance: Boolean,
$is_solo_validation: Boolean,
$voucher_code: String,
$currency: String,
$subscription_id: Int,
$product_stack: [ProductStackInput],
$locale: String
) {
PaymentArgumentsValidate(
payment_provider_id: $payment_provider_id,
is_use_amount_balance: $is_use_amount_balance,
is_solo_validation: $is_solo_validation,
voucher_code: $voucher_code,
currency: $currency,
subscription_id: $subscription_id,
product_stack: $product_stack,
locale: $locale
) {
voucher_validity
voucher_code
voucher_name
voucher_description
voucher_installment_num
voucher_installment_time_unit
voucher_price_diff
amount_balance_price_diff
total_price_before
total_price_after
currency
currency_symbol
scoped_subscription {
...SubscriptionFragment
}
scoped_products {
...ProductListedFragment
}
products {
...ProductListedFragment
}
affiliation_categories {
...CategoryListedFragment
}
}
}
Variables
{
"payment_provider_id": null,
"is_use_amount_balance": false,
"is_solo_validation": false,
"voucher_code": "string",
"currency": "string",
"subscription_id": null,
"product_stack": null,
"locale": "string"
}
Response
{
"data": {
"PaymentArgumentsValidate": {
"voucher_validity": false,
"voucher_code": "string",
"voucher_name": "string",
"voucher_description": "string",
"voucher_installment_num": 42,
"voucher_installment_time_unit": "day",
"voucher_price_diff": 7.99,
"amount_balance_price_diff": 7.99,
"total_price_before": 7.99,
"total_price_after": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"scoped_subscription": Subscription,
"scoped_products": [ProductListed],
"products": [ProductListed],
"affiliation_categories": [CategoryListed]
}
}
}
PaymentProviderList
Response
Returns a PaymentProvidersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s). |
filter_by - [FilterByInput]
|
Filter by field(s) |
operator_context - OperatorContextEnum
|
Default = web |
Example
Query
query PaymentProviderList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$operator_context: OperatorContextEnum
) {
PaymentProviderList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
operator_context: $operator_context
) {
items {
...PaymentProviderListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"operator_context": "web"
}
Response
{
"data": {
"PaymentProviderList": {
"items": [PaymentProviderListed],
"pagination": Pagination
}
}
}
Product
Description
Query product
Example
Query
query Product(
$id: Int,
$locale: String
) {
Product(
id: $id,
locale: $locale
) {
id
project_id
remote_product_id
name
title
description
description_short
call_to_action_tag
type
credit_type
currency
currency_symbol
price
credit_price
credit_amount
amount_balance
purchase_num
max_purchase_num
expires_in
expires_at
created_at
updated_at
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
articles {
...ArticleListedAsRelationFragment
}
categories {
...CategoryListedAsRelationFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"Product": {
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
}
}
ProductList
Response
Returns a ProductsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
category_id - Int
|
The category id the product belongs to |
type - ProductTypeEnum
|
|
types - [ProductTypeEnum]
|
The types to filter resources on (filter type: "where in") |
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "status", "expires_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query ProductList(
$search: String,
$category_id: Int,
$type: ProductTypeEnum,
$types: [ProductTypeEnum],
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
ProductList(
search: $search,
category_id: $category_id,
type: $type,
types: $types,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...ProductListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"category_id": 42,
"type": "article",
"types": ["article"],
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"ProductList": {
"items": [ProductListed],
"pagination": Pagination
}
}
}
SubscriptionList
Response
Returns a SubscriptionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
type - SubscriptionTypeEnum
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "price_per_installment", "time_unit", "position", "status", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
payment_provider_ids - [Int]
|
|
is_filter_on_pricing_selection - Boolean
|
Limit the selection to the best matches based on the Subscriptions configured on the pricing page of the WEB-template. Default = false |
Example
Query
query SubscriptionList(
$search: String,
$type: SubscriptionTypeEnum,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$payment_provider_ids: [Int],
$is_filter_on_pricing_selection: Boolean
) {
SubscriptionList(
search: $search,
type: $type,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
payment_provider_ids: $payment_provider_ids,
is_filter_on_pricing_selection: $is_filter_on_pricing_selection
) {
items {
...SubscriptionListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"type": "svod",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"payment_provider_ids": [42],
"is_filter_on_pricing_selection": false
}
Response
{
"data": {
"SubscriptionList": {
"items": [SubscriptionListed],
"pagination": Pagination
}
}
}
UserDetails
Description
Query user details
Response
Returns a UserDetails
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The desired currency on which to base displayed properties such as "user_payment_currency" and "user_payment_currency_symbol" |
Example
Query
query UserDetails($currency: PaymentProviderCurrencyEnum) {
UserDetails(currency: $currency) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...UserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...UserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
}
}
Variables
{"currency": "CREDIT"}
Response
{
"data": {
"UserDetails": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": false,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
}
}
UserPaymentAccountOrder
Response
Returns a UserPaymentAccountOrder
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query UserPaymentAccountOrder($id: Int) {
UserPaymentAccountOrder(id: $id) {
id
user_id
user_subscription_id
payment_syndicate_voucher_id
voucher_code
type
recurring_type
discount_type
payment_provider_type
amount
status
status_name
description
installed_at
paid_at
cancelled_at
refunded_at
created_at
updated_at
installments
currency
currency_symbol
products {
...ProductListedAsRelationFragment
}
}
}
Variables
{"id": 42}
Response
{
"data": {
"UserPaymentAccountOrder": {
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 123.45,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [42],
"currency": "EUR",
"currency_symbol": "EUR",
"products": [ProductListedAsRelation]
}
}
}
UserProductList
Response
Returns a UserProductsListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
Example
Query
query UserProductList($locale: String) {
UserProductList(locale: $locale) {
items {
...UserProductListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"locale": "string"}
Response
{
"data": {
"UserProductList": {
"items": [UserProductListed],
"pagination": Pagination
}
}
}
UserRegistrationAllowed
Description
Query user registration is allowed
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The desired currency on which to base displayed properties such as "user_payment_currency" and "user_payment_currency_symbol" |
Example
Query
query UserRegistrationAllowed($currency: PaymentProviderCurrencyEnum) {
UserRegistrationAllowed(currency: $currency)
}
Variables
{"currency": "CREDIT"}
Response
{"data": {"UserRegistrationAllowed": true}}
UserSubscriptionList
Response
Returns a UserSubscriptionsListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
Example
Query
query UserSubscriptionList($locale: String) {
UserSubscriptionList(locale: $locale) {
items {
...UserSubscriptionListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"locale": "string"}
Response
{
"data": {
"UserSubscriptionList": {
"items": [UserSubscriptionListed],
"pagination": Pagination
}
}
}
UserSubscriptionValidityStatus
Description
Query user subscription status
Example
Query
query UserSubscriptionValidityStatus(
$id: Int,
$subscription_id: Int
) {
UserSubscriptionValidityStatus(
id: $id,
subscription_id: $subscription_id
)
}
Variables
{"id": 42, "subscription_id": 42}
Response
{"data": {"UserSubscriptionValidityStatus": false}}
Mutations
ArticleAssetPlay
Description
Create a play-out entitlement for a given article asset
Response
Returns an ArticleAssetPlay
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The article id for which to create a play configuration |
asset_id - Int
|
The asset id for which to create a play configuration |
protocols - [ArticlePlayProtocolEnum]
|
The streaming protocols to be included in the play configuration |
resolution - ArticlePlayResolutionEnum
|
Force a given video resolution in the play configuration to create a single-bitrate stream (i.e. non-adaptive stream with single-bitrate/resolution) |
resolution_max - ArticlePlayResolutionEnum
|
Configure a maximum video resolution for the play configuration (i.e. adaptive stream with maximum bitrate/resolution) |
audio_quality_max - ArticlePlayAudioQualityEnum
|
Configure a maximum audio quality for the play configuration |
is_proxy_hls_manifest - Boolean
|
Force the manifest to be proxied e.g. in order to inject a subtitle track (only enforced for non-live streams) |
is_include_subtitles_in_manifest - Boolean
|
Force the inclusion of subtitle tracks in the manifest (only enforced if "is_proxy_hls_manifest" is true). Default = true |
is_offline_download - Boolean
|
Request a play configuration for off-line playback (i.e. in-app download, only available for non-live streams). Default = false |
manifest_audio_track_filter - String
|
Configure a specific audio filter for the play configuration. Default = "" |
platform_context - PlatformContextEnum
|
Define the appropriate platform context for the play configuration (default WEB). Default = web |
device_model_context - DeviceModelContextEnum
|
Define the appropriate device model context for the play configuration |
Example
Query
mutation ArticleAssetPlay(
$article_id: Int,
$asset_id: Int,
$protocols: [ArticlePlayProtocolEnum],
$resolution: ArticlePlayResolutionEnum,
$resolution_max: ArticlePlayResolutionEnum,
$audio_quality_max: ArticlePlayAudioQualityEnum,
$is_proxy_hls_manifest: Boolean,
$is_include_subtitles_in_manifest: Boolean,
$is_offline_download: Boolean,
$manifest_audio_track_filter: String,
$platform_context: PlatformContextEnum,
$device_model_context: DeviceModelContextEnum
) {
ArticleAssetPlay(
article_id: $article_id,
asset_id: $asset_id,
protocols: $protocols,
resolution: $resolution,
resolution_max: $resolution_max,
audio_quality_max: $audio_quality_max,
is_proxy_hls_manifest: $is_proxy_hls_manifest,
is_include_subtitles_in_manifest: $is_include_subtitles_in_manifest,
is_offline_download: $is_offline_download,
manifest_audio_track_filter: $manifest_audio_track_filter,
platform_context: $platform_context,
device_model_context: $device_model_context
) {
article_id
asset_id
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
linked_type
subtitles {
...FileFragment
}
entitlements {
...ArticleAssetPlayEntitlementFragment
}
upsell_products {
...ProductListedAsRelationFragment
}
appa
appr
pulse_updated_at
pulse_token
concurrent_user_num
fairplay_certificate_url
user_subtitle_locale
user_audio_locale
issued_at
}
}
Variables
{
"article_id": 42,
"asset_id": 42,
"protocols": ["mss"],
"resolution": "w3840_h2160",
"resolution_max": "w3840_h2160",
"audio_quality_max": "audio_512kb",
"is_proxy_hls_manifest": false,
"is_include_subtitles_in_manifest": true,
"is_offline_download": false,
"manifest_audio_track_filter": "",
"platform_context": "web",
"device_model_context": "chromecast_legacy"
}
Response
{
"data": {
"ArticleAssetPlay": {
"article_id": 42,
"asset_id": 42,
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 123.45,
"time_marker_end": 987.65,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"linked_type": "film",
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"upsell_products": [ProductListedAsRelation],
"appa": 123.45,
"appr": 0.246,
"pulse_updated_at": "2000-12-31T12:34:56.000Z",
"pulse_token": "string",
"concurrent_user_num": 42,
"fairplay_certificate_url": "https://url.example.com",
"user_subtitle_locale": "string",
"user_audio_locale": "string",
"issued_at": "2000-12-31T12:34:56.000Z"
}
}
}
CaptchaValidate
Description
Validate a captcha
ClientUserArticleAssetPlay
Description
Create a client-controlled play-out entitlement for a given article asset for a given user
Response
Returns an ArticleAssetPlay
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The article id for which to create a play configuration |
asset_id - Int
|
The asset id for which to create a play configuration |
protocols - [ArticlePlayProtocolEnum]
|
The streaming protocols to be included in the play configuration |
resolution - ArticlePlayResolutionEnum
|
Force a given video resolution in the play configuration to create a single-bitrate stream (i.e. non-adaptive stream with single-bitrate/resolution) |
resolution_max - ArticlePlayResolutionEnum
|
Configure a maximum video resolution for the play configuration (i.e. adaptive stream with maximum bitrate/resolution) |
audio_quality_max - ArticlePlayAudioQualityEnum
|
Configure a maximum audio quality for the play configuration |
is_proxy_hls_manifest - Boolean
|
Force the manifest to be proxied e.g. in order to inject a subtitle track (only enforced for non-live streams) |
is_include_subtitles_in_manifest - Boolean
|
Force the inclusion of subtitle tracks in the manifest (only enforced if "is_proxy_hls_manifest" is true). Default = true |
is_offline_download - Boolean
|
Request a play configuration for off-line playback (i.e. in-app download, only available for non-live streams). Default = false |
manifest_audio_track_filter - String
|
Configure a specific audio filter for the play configuration. Default = "" |
platform_context - PlatformContextEnum
|
Define the appropriate platform context for the play configuration (default WEB). Default = web |
device_model_context - DeviceModelContextEnum
|
Define the appropriate device model context for the play configuration |
project_id - Int
|
|
client_id - String
|
|
client_secret - String
|
|
user_id - Int
|
Example
Query
mutation ClientUserArticleAssetPlay(
$article_id: Int,
$asset_id: Int,
$protocols: [ArticlePlayProtocolEnum],
$resolution: ArticlePlayResolutionEnum,
$resolution_max: ArticlePlayResolutionEnum,
$audio_quality_max: ArticlePlayAudioQualityEnum,
$is_proxy_hls_manifest: Boolean,
$is_include_subtitles_in_manifest: Boolean,
$is_offline_download: Boolean,
$manifest_audio_track_filter: String,
$platform_context: PlatformContextEnum,
$device_model_context: DeviceModelContextEnum,
$project_id: Int,
$client_id: String,
$client_secret: String,
$user_id: Int
) {
ClientUserArticleAssetPlay(
article_id: $article_id,
asset_id: $asset_id,
protocols: $protocols,
resolution: $resolution,
resolution_max: $resolution_max,
audio_quality_max: $audio_quality_max,
is_proxy_hls_manifest: $is_proxy_hls_manifest,
is_include_subtitles_in_manifest: $is_include_subtitles_in_manifest,
is_offline_download: $is_offline_download,
manifest_audio_track_filter: $manifest_audio_track_filter,
platform_context: $platform_context,
device_model_context: $device_model_context,
project_id: $project_id,
client_id: $client_id,
client_secret: $client_secret,
user_id: $user_id
) {
article_id
asset_id
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
linked_type
subtitles {
...FileFragment
}
entitlements {
...ArticleAssetPlayEntitlementFragment
}
upsell_products {
...ProductListedAsRelationFragment
}
appa
appr
pulse_updated_at
pulse_token
concurrent_user_num
fairplay_certificate_url
user_subtitle_locale
user_audio_locale
issued_at
}
}
Variables
{
"article_id": 42,
"asset_id": 42,
"protocols": ["mss"],
"resolution": "w3840_h2160",
"resolution_max": "w3840_h2160",
"audio_quality_max": "audio_512kb",
"is_proxy_hls_manifest": false,
"is_include_subtitles_in_manifest": true,
"is_offline_download": false,
"manifest_audio_track_filter": "",
"platform_context": "web",
"device_model_context": "chromecast_legacy",
"project_id": 42,
"client_id": "string",
"client_secret": "string",
"user_id": 42
}
Response
{
"data": {
"ClientUserArticleAssetPlay": {
"article_id": 42,
"asset_id": 42,
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 987.65,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"linked_type": "film",
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"upsell_products": [ProductListedAsRelation],
"appa": 987.65,
"appr": 0.246,
"pulse_updated_at": "2000-12-31T12:34:56.000Z",
"pulse_token": "string",
"concurrent_user_num": 42,
"fairplay_certificate_url": "https://url.example.com",
"user_subtitle_locale": "string",
"user_audio_locale": "string",
"issued_at": "2000-12-31T12:34:56.000Z"
}
}
}
ClientUserAuthenticate
Description
Initiate an authenticated session and request new tokens for given or new user
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
client_id - String
|
|
client_secret - String
|
|
project_id - Int
|
|
user_id - Int
|
|
user_email - String
|
|
user_password - String
|
|
user_name - String
|
|
user_locale - String
|
|
user_geo_region_code - String
|
|
auto_register - Boolean
|
|
is_terms_and_conditions_opt_in - Boolean
|
|
is_newsletter_opt_in - Boolean
|
Example
Query
mutation ClientUserAuthenticate(
$client_id: String,
$client_secret: String,
$project_id: Int,
$user_id: Int,
$user_email: String,
$user_password: String,
$user_name: String,
$user_locale: String,
$user_geo_region_code: String,
$auto_register: Boolean,
$is_terms_and_conditions_opt_in: Boolean,
$is_newsletter_opt_in: Boolean
) {
ClientUserAuthenticate(
client_id: $client_id,
client_secret: $client_secret,
project_id: $project_id,
user_id: $user_id,
user_email: $user_email,
user_password: $user_password,
user_name: $user_name,
user_locale: $user_locale,
user_geo_region_code: $user_geo_region_code,
auto_register: $auto_register,
is_terms_and_conditions_opt_in: $is_terms_and_conditions_opt_in,
is_newsletter_opt_in: $is_newsletter_opt_in
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"client_id": "string",
"client_secret": "string",
"project_id": 42,
"user_id": 42,
"user_email": "string",
"user_password": "string",
"user_name": "string",
"user_locale": "string",
"user_geo_region_code": "string",
"auto_register": true,
"is_terms_and_conditions_opt_in": false,
"is_newsletter_opt_in": false
}
Response
{
"data": {
"ClientUserAuthenticate": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
ClientUserDelete
Description
Update user
Response
Returns a Boolean
Example
Query
mutation ClientUserDelete(
$project_id: Int,
$client_id: String,
$client_secret: String,
$id: Int,
$email: String
) {
ClientUserDelete(
project_id: $project_id,
client_id: $client_id,
client_secret: $client_secret,
id: $id,
email: $email
)
}
Variables
{
"project_id": 42,
"client_id": "string",
"client_secret": "string",
"id": 42,
"email": "string"
}
Response
{"data": {"ClientUserDelete": false}}
ClientUserProductEntitlementManage
Description
Entitle or expire a user product
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
client_id - String
|
|
client_secret - String
|
|
project_id - Int
|
|
user_id - Int
|
|
user_email - String
|
|
user_password - String
|
|
user_name - String
|
|
user_locale - String
|
|
user_geo_region_code - String
|
|
auto_register - Boolean
|
|
is_terms_and_conditions_opt_in - Boolean
|
|
is_newsletter_opt_in - Boolean
|
|
product_id - Int
|
|
action - ResourceEntitlementActionEnum
|
Example
Query
mutation ClientUserProductEntitlementManage(
$client_id: String,
$client_secret: String,
$project_id: Int,
$user_id: Int,
$user_email: String,
$user_password: String,
$user_name: String,
$user_locale: String,
$user_geo_region_code: String,
$auto_register: Boolean,
$is_terms_and_conditions_opt_in: Boolean,
$is_newsletter_opt_in: Boolean,
$product_id: Int,
$action: ResourceEntitlementActionEnum
) {
ClientUserProductEntitlementManage(
client_id: $client_id,
client_secret: $client_secret,
project_id: $project_id,
user_id: $user_id,
user_email: $user_email,
user_password: $user_password,
user_name: $user_name,
user_locale: $user_locale,
user_geo_region_code: $user_geo_region_code,
auto_register: $auto_register,
is_terms_and_conditions_opt_in: $is_terms_and_conditions_opt_in,
is_newsletter_opt_in: $is_newsletter_opt_in,
product_id: $product_id,
action: $action
)
}
Variables
{
"client_id": "string",
"client_secret": "string",
"project_id": 42,
"user_id": 42,
"user_email": "string",
"user_password": "string",
"user_name": "string",
"user_locale": "string",
"user_geo_region_code": "string",
"auto_register": false,
"is_terms_and_conditions_opt_in": false,
"is_newsletter_opt_in": true,
"product_id": 42,
"action": "fulfil"
}
Response
{"data": {"ClientUserProductEntitlementManage": true}}
ClientUserSubscriptionEntitlementManage
Description
Entitle or expire a user subscription
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
client_id - String
|
|
client_secret - String
|
|
project_id - Int
|
|
user_id - Int
|
|
user_email - String
|
|
user_password - String
|
|
user_name - String
|
|
user_locale - String
|
|
user_geo_region_code - String
|
|
auto_register - Boolean
|
|
is_terms_and_conditions_opt_in - Boolean
|
|
is_newsletter_opt_in - Boolean
|
|
subscription_id - Int
|
|
expires_at - String
|
|
action - ResourceEntitlementActionEnum
|
Example
Query
mutation ClientUserSubscriptionEntitlementManage(
$client_id: String,
$client_secret: String,
$project_id: Int,
$user_id: Int,
$user_email: String,
$user_password: String,
$user_name: String,
$user_locale: String,
$user_geo_region_code: String,
$auto_register: Boolean,
$is_terms_and_conditions_opt_in: Boolean,
$is_newsletter_opt_in: Boolean,
$subscription_id: Int,
$expires_at: String,
$action: ResourceEntitlementActionEnum
) {
ClientUserSubscriptionEntitlementManage(
client_id: $client_id,
client_secret: $client_secret,
project_id: $project_id,
user_id: $user_id,
user_email: $user_email,
user_password: $user_password,
user_name: $user_name,
user_locale: $user_locale,
user_geo_region_code: $user_geo_region_code,
auto_register: $auto_register,
is_terms_and_conditions_opt_in: $is_terms_and_conditions_opt_in,
is_newsletter_opt_in: $is_newsletter_opt_in,
subscription_id: $subscription_id,
expires_at: $expires_at,
action: $action
)
}
Variables
{
"client_id": "string",
"client_secret": "string",
"project_id": 42,
"user_id": 42,
"user_email": "string",
"user_password": "string",
"user_name": "string",
"user_locale": "string",
"user_geo_region_code": "string",
"auto_register": false,
"is_terms_and_conditions_opt_in": false,
"is_newsletter_opt_in": true,
"subscription_id": 42,
"expires_at": "string",
"action": "fulfil"
}
Response
{"data": {"ClientUserSubscriptionEntitlementManage": true}}
ClientUserUpdate
Description
Update user
Response
Returns an AdminUser
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
gender - UserGenderTypeEnum
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone - String
|
|
phone_country - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
|
project_id - Int
|
|
client_id - String
|
|
client_secret - String
|
|
id - Int
|
|
status - UserStatusEnum
|
|
is_phone_verified - UserPhoneStatusEnum
|
Example
Query
mutation ClientUserUpdate(
$name: String,
$email: String,
$password: String,
$gender: UserGenderTypeEnum,
$address: String,
$postal_code: String,
$city: String,
$country: String,
$locale: String,
$subtitle_locale: String,
$audio_locale: String,
$phone: String,
$phone_country: String,
$birthday: String,
$height: Float,
$weight: Float,
$custom_data: String,
$consents: [UserConsentInput],
$notification_topics: [UserNotificationTopicInput],
$notification_profiles: [UserNotificationProfileInput],
$notifiable: UserNotifiableTypeEnum,
$is_newsletter_opt_in: Boolean,
$project_id: Int,
$client_id: String,
$client_secret: String,
$id: Int,
$status: UserStatusEnum,
$is_phone_verified: UserPhoneStatusEnum
) {
ClientUserUpdate(
name: $name,
email: $email,
password: $password,
gender: $gender,
address: $address,
postal_code: $postal_code,
city: $city,
country: $country,
locale: $locale,
subtitle_locale: $subtitle_locale,
audio_locale: $audio_locale,
phone: $phone,
phone_country: $phone_country,
birthday: $birthday,
height: $height,
weight: $weight,
custom_data: $custom_data,
consents: $consents,
notification_topics: $notification_topics,
notification_profiles: $notification_profiles,
notifiable: $notifiable,
is_newsletter_opt_in: $is_newsletter_opt_in,
project_id: $project_id,
client_id: $client_id,
client_secret: $client_secret,
id: $id,
status: $status,
is_phone_verified: $is_phone_verified
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...AdminUserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
external_user_id
metas {
...AdminUserMetaFragment
}
managed_projects {
...AdminProjectFragment
}
recent_project {
...AdminProjectFragment
}
roles {
...RoleFragment
}
user_product_orders {
...AdminUserPaymentAccountOrderFragment
}
payment_accounts {
...AdminUserPaymentAccountFragment
}
article_view_sessions {
...UserArticleSessionFragment
}
devices {
...AdminDeviceFragment
}
activity_logs {
...AdminActivityLogFragment
}
created_at
updated_at
active_at
credits {
...AdminUserPaymentCreditFragment
}
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"gender": "male",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone": "string",
"phone_country": "string",
"birthday": "string",
"height": 987.65,
"weight": 987.65,
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": true,
"project_id": 42,
"client_id": "string",
"client_secret": "string",
"id": 42,
"status": "disabled",
"is_phone_verified": "unverified"
}
Response
{
"data": {
"ClientUserUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [AdminUserSubscription],
"user_products": [UserProduct],
"orders": [AdminUserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR",
"external_user_id": "string",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"recent_project": AdminProject,
"roles": [Role],
"user_product_orders": [
AdminUserPaymentAccountOrder
],
"payment_accounts": [AdminUserPaymentAccount],
"article_view_sessions": [UserArticleSession],
"devices": [AdminDevice],
"activity_logs": [AdminActivityLog],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"active_at": "2000-12-31T12:34:56.000Z",
"credits": [AdminUserPaymentCredit]
}
}
}
DeviceAuthenticateInvalidate
Description
Invalidate current authenticated session and remove device + token
Example
Query
mutation DeviceAuthenticateInvalidate($force_device_delete: Boolean) {
DeviceAuthenticateInvalidate(force_device_delete: $force_device_delete)
}
Variables
{"force_device_delete": true}
Response
{"data": {"DeviceAuthenticateInvalidate": false}}
DeviceAuthenticatePairing
Description
Initiate an authenticated device session and request new tokens
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
uuid - String
|
|
pairing_code - String
|
|
key - String
|
|
operator_context - OperatorContextEnum
|
Example
Query
mutation DeviceAuthenticatePairing(
$uuid: String,
$pairing_code: String,
$key: String,
$operator_context: OperatorContextEnum
) {
DeviceAuthenticatePairing(
uuid: $uuid,
pairing_code: $pairing_code,
key: $key,
operator_context: $operator_context
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"uuid": "string",
"pairing_code": "string",
"key": "string",
"operator_context": "android"
}
Response
{
"data": {
"DeviceAuthenticatePairing": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
DeviceAuthenticatePrimary
Description
Initiate an authenticated device session and request new tokens
Response
Returns an Authenticate
Example
Query
mutation DeviceAuthenticatePrimary(
$uuid: String,
$name: String,
$key: String,
$operator_context: OperatorContextEnum,
$auto_register: Boolean,
$email: String
) {
DeviceAuthenticatePrimary(
uuid: $uuid,
name: $name,
key: $key,
operator_context: $operator_context,
auto_register: $auto_register,
email: $email
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"uuid": "string",
"name": "string",
"key": "string",
"operator_context": "android",
"auto_register": false,
"email": "string"
}
Response
{
"data": {
"DeviceAuthenticatePrimary": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
DevicePairingCodeFetch
Description
Request a new device pairing code
Response
Returns a DevicePairingCode
Example
Query
mutation DevicePairingCodeFetch(
$uuid: String,
$name: String
) {
DevicePairingCodeFetch(
uuid: $uuid,
name: $name
) {
pairing_code
uuid
name
expires_in
}
}
Variables
{
"uuid": "string",
"name": "string"
}
Response
{
"data": {
"DevicePairingCodeFetch": {
"pairing_code": "string",
"uuid": "string",
"name": "string",
"expires_in": 86400
}
}
}
DeviceUserDetailsUpdate
Description
Update current authenticated device user
Response
Returns a User
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
gender - UserGenderTypeEnum
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone_country - String
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
Example
Query
mutation DeviceUserDetailsUpdate(
$name: String,
$email: String,
$gender: UserGenderTypeEnum,
$locale: String,
$subtitle_locale: String,
$audio_locale: String,
$phone_country: String,
$custom_data: String,
$consents: [UserConsentInput],
$notification_topics: [UserNotificationTopicInput],
$notification_profiles: [UserNotificationProfileInput],
$notifiable: UserNotifiableTypeEnum,
$is_newsletter_opt_in: Boolean
) {
DeviceUserDetailsUpdate(
name: $name,
email: $email,
gender: $gender,
locale: $locale,
subtitle_locale: $subtitle_locale,
audio_locale: $audio_locale,
phone_country: $phone_country,
custom_data: $custom_data,
consents: $consents,
notification_topics: $notification_topics,
notification_profiles: $notification_profiles,
notifiable: $notifiable,
is_newsletter_opt_in: $is_newsletter_opt_in
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...UserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...UserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
}
}
Variables
{
"name": "string",
"email": "string",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone_country": "string",
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": true
}
Response
{
"data": {
"DeviceUserDetailsUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
}
}
UserArticleLink
Description
Add or update a linked user article
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
article_id - Int
|
|
asset_id - Int
|
|
asset_play_position_abs - Float
|
Absolute play position in seconds |
asset_play_position_rel - Float
|
Relative play position percentage (between 0 and 1) |
is_favourite - Int
|
Mark given UserArticle as favourite (only UserArticles without linked Assets OR Assets linked as "film" , "episode" are evaluated |
is_continue - Int
|
Mark given UserArticle as "continue watching" |
rating_value - Float
|
User rating value |
subtitle_locale - String
|
Selected subtitle locale |
audio_locale - String
|
Selected audio locale |
Example
Query
mutation UserArticleLink(
$article_id: Int,
$asset_id: Int,
$asset_play_position_abs: Float,
$asset_play_position_rel: Float,
$is_favourite: Int,
$is_continue: Int,
$rating_value: Float,
$subtitle_locale: String,
$audio_locale: String
) {
UserArticleLink(
article_id: $article_id,
asset_id: $asset_id,
asset_play_position_abs: $asset_play_position_abs,
asset_play_position_rel: $asset_play_position_rel,
is_favourite: $is_favourite,
is_continue: $is_continue,
rating_value: $rating_value,
subtitle_locale: $subtitle_locale,
audio_locale: $audio_locale
)
}
Variables
{
"article_id": 42,
"asset_id": 42,
"asset_play_position_abs": 123.45,
"asset_play_position_rel": 987.65,
"is_favourite": 42,
"is_continue": 42,
"rating_value": 123.45,
"subtitle_locale": "string",
"audio_locale": "string"
}
Response
{"data": {"UserArticleLink": false}}
UserArticleUnlink
Description
Completely remove given user article, deleting all nomadic data
UserAuthenticate
Description
Initiate an authenticated session and request new tokens
Response
Returns an Authenticate
Example
Query
mutation UserAuthenticate(
$email: String,
$password: String
) {
UserAuthenticate(
email: $email,
password: $password
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"email": "string",
"password": "string"
}
Response
{
"data": {
"UserAuthenticate": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
UserAuthenticateInvalidate
Description
Invalidate current authenticated session and remove all tokens
Response
Returns a Boolean
Example
Query
mutation UserAuthenticateInvalidate {
UserAuthenticateInvalidate
}
Response
{"data": {"UserAuthenticateInvalidate": true}}
UserAuthenticateRefresh
Description
Refresh current authenticated session and request new token
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
refresh_token - String
|
Example
Query
mutation UserAuthenticateRefresh($refresh_token: String) {
UserAuthenticateRefresh(refresh_token: $refresh_token) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{"refresh_token": "string"}
Response
{
"data": {
"UserAuthenticateRefresh": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
UserDeletionRequest
Description
Request deletion of currently authenticated user account
Example
Query
mutation UserDeletionRequest($password_current: String) {
UserDeletionRequest(password_current: $password_current)
}
Variables
{"password_current": "string"}
Response
{"data": {"UserDeletionRequest": true}}
UserDetailsPhoneVerifyRequest
Description
Request verification of user phone number
Response
Returns a Boolean
Example
Query
mutation UserDetailsPhoneVerifyRequest {
UserDetailsPhoneVerifyRequest
}
Response
{"data": {"UserDetailsPhoneVerifyRequest": false}}
UserDetailsPhoneVerifyValidate
Description
Validate user phone number verification code
UserDetailsUpdate
Description
Update details of current authenticated user
Response
Returns a UserDetails
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
gender - UserGenderTypeEnum
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone - String
|
|
phone_country - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
|
password_current - String
|
Example
Query
mutation UserDetailsUpdate(
$name: String,
$email: String,
$password: String,
$gender: UserGenderTypeEnum,
$address: String,
$postal_code: String,
$city: String,
$country: String,
$locale: String,
$subtitle_locale: String,
$audio_locale: String,
$phone: String,
$phone_country: String,
$birthday: String,
$height: Float,
$weight: Float,
$custom_data: String,
$consents: [UserConsentInput],
$notification_topics: [UserNotificationTopicInput],
$notification_profiles: [UserNotificationProfileInput],
$notifiable: UserNotifiableTypeEnum,
$is_newsletter_opt_in: Boolean,
$password_current: String
) {
UserDetailsUpdate(
name: $name,
email: $email,
password: $password,
gender: $gender,
address: $address,
postal_code: $postal_code,
city: $city,
country: $country,
locale: $locale,
subtitle_locale: $subtitle_locale,
audio_locale: $audio_locale,
phone: $phone,
phone_country: $phone_country,
birthday: $birthday,
height: $height,
weight: $weight,
custom_data: $custom_data,
consents: $consents,
notification_topics: $notification_topics,
notification_profiles: $notification_profiles,
notifiable: $notifiable,
is_newsletter_opt_in: $is_newsletter_opt_in,
password_current: $password_current
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...UserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...UserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"gender": "male",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone": "string",
"phone_country": "string",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": false,
"password_current": "string"
}
Response
{
"data": {
"UserDetailsUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": false,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
}
}
UserDevicePairingClaim
Description
Claim a existing pairing code for a device
Example
Query
mutation UserDevicePairingClaim($pairing_code: String) {
UserDevicePairingClaim(pairing_code: $pairing_code) {
id
name
uuid
project_id
user_id
created_at
}
}
Variables
{"pairing_code": "string"}
Response
{
"data": {
"UserDevicePairingClaim": {
"id": 42,
"name": "string",
"uuid": "string",
"project_id": 42,
"user_id": 42,
"created_at": "2000-12-31T12:34:56.000Z"
}
}
}
UserDevicePairingDelete
Description
Delete an existing device pairing
UserMetricActionAcknowledge
Description
Acknowledge metric action fulfilled for given user
Example
Query
mutation UserMetricActionAcknowledge($metric_action_id: Int) {
UserMetricActionAcknowledge(metric_action_id: $metric_action_id)
}
Variables
{"metric_action_id": 42}
Response
{"data": {"UserMetricActionAcknowledge": true}}
UserNewsletterSubscribe
Description
Sign up for newsletter
Response
Returns a Boolean
Example
Query
mutation UserNewsletterSubscribe(
$email: String,
$name: String,
$newsletter_list_id: String
) {
UserNewsletterSubscribe(
email: $email,
name: $name,
newsletter_list_id: $newsletter_list_id
)
}
Variables
{
"email": "string",
"name": "string",
"newsletter_list_id": null
}
Response
{"data": {"UserNewsletterSubscribe": true}}
UserNotificationProfileLink
Description
Link a new notification profile
Response
Returns a Boolean
Example
Query
mutation UserNotificationProfileLink(
$notification_token: String,
$device_tag: String
) {
UserNotificationProfileLink(
notification_token: $notification_token,
device_tag: $device_tag
)
}
Variables
{
"notification_token": "string",
"device_tag": null
}
Response
{"data": {"UserNotificationProfileLink": false}}
UserPasswordResetRequest
Description
Initiate a password reset request for a given user
UserPasswordResetValidate
Description
Validate a password reset request and/or reset the password
Example
Query
mutation UserPasswordResetValidate(
$token: String,
$password: String
) {
UserPasswordResetValidate(
token: $token,
password: $password
)
}
Variables
{
"token": "string",
"password": "string"
}
Response
{"data": {"UserPasswordResetValidate": true}}
UserPaymentAccountOrderValidate
Description
Validate a payment account order
UserPaymentAccountPaymentMethodUpdate
Description
Update user payment account payment method
Response
Returns a UserPaymentAccountPaymentMethodUpdate
Arguments
| Name | Description |
|---|---|
user_payment_account_id - Int
|
|
user_subscription_id - Int
|
|
redirect_url_path - String
|
|
payment_methods - [PaymentMethodInput]
|
Payment methods to be used for given transaction (input multiple methods to restrict the displayed methods on the check-out page, input a single method to enforce using it) |
Example
Query
mutation UserPaymentAccountPaymentMethodUpdate(
$user_payment_account_id: Int,
$user_subscription_id: Int,
$redirect_url_path: String,
$payment_methods: [PaymentMethodInput]
) {
UserPaymentAccountPaymentMethodUpdate(
user_payment_account_id: $user_payment_account_id,
user_subscription_id: $user_subscription_id,
redirect_url_path: $redirect_url_path,
payment_methods: $payment_methods
) {
user_payment_account_order_id
payment_url
payment_object
payment_signature
title
description
description_short
price
currency
currency_symbol
status
price_per_installment
initial_installment_num
initial_installment_time_unit
allow_suspend_after_installment_num
}
}
Variables
{
"user_payment_account_id": 42,
"user_subscription_id": 42,
"redirect_url_path": "string",
"payment_methods": [PaymentMethodInput]
}
Response
{
"data": {
"UserPaymentAccountPaymentMethodUpdate": {
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
}
}
UserPaymentAccountSynchronise
Description
Synchronise payment account with remote receipt
Response
Returns a Boolean
Example
Query
mutation UserPaymentAccountSynchronise(
$payment_provider_id: Int,
$remote_receipt: String,
$remote_product_id: String,
$remote_product_price: Float,
$remote_product_currency: String,
$categories: [Int]
) {
UserPaymentAccountSynchronise(
payment_provider_id: $payment_provider_id,
remote_receipt: $remote_receipt,
remote_product_id: $remote_product_id,
remote_product_price: $remote_product_price,
remote_product_currency: $remote_product_currency,
categories: $categories
)
}
Variables
{
"payment_provider_id": 42,
"remote_receipt": "string",
"remote_product_id": "string",
"remote_product_price": 123.45,
"remote_product_currency": "string",
"categories": [42]
}
Response
{"data": {"UserPaymentAccountSynchronise": true}}
UserPaymentVoucherRedeem
Deprecated in favour of the combined checkout cart mutation "UserPurchaseIntentAcquire"
Description
Redeem a voucher for a user
Response
Returns a UserPaymentVoucherRedeem
Arguments
| Name | Description |
|---|---|
subscription_id - Int
|
Default = null |
user_subscription_id - Int
|
Default = null |
payment_provider_id - Int
|
|
code - String
|
|
redirect_url_path - String
|
|
is_execute_recurring_payment - Boolean
|
|
payment_methods - [PaymentMethodInput]
|
Payment methods to be used for given transaction (input multiple methods to restrict the displayed methods on the check-out page, input a single method to enforce using it) |
Example
Query
mutation UserPaymentVoucherRedeem(
$subscription_id: Int,
$user_subscription_id: Int,
$payment_provider_id: Int,
$code: String,
$redirect_url_path: String,
$is_execute_recurring_payment: Boolean,
$payment_methods: [PaymentMethodInput]
) {
UserPaymentVoucherRedeem(
subscription_id: $subscription_id,
user_subscription_id: $user_subscription_id,
payment_provider_id: $payment_provider_id,
code: $code,
redirect_url_path: $redirect_url_path,
is_execute_recurring_payment: $is_execute_recurring_payment,
payment_methods: $payment_methods
) {
user_payment_account_order_id
payment_url
payment_object
payment_signature
title
description
description_short
price
currency
currency_symbol
status
price_per_installment
initial_installment_num
initial_installment_time_unit
allow_suspend_after_installment_num
}
}
Variables
{
"subscription_id": null,
"user_subscription_id": null,
"payment_provider_id": 42,
"code": "string",
"redirect_url_path": "string",
"is_execute_recurring_payment": false,
"payment_methods": [PaymentMethodInput]
}
Response
{
"data": {
"UserPaymentVoucherRedeem": {
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
}
}
UserProductAcquire
Deprecated in favour of the combined checkout cart mutation "UserPurchaseIntentAcquire"
Description
Acquire a new user product
Response
Returns a UserProductAcquire
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
|
product_stack - [ProductStackInput]
|
|
voucher_code - String
|
|
redirect_url_path - String
|
|
is_execute_recurring_payment - Boolean
|
|
is_use_amount_balance - Boolean
|
|
payment_methods - [PaymentMethodInput]
|
Payment methods to be used for given transaction (input multiple methods to restrict the displayed methods on the check-out page, input a single method to enforce using it) |
categories - [Int]
|
Example
Query
mutation UserProductAcquire(
$payment_provider_id: Int,
$product_stack: [ProductStackInput],
$voucher_code: String,
$redirect_url_path: String,
$is_execute_recurring_payment: Boolean,
$is_use_amount_balance: Boolean,
$payment_methods: [PaymentMethodInput],
$categories: [Int]
) {
UserProductAcquire(
payment_provider_id: $payment_provider_id,
product_stack: $product_stack,
voucher_code: $voucher_code,
redirect_url_path: $redirect_url_path,
is_execute_recurring_payment: $is_execute_recurring_payment,
is_use_amount_balance: $is_use_amount_balance,
payment_methods: $payment_methods,
categories: $categories
) {
user_payment_account_order_id
payment_url
payment_object
payment_signature
title
description
description_short
price
currency
currency_symbol
status
}
}
Variables
{
"payment_provider_id": 42,
"product_stack": [ProductStackInput],
"voucher_code": "string",
"redirect_url_path": "string",
"is_execute_recurring_payment": true,
"is_use_amount_balance": true,
"payment_methods": [PaymentMethodInput],
"categories": [42]
}
Response
{
"data": {
"UserProductAcquire": {
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string"
}
}
}
UserPurchaseIntentAcquire
Description
Acquire new product(s) and/or subscription which were marked for checkout by the front-end. The purchase intent can be validated before submitting, by executing with argument "is_execute_dry_run".
Response
Returns a UserPurchaseIntentAcquire
Arguments
| Name | Description |
|---|---|
operator_context - OperatorContextEnum
|
The operator context which determines the payment provider to be used for the transaction |
device_type - DeviceTypeEnum
|
The User's device type |
locale - String
|
The User's locale in which monetary values need to be represented with the correct decimal/thousands separator. If not passed then the locale will be determined automatically |
purchase_intent_stack - [UserPurchaseIntentStackItemInput]
|
The stack of resources (subscriptions, products) to be acquired |
voucher_code - String
|
alphanumeric voucher code |
redirect_url_path - String
|
custom front-end url path to which the User should be redirected when returning from payment provider url |
is_execute_recurring_payment - Boolean
|
Execute the payment automatically only if a valid payment mandate exists |
is_execute_dry_run - Boolean
|
Execute a dry-run of the payment transaction, which hydrates the property "validation_info". Default = false |
is_use_amount_balance - Boolean
|
If there is a positive amount on the User's balance, it is used to reduce the amount due |
payment_methods - [PaymentMethodInput]
|
Payment methods to be used for given transaction (input multiple methods to restrict the displayed methods on the check-out page, input a single method to enforce using it) |
categories - [Int]
|
Categories with which to tag the created payment order (e.g. affiliation categories) |
Example
Query
mutation UserPurchaseIntentAcquire(
$operator_context: OperatorContextEnum,
$device_type: DeviceTypeEnum,
$locale: String,
$purchase_intent_stack: [UserPurchaseIntentStackItemInput],
$voucher_code: String,
$redirect_url_path: String,
$is_execute_recurring_payment: Boolean,
$is_execute_dry_run: Boolean,
$is_use_amount_balance: Boolean,
$payment_methods: [PaymentMethodInput],
$categories: [Int]
) {
UserPurchaseIntentAcquire(
operator_context: $operator_context,
device_type: $device_type,
locale: $locale,
purchase_intent_stack: $purchase_intent_stack,
voucher_code: $voucher_code,
redirect_url_path: $redirect_url_path,
is_execute_recurring_payment: $is_execute_recurring_payment,
is_execute_dry_run: $is_execute_dry_run,
is_use_amount_balance: $is_use_amount_balance,
payment_methods: $payment_methods,
categories: $categories
) {
operator_context
device_type
user_payment_account_order_id
remote_payment_order_id
payment_url
payment_object
payment_signature
description
price
printable_price
price_before
price_voucher_diff
price_amount_balance_diff
currency
currency_symbol
is_execute_dry_run
is_allow_voucher_usage
is_allow_amount_balance_usage
is_allow_combined_amount_balance_voucher_usage
voucher_code
purchase_intent_stack {
...UserPurchaseIntentStackItemFragment
}
stacked_subscriptions {
...SubscriptionListedFragment
}
stacked_products {
...ProductListedFragment
}
stacked_vouchers {
...PaymentSyndicateVoucherListedFragment
}
categories {
...CategoryListedFragment
}
affiliation_categories {
...CategoryListedFragment
}
order_status
order_items {
...UserPurchaseIntentOrderItemFragment
}
validation_status
validation_messages {
...UserPurchaseIntentValidationMessageFragment
}
}
}
Variables
{
"operator_context": "android",
"device_type": "unknown",
"locale": "string",
"purchase_intent_stack": [
UserPurchaseIntentStackItemInput
],
"voucher_code": "string",
"redirect_url_path": "string",
"is_execute_recurring_payment": true,
"is_execute_dry_run": false,
"is_use_amount_balance": true,
"payment_methods": [PaymentMethodInput],
"categories": [42]
}
Response
{
"data": {
"UserPurchaseIntentAcquire": {
"operator_context": "string",
"device_type": "string",
"user_payment_account_order_id": "string",
"remote_payment_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"description": "string",
"price": 7.99,
"printable_price": 7.99,
"price_before": 7.99,
"price_voucher_diff": 7.99,
"price_amount_balance_diff": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"is_execute_dry_run": true,
"is_allow_voucher_usage": true,
"is_allow_amount_balance_usage": true,
"is_allow_combined_amount_balance_voucher_usage": false,
"voucher_code": "string",
"purchase_intent_stack": [
UserPurchaseIntentStackItem
],
"stacked_subscriptions": [SubscriptionListed],
"stacked_products": [ProductListed],
"stacked_vouchers": [PaymentSyndicateVoucherListed],
"categories": [CategoryListed],
"affiliation_categories": [CategoryListed],
"order_status": "string",
"order_items": [UserPurchaseIntentOrderItem],
"validation_status": "string",
"validation_messages": [
UserPurchaseIntentValidationMessage
]
}
}
}
UserRegister
Description
Register a new user account
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
state_param - String
|
|
gender - UserGenderTypeEnum
|
|
locale - String
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
geo_region_code - String
|
|
phone - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
is_terms_and_conditions_opt_in - Boolean
|
|
is_newsletter_opt_in - Boolean
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
Example
Query
mutation UserRegister(
$name: String,
$email: String,
$password: String,
$state_param: String,
$gender: UserGenderTypeEnum,
$locale: String,
$address: String,
$postal_code: String,
$city: String,
$country: String,
$geo_region_code: String,
$phone: String,
$birthday: String,
$height: Float,
$weight: Float,
$is_terms_and_conditions_opt_in: Boolean,
$is_newsletter_opt_in: Boolean,
$consents: [UserConsentInput],
$notification_topics: [UserNotificationTopicInput],
$notification_profiles: [UserNotificationProfileInput]
) {
UserRegister(
name: $name,
email: $email,
password: $password,
state_param: $state_param,
gender: $gender,
locale: $locale,
address: $address,
postal_code: $postal_code,
city: $city,
country: $country,
geo_region_code: $geo_region_code,
phone: $phone,
birthday: $birthday,
height: $height,
weight: $weight,
is_terms_and_conditions_opt_in: $is_terms_and_conditions_opt_in,
is_newsletter_opt_in: $is_newsletter_opt_in,
consents: $consents,
notification_topics: $notification_topics,
notification_profiles: $notification_profiles
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"state_param": "string",
"gender": "male",
"locale": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "string",
"phone": "string",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"is_terms_and_conditions_opt_in": true,
"is_newsletter_opt_in": false,
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput]
}
Response
{
"data": {
"UserRegister": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
UserRegistrationVerify
Description
Verify a newly registered user account
UserRestore
Description
Restore the authenticated user account, undoing a deletion request
Response
Returns a Boolean
Example
Query
mutation UserRestore {
UserRestore
}
Response
{"data": {"UserRestore": false}}
UserSubscriptionAcquire
Deprecated in favour of the combined checkout cart mutation "UserPurchaseIntentAcquire"
Description
Acquire a new user subscription
Response
Returns a UserSubscriptionAcquire
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
|
subscription_id - Int
|
|
voucher_code - String
|
|
redirect_url_path - String
|
|
uuid - String
|
|
key - String
|
|
is_use_amount_balance - Boolean
|
|
payment_methods - [PaymentMethodInput]
|
Payment methods to be used for given transaction (input multiple methods to restrict the displayed methods on the check-out page, input a single method to enforce using it) |
categories - [Int]
|
Example
Query
mutation UserSubscriptionAcquire(
$payment_provider_id: Int,
$subscription_id: Int,
$voucher_code: String,
$redirect_url_path: String,
$uuid: String,
$key: String,
$is_use_amount_balance: Boolean,
$payment_methods: [PaymentMethodInput],
$categories: [Int]
) {
UserSubscriptionAcquire(
payment_provider_id: $payment_provider_id,
subscription_id: $subscription_id,
voucher_code: $voucher_code,
redirect_url_path: $redirect_url_path,
uuid: $uuid,
key: $key,
is_use_amount_balance: $is_use_amount_balance,
payment_methods: $payment_methods,
categories: $categories
) {
user_payment_account_order_id
payment_url
payment_object
payment_signature
title
description
description_short
price
currency
currency_symbol
status
price_per_installment
initial_installment_num
initial_installment_time_unit
allow_suspend_after_installment_num
}
}
Variables
{
"payment_provider_id": 42,
"subscription_id": 42,
"voucher_code": "string",
"redirect_url_path": "string",
"uuid": "string",
"key": "string",
"is_use_amount_balance": true,
"payment_methods": [PaymentMethodInput],
"categories": [42]
}
Response
{
"data": {
"UserSubscriptionAcquire": {
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
}
}
UserSubscriptionSuspend
Description
Suspend a valid and active user subscription
UserSubscriptionSwitch
Description
Switch to another user subscription at next renewal date "invoiced_at"
Example
Query
mutation UserSubscriptionSwitch(
$id: Int,
$switch_to_subscription_id: Int
) {
UserSubscriptionSwitch(
id: $id,
switch_to_subscription_id: $switch_to_subscription_id
)
}
Variables
{"id": 42, "switch_to_subscription_id": 42}
Response
{"data": {"UserSubscriptionSwitch": true}}
UserSubscriptionUnSuspend
Description
Un-suspend a valid and suspended user subscription
Types
ActivityLogLevelEnum
Description
The activity log entry log level
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"system_error"
AdminActivityLog
Description
An activity log entry
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the activity log entry |
log_name - String
|
The name of the activity log entry |
description - String
|
The description of the activity log entry |
created_at - String
|
The creation date (UTC) of the log entry |
updated_at - String
|
The last modification date (UTC) of the log entry |
project_id - Int
|
The project id of the activity log entry |
user_id - Int
|
The user id of the activity log entry |
log_level - ActivityLogLevelEnum
|
The log level of the activity log entry |
status - Int
|
The processed status of the activity log entry |
properties - String
|
The json encoded logged properties of the activity log entry |
Example
{
"id": 42,
"log_name": "string",
"description": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project_id": 42,
"user_id": 42,
"log_level": "system_error",
"status": "string",
"properties": "string"
}
AdminArticle
Description
An administrated article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [AdminArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [AdminAsset]
|
List of assets this article has |
categories - [AdminCategory]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [AdminProduct]
|
The related products for the article |
upsell_products - [AdminProduct]
|
The related upsell products for the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
is_auto_generate_recommendations - Boolean
|
Article has auto-generated recommendations |
is_show_in_all_geo_regions - Boolean
|
Article is shown in all geo-regions, whether it is geo-restricted or not |
generic_url - String
|
Generic url of the article |
url_slug_translations - [Translation]
|
The translations for given property |
full_url_slug_translations - [Translation]
|
The translations for given property |
canonical_url_translations - [Translation]
|
The translations for given property |
canonical_title_translations - [Translation]
|
The translations for given property |
upsell_product_call_to_action_tag_translations - [Translation]
|
The translations for given property |
ribbon_title_translations - [Translation]
|
The translations for given property |
children - [AdminArticle]
|
List of articles this article is parent of |
recommended_articles - [AdminArticle]
|
List of recommended articles |
featured_on_categories - [AdminCategory]
|
List of categories this article is featured on |
files - [File]
|
List of files |
Arguments
|
|
entitling_subscriptions - [AdminSubscription]
|
List of subscriptions through which this article can be entitled |
published_from - String
|
Publish-from date (UTC) for the article |
published_until - String
|
Publish-until date (UTC) for the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": true,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": false,
"generic_url": "https://url.example.com",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"canonical_title_translations": [Translation],
"upsell_product_call_to_action_tag_translations": [
Translation
],
"ribbon_title_translations": [Translation],
"children": [AdminArticle],
"recommended_articles": [AdminArticle],
"featured_on_categories": [AdminCategory],
"files": [File],
"entitling_subscriptions": [AdminSubscription],
"published_from": "string",
"published_until": "string"
}
AdminArticleMeta
Description
An article metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
article_id - Int
|
The metadata property parent article id |
translations - [ArticleMetaTranslation]
|
The translations for given metadata property |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42,
"translations": [ArticleMetaTranslation]
}
AdminAsset
Description
An asset
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the asset |
project_id - Int!
|
The project id of the asset |
source_blob_name - String
|
Source blob name |
thumbnail_asset_id - String
|
Thumbnail asset id |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
type - AssetTypeEnum
|
Asset type |
linked_type - ArticleAssetLinkedTypeEnum
|
Linked asset type |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float!
|
The duration asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - String
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
screenshots - [File]
|
List of screenshot images |
playable_from - String
|
Visible-from date (UTC) for the asset (typically used to indicate when a live event will begin). |
playable_until - String
|
Visible-until date (UTC) for the asset (typically used to indicate when a live event will end). |
published_from - String
|
Publish-from date (UTC) for the asset |
published_until - String
|
Publish-until date (UTC) for the asset |
created_at - String
|
The creation date (UTC) of the asset |
updated_at - String
|
The last modification date (UTC) of the asset |
project - AdminProject
|
The project this asset belongs to |
media_provider - String
|
Media provider |
encoding_profile_name - AssetEncodingProfileNameEnum
|
Encoding profile name |
encryption_profile_name - AssetEncryptionProfileNameEnum
|
Encryption profile name |
source_blob_md5 - String
|
Source blob name (md5 encoded) |
source_asset_id - String
|
Source asset id |
encoded_asset_name - String
|
Encoded asset name |
encoded_asset_id - String
|
Encoded asset id |
streaming_unit_id - String
|
Streaming unit id |
origin - String
|
Upload origin |
streaming_endpoint - String
|
Media url locator |
asset_status_id - Int!
|
The related asset status id |
asset_status - AssetStatusEnum
|
The asset status |
ingestion_status - String
|
The asset ingestion status |
ingestion_status_description - String
|
The asset ingestion status description |
external_asset_id - String
|
External asset id, refers to customer specific id in own archive |
files - [File]
|
List of files |
Arguments
|
|
download_urls - [StructureKeyValueStringPair]
|
List of download urls |
activity_logs - [AdminActivityLog]
|
List of all activity logs for this resource |
player_embed_code_iframe - String
|
Player embed code in iframe format |
ingestion_endpoints - [String]
|
Ingestion endpoints for Asset of type "live_video" |
streaming_credentials - [StructureKeyValueStringPair]
|
Streaming credentials (e.g. for live streams) |
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 987.65,
"time_marker_end": 987.65,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [StructureKeyValueStringPair]
}
AdminCategory
Description
A category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [AdminCategoryMeta]
|
List of article metadata properties |
Arguments
|
|
articles - [AdminArticle]
|
List of articles in this category |
Arguments
|
|
products - [AdminProduct]
|
List of products in this category |
Arguments
|
|
featured_articles - [AdminArticle]
|
List of articles directly linked to this category |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The id of the parent category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
generic_url - String
|
Generic url of the category |
url_slug_translations - [Translation]
|
The translations for given property |
full_url_slug_translations - [Translation]
|
The translations for given property |
canonical_url_translations - [Translation]
|
The translations for given property |
posters - [File]
|
List of posters |
files - [File]
|
List of files |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
Visibility of the category |
status - Int
|
Status of the category |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [AdminCategoryMeta],
"articles": [AdminArticle],
"products": [AdminProduct],
"featured_articles": [AdminArticle],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"generic_url": "https://url.example.com",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"posters": [File],
"files": [File],
"visibility": "everyone",
"status": "string"
}
AdminCategoryMeta
Description
A category metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
category_id - Int
|
The metadata property parent category id |
translations - [CategoryMetaTranslation]
|
The translations for given metadata property |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42,
"translations": [CategoryMetaTranslation]
}
AdminDevice
Description
A device
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the device |
name - String
|
The name of device |
uuid - String
|
The UUID of device |
project_id - Int
|
The device project id |
user_id - Int
|
The device user id |
created_at - String
|
The creation date (UTC) of the device |
type - String
|
Device type |
operator_context - String
|
Device operator context |
brand - String
|
Device brand |
model - String
|
Device model |
key - String
|
Device key |
ip_address - String
|
Device IP Address |
Example
{
"id": 42,
"name": "string",
"uuid": "string",
"project_id": 42,
"user_id": 42,
"created_at": "2000-12-31T12:34:56.000Z",
"type": "string",
"operator_context": "string",
"brand": "string",
"model": "string",
"key": "string",
"ip_address": "string"
}
AdminMetric
Description
An administrated metric
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric |
project_id - Int!
|
The project id of the metric |
name - String
|
The name of the metric |
description - String
|
The description of the metric |
time_window - Int
|
The time window of the metric (seconds) |
type - MetricTypeEnum
|
The type of the metric |
published_from - String
|
Publish-from date (UTC) for the metric |
published_until - String
|
Publish-until date (UTC) for the metric |
created_at - String
|
The creation date (UTC) of the metric |
updated_at - String
|
The last modification date (UTC) of the metric |
status - MetricStatusEnum
|
The status of the metric |
conditions - [AdminMetricCondition]
|
List of metric conditions for this metric |
articles - [AdminArticle]
|
List of articles this metric relates to |
categories - [AdminCategory]
|
List of categories this metric relates to |
products - [AdminProduct]
|
List of products this metric relates to |
subscriptions - [AdminSubscription]
|
List of subscriptions this metric relates to |
eligible_users - [AdminUser]
|
List of users this metric may be applied on |
metric_actions - [AdminMetricAction]
|
The related metric actions of the metric |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"time_window": 42,
"type": "article",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"conditions": [AdminMetricCondition],
"articles": [AdminArticle],
"categories": [AdminCategory],
"products": [AdminProduct],
"subscriptions": [AdminSubscription],
"eligible_users": [AdminUser],
"metric_actions": [AdminMetricAction]
}
AdminMetricAction
Description
An administrated metric action
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric action |
project_id - Int!
|
The project id of the metric action |
name - String
|
The name of the metric action |
title - String
|
The title of the metric action |
content - String
|
The content of the metric action |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
files - [File]
|
List of files |
Arguments
|
|
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
type - MetricActionTypeEnum
|
The type of the metric action |
status - MetricActionStatusEnum
|
The type of the metric action |
webhook_url - String
|
The webhook url of the metric action |
user_subscription_installment_num - Int
|
The number of entitled user subscription installments of the metric action |
user_subscription_installment_time_unit - String
|
The time unit of the entitled user subscription installments of the metric action |
created_at - String
|
The creation date (UTC) of the metric action |
updated_at - String
|
The last modification date (UTC) of the metric action |
products - [AdminProductListedAsRelation]
|
List of products this metric action relates to |
eligible_users - [AdminUser]
|
List of users this metric may be applied on |
metrics - [AdminMetric]
|
The related metrics of the metric action |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"title": "string",
"content": "string",
"icons": [File],
"images": [File],
"files": [File],
"title_translations": [Translation],
"content_translations": [Translation],
"type": "user_entitlement",
"status": "string",
"webhook_url": "https://url.example.com",
"user_subscription_installment_num": 42,
"user_subscription_installment_time_unit": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"products": [AdminProductListedAsRelation],
"eligible_users": [AdminUser],
"metrics": [AdminMetric]
}
AdminMetricCondition
Description
An administrated metric condition
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric condition |
metric_id - Int
|
The id of the related metric |
type - MetricConditionTypeEnum
|
The name of the metric |
logic_operator - LogicOperatorEnum
|
The logic operator type |
value - String
|
The value of the metric condition |
created_at - String
|
The creation date (UTC) of the metric |
updated_at - String
|
The last modification date (UTC) of the metric |
Example
{
"id": 42,
"metric_id": 42,
"type": "appa",
"logic_operator": "equals",
"value": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminNotification
Description
An administrated notification
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification |
project_id - Int!
|
The project id of the notification |
parent_id - Int
|
The parent id of the notification |
name - String
|
The name of the notification |
title - String
|
The title of the notification |
content - String
|
The content of the notification |
url - String
|
The url of the notification |
delivery_type - NotificationDeliveryTypeEnum
|
The type of the notification |
type - NotificationTypeEnum
|
The type of the notification |
notification_channel_contexts - [String]
|
The notification channel contexts of the notification |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
files - [File]
|
List of files |
Arguments
|
|
children - [AdminNotification]
|
List of notifications this notification is parent of |
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
articles - [AdminArticle]
|
List of articles this notification belongs to |
Arguments
|
|
categories - [AdminCategory]
|
List of categories this notification belongs to |
Arguments
|
|
notification_topics - [AdminNotificationTopic]
|
List of notification topics this notification belongs to |
Arguments
|
|
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
status - Int
|
Status of the notification |
schedule_at - String
|
Scheduled date (UTC) for the notification |
delivered_at - String
|
Delivery date (UTC) for the notification |
created_at - String
|
The creation date (UTC) of the notification |
updated_at - String
|
The last modification date (UTC) of the notification |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"title": "string",
"content": "string",
"url": "https://url.example.com",
"delivery_type": "generic_users_on_topic",
"type": "single",
"notification_channel_contexts": [
"string"
],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File],
"children": [AdminNotification],
"title_translations": [Translation],
"content_translations": [Translation],
"articles": [AdminArticle],
"categories": [AdminCategory],
"notification_topics": [AdminNotificationTopic],
"frequency": 1,
"time_unit": "day",
"status": "string",
"schedule_at": "2000-12-31T12:34:56.000Z",
"delivered_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminNotificationTopic
Description
An administrated notification topic
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification topic |
remote_notification_topic_id - String
|
The remote id of the notification topic (e.g. used for in-app push notifications) |
project_id - Int!
|
The project id of the notification topic |
name - String
|
The name of the notification topic |
title - String
|
The title of the notification topic |
description - String
|
The content of the notification topic |
title_translations - [Translation]
|
The translations for given property title |
description_translations - [Translation]
|
The translations for given property description |
Arguments
|
|
notifications - [AdminNotification]
|
List of notifications this notification topic belongs to |
Arguments
|
|
type - NotificationTopicTypeEnum
|
Type of notification topic |
status - Int
|
Status of the notification topic |
created_at - String
|
The creation date (UTC) of the notification topic |
updated_at - String
|
The last modification date (UTC) of the notification topic |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string",
"title_translations": [Translation],
"description_translations": [Translation],
"notifications": [AdminNotification],
"type": "general",
"status": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminPaymentProviderListedAsRelation
Description
A related payment provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the payment provider |
project_id - Int!
|
The project id of the payment provider |
name - String
|
The name of the payment provider |
description - String
|
The description of the payment provider |
type - String
|
The type of the payment provider |
status - PaymentProviderStatusEnum
|
The status of the product |
device_capability - Int
|
The device payment capabilities of the payment provider |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42
}
AdminPaymentSyndicate
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the syndicate |
project_id - Int!
|
The project id of the syndicate |
name - String
|
The name of the syndicate |
type - PaymentSyndicateTypeEnum
|
The type of the syndicate |
created_at - String
|
The creation date (UTC) of the syndicate |
updated_at - String
|
The last modification date (UTC) of the syndicate |
vouchers - [AdminPaymentSyndicateVoucher]
|
List of related vouchers of the syndicate |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"type": "internal",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"vouchers": [AdminPaymentSyndicateVoucher]
}
AdminPaymentSyndicateVoucher
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher |
project_id - Int!
|
The project id of the voucher |
description - String
|
The name of the voucher |
name - String
|
The name of the voucher |
payment_syndicate_id - Int
|
The payment syndicate id of the voucher |
subscription_id - Int
|
The subscription id of the voucher |
description_translations - [Translation]
|
The translations for given property |
currency - String
|
The currency of the voucher |
currency_symbol - String
|
The currency symbol of the voucher |
amount - Float
|
The price/amount of the voucher |
installment_num - Int
|
The number of periodic installments of the voucher |
max_claimed_num - Int
|
The maximum number of times the voucher can be claimed |
max_claimed_per_user_num - Int
|
The maximum number of times the voucher can be claimed by each unique user |
claimed_num - Int
|
The number of times codes from the voucher have been claimed |
is_allow_on_valid_subscription - Boolean
|
The setting of the voucher to allow usage on already valid user subscriptions |
user_subscription_status_action - String
|
The user subscription status action of the voucher |
newsletter_list_id - String
|
The newsletter list id of the voucher |
time_unit - SubscriptionTimeUnitEnum
|
The voucher time unit |
discount_type - PaymentSyndicateVoucherDiscountTypeEnum
|
The voucher discount type |
installment_type - PaymentSyndicateVoucherInstallmentTypeEnum
|
The voucher installment type |
type - PaymentSyndicateVoucherTypeEnum
|
The type of the voucher |
issue_installments_until - String
|
The date (UTC) of the voucher until which installments are issued |
installed_at - String
|
The installation date (UTC) of the voucher |
expires_at - String
|
The expiry date (UTC) of the voucher |
created_at - String
|
The creation date (UTC) of the voucher |
updated_at - String
|
The last modification date (UTC) of the voucher |
syndicate - AdminPaymentSyndicate
|
The payment syndicate to which the voucher belongs |
batches - [AdminPaymentSyndicateVoucherCodeBatch]
|
List of related voucher code batches of the voucher |
scoped_products - [AdminProduct]
|
The scoped products to which the voucher can be applied |
products - [AdminProductListedAsRelation]
|
The related products of the subscription |
subscription - AdminSubscription
|
The subscription on which this voucher can be applied |
eligible_email_addresses - [String]
|
The related (partial) e-mail addresses eligible for voucher validation |
Example
{
"id": 42,
"project_id": 42,
"description": "string",
"name": "string",
"payment_syndicate_id": 42,
"subscription_id": 42,
"description_translations": [Translation],
"currency": "EUR",
"currency_symbol": "EUR",
"amount": 123.45,
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"claimed_num": 42,
"is_allow_on_valid_subscription": false,
"user_subscription_status_action": "string",
"newsletter_list_id": "string",
"time_unit": "day",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"syndicate": AdminPaymentSyndicate,
"batches": [AdminPaymentSyndicateVoucherCodeBatch],
"scoped_products": [AdminProduct],
"products": [AdminProductListedAsRelation],
"subscription": AdminSubscription,
"eligible_email_addresses": ["foo@example.com"]
}
AdminPaymentSyndicateVoucherCode
Description
Payment syndicate voucher code
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher code |
payment_syndicate_voucher_id - Int!
|
The voucher code id |
payment_syndicate_voucher_code_batch_id - Int!
|
The voucher code batch id |
code - String
|
The name of the voucher code |
claimed_num - Int!
|
The number of times the voucher code has been claimed |
claimed_at - String
|
The claim date (UTC) of the voucher code |
created_at - String
|
The creation date (UTC) of the voucher code |
updated_at - String
|
The last modification date (UTC) of the voucher code |
batch - AdminPaymentSyndicateVoucherCodeBatch
|
The voucher code batch of the voucher code |
Example
{
"id": 42,
"payment_syndicate_voucher_id": 42,
"payment_syndicate_voucher_code_batch_id": 42,
"code": "string",
"claimed_num": 42,
"claimed_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"batch": AdminPaymentSyndicateVoucherCodeBatch
}
AdminPaymentSyndicateVoucherCodeBatch
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher code batch |
payment_syndicate_voucher_id - Int!
|
The voucher id |
installment - Int
|
The voucher code batch installment number |
created_at - String
|
The creation date (UTC) of the voucher code batch |
updated_at - String
|
The last modification date (UTC) of the voucher code batch |
codes - AdminPaymentSyndicateVoucherCodesListedWithPagination
|
The list of voucher codes of the voucher code batch |
code_num - Int
|
The number of voucher codes of the voucher code batch |
claimed_num - Int
|
The number of times codes from the voucher code batch have been claimed |
Example
{
"id": 42,
"payment_syndicate_voucher_id": 42,
"installment": 42,
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"codes": AdminPaymentSyndicateVoucherCodesListedWithPagination,
"code_num": 42,
"claimed_num": 42
}
AdminPaymentSyndicateVoucherCodesListedWithPagination
Description
Payment syndicate voucher code list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentSyndicateVoucherCode]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPaymentSyndicateVoucherCode],
"pagination": Pagination
}
AdminProduct
Description
A product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [AdminArticle]
|
The related articles for the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
period_renewal_day - Int
|
The period-day number on which a recurring product renews |
is_sync_installments - Boolean
|
The recurring product is synchronised with user-subscription installments |
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
Expires-in time-unit midnight (UTC) offset value |
recurring_entitlement_expires_in_time_unit_num - Int
|
Expires-in interval in number of time_units for the issued product |
recurring_entitlement_expires_in - Int
|
Expires-in interval in seconds for the issued product |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
call_to_action_tag_translations - [Translation]
|
The translations for given property |
discoverability - ProductDiscoverabilityEnum
|
Discoverability of the product |
status - ProductStatusEnum
|
The status of the product |
published_from - String
|
Publish-from date (UTC) for the product |
published_until - String
|
Publish-until date (UTC) for the product |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The related issuable voucher of the product |
notification_topics - [AdminNotificationTopic]
|
The related notification topics of the product |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [AdminArticle],
"categories": [CategoryListedAsRelation],
"period_renewal_day": 42,
"is_sync_installments": false,
"frequency": 1,
"time_unit": "day",
"recurring_entitlement_expires_in_time_unit_midnight_offset": 86400,
"recurring_entitlement_expires_in_time_unit_num": 86400,
"recurring_entitlement_expires_in": 86400,
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"call_to_action_tag_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"published_from": "string",
"published_until": "string",
"newsletter_list_id": "string",
"issuable_vouchers": [AdminPaymentSyndicateVoucher],
"notification_topics": [AdminNotificationTopic],
"files": [File]
}
AdminProductListedAsRelation
Description
A related product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product id |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [AdminArticle]
|
The related articles for the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
period_renewal_day - Int
|
The period-day number on which a recurring product renews |
is_sync_installments - Boolean
|
The recurring product is synchronised with user-subscription installments |
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
Expires-in time-unit midnight (UTC) offset value |
recurring_entitlement_expires_in_time_unit_num - Int
|
Expires-in interval in number of time_units for the issued product |
recurring_entitlement_expires_in - Int
|
Expires-in interval in seconds for the issued product |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
call_to_action_tag_translations - [Translation]
|
The translations for given property |
discoverability - ProductDiscoverabilityEnum
|
Discoverability of the product |
status - ProductStatusEnum
|
The status of the product |
published_from - String
|
Publish-from date (UTC) for the product |
published_until - String
|
Publish-until date (UTC) for the product |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The related issuable voucher of the product |
notification_topics - [AdminNotificationTopic]
|
The related notification topics of the product |
files - [File]
|
List of files |
Arguments
|
|
product_price - Float
|
The set product price for given product id |
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 123.45,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [AdminArticle],
"categories": [CategoryListedAsRelation],
"period_renewal_day": 42,
"is_sync_installments": false,
"frequency": 1,
"time_unit": "day",
"recurring_entitlement_expires_in_time_unit_midnight_offset": 86400,
"recurring_entitlement_expires_in_time_unit_num": 86400,
"recurring_entitlement_expires_in": 86400,
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"call_to_action_tag_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"published_from": "string",
"published_until": "string",
"newsletter_list_id": "string",
"issuable_vouchers": [AdminPaymentSyndicateVoucher],
"notification_topics": [AdminNotificationTopic],
"files": [File],
"product_price": 7.99
}
AdminProject
Description
A project
Example
{
"id": 42,
"name": "string",
"users": [User],
"managers": [User],
"status": "string",
"status_label": "string"
}
AdminSubscription
Description
A subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles (excluding descendants) that are listed under the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [AdminPaymentProviderListedAsRelation]
|
The related payment providers of the subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
user_subscription_status_action - String
|
The user subscription status action of the voucher |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
discoverability - SubscriptionDiscoverabilityEnum
|
Discoverability of the subscription |
status - SubscriptionStatusEnum
|
The status of the subscription |
products - [AdminProductListedAsRelation]
|
The related products of the subscription |
entitleable_articles - [ArticleListedAsRelation]
|
The complete list of articles (including descendants) that can be entitled through the subscription |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [
AdminPaymentProviderListedAsRelation
],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"user_subscription_status_action": "string",
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"products": [AdminProductListedAsRelation],
"entitleable_articles": [ArticleListedAsRelation],
"files": [File]
}
AdminUser
Description
A user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [AdminUserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [AdminUserPaymentAccountOrder]
|
User orders |
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
external_user_id - String
|
External user id |
metas - [AdminUserMeta]
|
List of user metadata properties |
Arguments
|
|
managed_projects - [AdminProject]
|
List of managed projects |
recent_project - AdminProject
|
Last accessed project |
roles - [Role]
|
User roles |
user_product_orders - [AdminUserPaymentAccountOrder]
|
User product orders |
payment_accounts - [AdminUserPaymentAccount]
|
The user payment accounts |
article_view_sessions - [UserArticleSession]
|
List of all article view sessions of user |
Arguments
|
|
devices - [AdminDevice]
|
List of all paired devices of user |
activity_logs - [AdminActivityLog]
|
List of all activity logs for this resource |
Arguments
|
|
created_at - String
|
The creation date (UTC) of the user |
updated_at - String
|
The last modification date (UTC) of the user |
active_at - String
|
The last video viewing activity date (UTC) of the user |
credits - [AdminUserPaymentCredit]
|
User product orders |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [AdminUserSubscription],
"user_products": [UserProduct],
"orders": [AdminUserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR",
"external_user_id": "string",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"recent_project": AdminProject,
"roles": [Role],
"user_product_orders": [AdminUserPaymentAccountOrder],
"payment_accounts": [AdminUserPaymentAccount],
"article_view_sessions": [UserArticleSession],
"devices": [AdminDevice],
"activity_logs": [AdminActivityLog],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"active_at": "2000-12-31T12:34:56.000Z",
"credits": [AdminUserPaymentCredit]
}
AdminUserMeta
Description
A user metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
user_id - Int
|
The metadata property parent user id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
translations - [UserMetaTranslation]
|
The translations for given metadata property |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
Example
{
"id": 42,
"user_id": 42,
"key": "string",
"value": "string",
"translations": [UserMetaTranslation],
"type": "array",
"format": "string"
}
AdminUserPaymentAccount
Description
A user payment account
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the account |
payment_provider_id - Int
|
The id of the payment provider |
amount_balance - Float
|
The amount balance of the account |
method - String
|
The payment method of the account |
method_details - String
|
The payment method details of the account |
geo_region_code - String
|
The geo region (i.e. country) from which the account creation originated |
orders - [UserPaymentAccountOrder]
|
The account orders |
remote_payment_user_id - String
|
The remote payment user id registered at the remote payment provider or gateway |
remote_payment_mandate_id - String
|
The remote payment mandate id registered at the remote payment provider or gateway, used to create recurring payments |
Example
{
"id": 42,
"payment_provider_id": 42,
"amount_balance": 123.45,
"method": "string",
"method_details": "string",
"geo_region_code": "nl",
"orders": [UserPaymentAccountOrder],
"remote_payment_user_id": "string",
"remote_payment_mandate_id": "string"
}
AdminUserPaymentAccountOrder
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the order |
user_id - Int
|
The user id of the order |
user_subscription_id - String
|
The user subscription id of the order |
payment_syndicate_voucher_id - Int
|
The payment syndicate voucher id attached to the order |
voucher_code - String
|
The voucher code attached to the order |
type - String
|
The type of the order |
recurring_type - String
|
The recurring type of the order |
discount_type - String
|
The discount type of the order |
payment_provider_type - String
|
The payment provider type of the order |
amount - Float
|
The amount of the order |
status - String
|
The status of the order |
status_name - String
|
The status name of the order |
description - String
|
The description of the order |
installed_at - String
|
The installation date (UTC) of the order |
paid_at - String
|
The payment fulfilment date (UTC) of the order |
cancelled_at - String
|
The cancellation date (UTC) of the order |
refunded_at - String
|
The refunded/charge-back date (UTC) of the order |
created_at - String
|
The creation date (UTC) of the order |
updated_at - String
|
The last modification date (UTC) of the order |
installments - [AdminUserPaymentAccountOrderInstallment]
|
The order installments |
currency - String
|
The currency of the order |
currency_symbol - String
|
The currency symbol of the order |
user - AdminUser
|
The user connected to the order |
user_payment_account_id - Int
|
The user payment account id of the order |
remote_payment_order_id - String
|
The remote payment provider order id of the order |
remote_payment_user_id - String
|
The remote payment user id of the order |
amount_balance_mutation - String
|
The balance mutation amount of the order |
amount_remote_mutation - String
|
The remote mutation amount of the order |
payment_url - String
|
The payment url of the order |
method - String
|
The payment method of the order |
method_details - String
|
The payment method details of the order |
ip_address - String
|
The ip address attached to the order |
geo_region_code - String
|
The geo region (i.e. country) from which this order originated |
origin - String
|
The source from which this order originated (e.g. user, moderator, api) |
purchase_origin - String
|
The purchase origin of the fulfilment of this order |
server_origin - String
|
The server instance on which the order originated |
is_refundable - Boolean
|
Is payment order refundable |
metadata - String
|
The order metadata and/or error details |
receipt_data - String
|
The order in-app purchase receipt data and/or error details |
invoice_data - String
|
The order invoice data which summarises purchased items and prices |
account - AdminUserPaymentAccount
|
The user payment account |
user_subscription - AdminUserSubscription
|
The related user subscription |
products - [AdminProductListedAsRelation]
|
The related products of the order |
Arguments
|
|
user_subscription_products - [AdminUserSubscriptionProduct]
|
The user subscription products (pivot relation) |
Arguments
|
|
categories - [AdminCategory]
|
List of (affiliation) categories this order relates to |
Example
{
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [
AdminUserPaymentAccountOrderInstallment
],
"currency": "EUR",
"currency_symbol": "EUR",
"user": AdminUser,
"user_payment_account_id": 42,
"remote_payment_order_id": "string",
"remote_payment_user_id": "string",
"amount_balance_mutation": "string",
"amount_remote_mutation": "string",
"payment_url": "https://url.example.com",
"method": "string",
"method_details": "string",
"ip_address": "string",
"geo_region_code": "nl",
"origin": "string",
"purchase_origin": "string",
"server_origin": "string",
"is_refundable": false,
"metadata": "string",
"receipt_data": "string",
"invoice_data": "string",
"account": AdminUserPaymentAccount,
"user_subscription": AdminUserSubscription,
"products": [AdminProductListedAsRelation],
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"categories": [AdminCategory]
}
AdminUserPaymentAccountOrderInstallment
Description
A user payment account order installment
Example
{
"id": 42,
"user_payment_account_order_id": 42,
"time_unit": "string",
"term": 42,
"installment": 42
}
AdminUserPaymentCredit
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the credit |
user_id - Int
|
The user id of the credit |
status - String
|
The status of the credit |
type - String
|
The type of the credit |
amount - Float
|
The amount of the credit |
amount_balance - Float
|
The amount balance of the credit |
installed_at - String
|
The installation date (UTC) of the credit |
expires_at - String
|
The expiry date (UTC) of the credit |
fulfilment_order - AdminUserPaymentAccountOrder
|
The order through which this credit was fulfilled |
fulfilment_order_origin - String
|
The fulfilment order origin |
fulfilment_order_purchase_origin - String
|
The fulfilment order purchase origin |
orders - [AdminUserPaymentAccountOrder]
|
The order through which this credit was fulfilled |
Example
{
"id": 42,
"user_id": 42,
"status": "string",
"type": "string",
"amount": 987.65,
"amount_balance": 123.45,
"installed_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"fulfilment_order": AdminUserPaymentAccountOrder,
"fulfilment_order_origin": "string",
"fulfilment_order_purchase_origin": "string",
"orders": [AdminUserPaymentAccountOrder]
}
AdminUserSubscription
Description
A user subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user subscription |
user_id - Int!
|
The id of the user |
project_id - Int!
|
The project id of the user subscription |
subscription_id - Int!
|
The subscription id of the user subscription |
switch_from_subscription_id - Int
|
The subscription id of the old subscription the user was switched from |
switch_to_subscription_id - Int
|
The subscription id of the new subscription to switch to at next renewal |
term - Int
|
The current term of the user subscription |
acquired_at - String
|
The acquisition date (UTC) of the user subscription |
expires_at - String
|
The expiry date (UTC) of the user subscription |
suspendable_at - String
|
The suspendability date (UTC) of the user subscription |
suspended_at - String
|
The suspension date of (UTC) of the user subscription |
invoiced_at - String
|
The next invoice date (UTC) of the user subscription |
status - UserSubscriptionStatusEnum
|
The status of the user subscription |
status_name - String
|
The status description of the user subscription |
is_valid - Boolean
|
The validity of the user subscription |
is_expired - Boolean
|
The expiry status of the user subscription |
is_suspendable - Boolean
|
The suspendability of the user subscription |
is_account_method_changeable - Boolean
|
The changeability of payment account method of the user subscription |
is_switchable - Boolean
|
The possibility of the user subscription to be switched |
user_subscription_products - [AdminUserSubscriptionProduct]
|
The user subscription products (pivot relation) |
Arguments
|
|
products - [AdminProductListedAsRelation]
|
The products related to the user subscription |
Arguments
|
|
orders - [AdminUserPaymentAccountOrder]
|
The user payment account orders |
Arguments
|
|
subscription - AdminSubscription
|
The parent subscription |
switch_to_subscription - AdminSubscription
|
The subscription the User will switch to at the next renewal |
switch_from_subscription - AdminSubscription
|
The subscription the User was switch from in the past |
account - AdminUserPaymentAccount
|
The user payment account |
last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
Example
{
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": true,
"is_expired": true,
"is_suspendable": false,
"is_account_method_changeable": false,
"is_switchable": true,
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"products": [AdminProductListedAsRelation],
"orders": [AdminUserPaymentAccountOrder],
"subscription": AdminSubscription,
"switch_to_subscription": AdminSubscription,
"switch_from_subscription": AdminSubscription,
"account": AdminUserPaymentAccount,
"last_event_type": "first_payment_error"
}
AdminUserSubscriptionProduct
Description
A user subscription product
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the user subscription product |
product_id - Int
|
The id of the product |
user_subscription_id - Int
|
The id of the user subscription |
user_payment_account_order_id - Int
|
The id of the order |
purchase_num - Int
|
The item quantity of given product id |
product_price - Float
|
The set product price for given product id |
created_at - String
|
The creation date (UTC) |
renews_at - String
|
The renewal date (UTC) |
expires_at - String
|
The expiry date (UTC) |
product - AdminProduct
|
The parent product |
order - AdminUserPaymentAccountOrder
|
The user payment account order |
Example
{
"id": 42,
"product_id": 42,
"user_subscription_id": 42,
"user_payment_account_order_id": 42,
"purchase_num": 42,
"product_price": 7.99,
"created_at": "2000-12-31T12:34:56.000Z",
"renews_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"product": AdminProduct,
"order": AdminUserPaymentAccountOrder
}
Article
Description
An article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
featured_on_categories - [CategoryListedAsRelation]
|
List of categories this article is featured on |
recommended_articles - [ArticleRelated]
|
List of recommended articles |
children - [Article]
|
List of articles this article is parent of |
entitling_subscriptions - [SubscriptionListed]
|
List of subscriptions through which this article can be entitled |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": true,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"featured_on_categories": [CategoryListedAsRelation],
"recommended_articles": [ArticleRelated],
"children": [Article],
"entitling_subscriptions": [SubscriptionListed]
}
ArticleAssetLinkedTypeEnum
Description
The article asset linked type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"episode"
ArticleAssetPlay
Description
An article asset play back request
Fields
| Field Name | Description |
|---|---|
article_id - Int!
|
The id of the article |
asset_id - Int!
|
The id of the asset |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float
|
The duration of the asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - Float
|
The fractional aspect ratio of the asset (e.g. 1.778) |
linked_type - ArticleAssetLinkedTypeEnum
|
The asset linked type |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
entitlements - [ArticleAssetPlayEntitlement]
|
The asset entitlements |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
appa - Float
|
The asset absolute play position |
appr - Float
|
The asset relative play position |
pulse_updated_at - String
|
The asset pulse updated date (UTC) |
pulse_token - String
|
The asset pulse token |
concurrent_user_num - Int
|
The number of concurrent users for given article-asset |
fairplay_certificate_url - String
|
The fairplay certificate url |
user_subtitle_locale - String
|
The user preferred subtitle locale |
user_audio_locale - String
|
The user preferred audio locale |
issued_at - String
|
The date stamp (UTC) at which the current play mutation was issued |
Arguments
|
|
Example
{
"article_id": 42,
"asset_id": 42,
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 123.45,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"linked_type": "film",
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"upsell_products": [ProductListedAsRelation],
"appa": 123.45,
"appr": 0.246,
"pulse_updated_at": "2000-12-31T12:34:56.000Z",
"pulse_token": "string",
"concurrent_user_num": 42,
"fairplay_certificate_url": "https://url.example.com",
"user_subtitle_locale": "string",
"user_audio_locale": "string",
"issued_at": "2000-12-31T12:34:56.000Z"
}
ArticleAssetPlayEntitlement
Description
An article asset play back entitlement
Fields
| Field Name | Description |
|---|---|
media_provider - String
|
The media provider |
encryption_type - String
|
The type of encryption |
encryption_provider - String
|
The encryption provider |
manifest - String
|
Streaming endpoint manifests |
protocol - String
|
The stream type |
mime_type - String
|
The stream mime type |
token - String
|
Play back entitlement token |
content_key_id - String
|
The content key id of the entitlement |
key_delivery_url - String
|
Key delivery url |
hls_key_uri - String
|
Key delivery uri |
expires_in - Int
|
Play back entitlement token ttl |
download_expires_in - Int
|
download policy ttl |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
Example
{
"media_provider": "string",
"encryption_type": "string",
"encryption_provider": "string",
"manifest": "string",
"protocol": "string",
"mime_type": "string",
"token": "string",
"content_key_id": "string",
"key_delivery_url": "https://url.example.com",
"hls_key_uri": "string",
"expires_in": 86400,
"download_expires_in": 86400,
"is_live": true
}
ArticleDiscoverabilityEnum
Description
The article discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
ArticleEntitlingResources
Description
The entitling resources (products and subscriptions) for a given article
Fields
| Field Name | Description |
|---|---|
subscriptions - [SubscriptionListed]
|
The entitling subscriptions |
products - [ProductListed]
|
The entitling products |
Example
{
"subscriptions": [SubscriptionListed],
"products": [ProductListed]
}
ArticleFeatured
Description
A featured article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListFilterTypeEnum
Description
The article list filter type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"trending"
ArticleListed
Description
An listed article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListedAsRelation
Description
A listed related article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListedAsResource
Description
A listed article resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
ArticleMeta
Description
An article metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
article_id - Int
|
The metadata property parent article id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42
}
ArticleMetaTranslation
Description
An article metadata translation
Example
{
"id": 42,
"value": "string",
"locale": "string",
"article_meta_id": 42
}
ArticlePlayAudioQualityEnum
Description
The audio stream quality
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"audio_512kb"
ArticlePlayProtocolEnum
Description
The media stream protocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"mss"
ArticlePlayResolutionEnum
Description
The media stream resolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"w3840_h2160"
ArticleRelated
Description
A related article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
asset_id - Int
|
The asset id |
is_favourite - Boolean
|
Is article marked as favourite (only relevant if this related article represents a viewed user article) |
is_continue - Boolean
|
Is article marked as continue watching (only relevant if this related article represents a viewed user article) |
is_history - Boolean
|
Is article marked as history (only relevant if this related article represents a viewed user article) |
subtitle_locale - String
|
The user-selected subtitle locale (only relevant if this related article represents a viewed user article) |
audio_locale - String
|
The user-selected audio locale (only relevant if this related article represents a viewed user article) |
rating_value - Float
|
The user-assigned rating value of the article (only relevant if this related article represents a viewed user article) |
root_article_id - Int
|
The root id of the entitled article, i.e. the first ancestor (typically an Article of type series) |
appa - Float
|
The asset absolute play position (only relevant if this related article represents a viewed user article) |
appr - Float
|
The asset relative play position (only relevant if this related article represents a viewed user article) |
linked_type - ArticleAssetLinkedTypeEnum
|
The linked asset type |
entitling_product_id - Int
|
The id of the product that entitled this article (only relevant if this related article represents an entitled article) |
issuing_user_payment_account_order_id - Int
|
The id of the user-payment-account-order that issued this entitled article (only relevant if this related article represents an entitled article) |
is_entitlement_expired - Boolean
|
The entitlement of the article has expired (only relevant if this related article represents an entitled article) |
expires_in - Int
|
The expiry interval (seconds), (only relevant if this related article represents an entitled article) |
expires_at - String
|
The entitlement expiry date (UTC), (only relevant if this related article represents an entitled article) |
entitled_at - String
|
The entitlement date (UTC), (only relevant if this related article represents an entitled article) |
nomadic_updated_at - String
|
The last updated date (UTC) of the nomadic article-asset (only relevant if this related article represents a viewed user article) |
nomadic_completed_at - String
|
The completion date (UTC) of the nomadic article-asset (only relevant if this related article represents a viewed user article) |
nomadic_num_completed - Int
|
The number of times the nomadic article-asset has been completely viewed (only relevant if this related article represents a viewed user article) |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"asset_id": 42,
"is_favourite": false,
"is_continue": true,
"is_history": false,
"subtitle_locale": "string",
"audio_locale": "string",
"rating_value": 987.65,
"root_article_id": 42,
"appa": 123.45,
"appr": 0.246,
"linked_type": "film",
"entitling_product_id": 42,
"issuing_user_payment_account_order_id": 42,
"is_entitlement_expired": true,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"entitled_at": "2000-12-31T12:34:56.000Z",
"nomadic_updated_at": "2000-12-31T12:34:56.000Z",
"nomadic_completed_at": "2000-12-31T12:34:56.000Z",
"nomadic_num_completed": 42
}
ArticleTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"episode"
ArticlesListedWithPagination
Description
Article list with pagination
Fields
| Field Name | Description |
|---|---|
items - [ArticleListed]
|
|
pagination - Pagination
|
Example
{
"items": [ArticleListed],
"pagination": Pagination
}
Asset
Description
An asset
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the asset |
project_id - Int!
|
The project id of the asset |
source_blob_name - String
|
Source blob name |
thumbnail_asset_id - String
|
Thumbnail asset id |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
type - AssetTypeEnum
|
Asset type |
linked_type - ArticleAssetLinkedTypeEnum
|
Linked asset type |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float!
|
The duration asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - String
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
screenshots - [File]
|
List of screenshot images |
playable_from - String
|
Visible-from date (UTC) for the asset (typically used to indicate when a live event will begin). |
playable_until - String
|
Visible-until date (UTC) for the asset (typically used to indicate when a live event will end). |
published_from - String
|
Publish-from date (UTC) for the asset |
published_until - String
|
Publish-until date (UTC) for the asset |
created_at - String
|
The creation date (UTC) of the asset |
updated_at - String
|
The last modification date (UTC) of the asset |
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 123.45,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AssetEncodingProfileNameEnum
Description
The name of the Asset encoding profile
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"sd_540p_16x9"
AssetEncryptionProfileNameEnum
Description
The name of the Asset encryption profile
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"none"
AssetStatusEnum
Description
The asset status types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"source_asset_created"
AssetTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"audio"
AuthPage
Description
An authenticated-only or authorized-only page
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the page |
parent_id - Int
|
|
name - String
|
The name of the page |
url_slug - String
|
The url slug of the page |
Arguments
|
|
full_url_slug - String
|
The full url slug of the page |
Arguments
|
|
canonical_url - String
|
The canonical url of the page |
title - String
|
The title of the page |
type - PageTypeEnum
|
The type of the page |
visibility - ResourceVisibilityEnum
|
Visibility of the page |
geo_region_code - String
|
The geo-region code to which this Page is restricted (depending on the specific User environment) |
locale - String
|
locale to which this Page is restricted (depending on the specific User environment) |
Example
{
"id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"title": "string",
"type": "account_delete",
"visibility": "everyone",
"geo_region_code": "nl",
"locale": "string"
}
Authenticate
Description
Authentication credentials
Fields
| Field Name | Description |
|---|---|
access_token - String
|
The authentication token |
refresh_token - String
|
The refresh token |
expires_in - Int
|
Expiration time in seconds |
token_type - String
|
The access token type |
user_id - Int
|
The user id belonging to the authentication token (in case token was issued for an administrator, this property represents the user id of that administrator) |
user_email - String
|
The user email belonging to the authentication token (in case token issued for an administrator, this property represents the email address of that administrator) |
active_project_id - Int
|
The active project_id for the issued authentication token |
url - String
|
A url relevant for given credentials may be issued if applicable |
Example
{
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CategoriesListedWithPagination
Description
Category list with pagination
Fields
| Field Name | Description |
|---|---|
items - [CategoryListed]
|
|
pagination - Pagination
|
Example
{
"items": [CategoryListed],
"pagination": Pagination
}
Category
Description
A category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [CategoryMeta]
|
List of category metadata properties |
Arguments
|
|
articles - [ArticleListedAsRelation]
|
List of articles in this category |
Arguments
|
|
products - [ProductListedAsRelation]
|
List of products in this category |
Arguments
|
|
featured_articles - [ArticleFeatured]
|
List of articles directly linked to this category |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The parent id of the category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
posters - [File]
|
List of posters |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [CategoryMeta],
"articles": [ArticleListedAsRelation],
"products": [ProductListedAsRelation],
"featured_articles": [ArticleFeatured],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"posters": [File]
}
CategoryListFilterTypeEnum
Description
The article list filter type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"article_taggable"
CategoryListed
Description
A listed category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [CategoryMeta]
|
List of category metadata properties |
Arguments
|
|
articles - [ArticleListedAsRelation]
|
List of articles in this category |
Arguments
|
|
products - [ProductListedAsRelation]
|
List of products in this category |
Arguments
|
|
featured_articles - [ArticleFeatured]
|
List of articles in this category |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The parent id of the category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [CategoryMeta],
"articles": [ArticleListedAsRelation],
"products": [ProductListedAsRelation],
"featured_articles": [ArticleFeatured],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
CategoryListedAsRelation
Description
A listed relational category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [CategoryMeta]
|
List of category metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The parent id of the category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [CategoryMeta],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
CategoryListedAsResource
Description
A listed category resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
CategoryMeta
Description
A category metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
category_id - Int
|
The metadata property parent category id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42
}
CategoryMetaTranslation
Description
A category metadata translation
Example
{
"id": 42,
"value": "string",
"locale": "string",
"category_meta_id": 42
}
CategoryTypeEnum
Description
The category type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article_label"
ClientPayload
Config
Description
General app config
Fields
| Field Name | Description |
|---|---|
environment - String
|
Environment |
locale - String
|
The activated locale |
geo_region_code - String
|
The activated geo region code |
project_id - Int
|
The project id |
is_authenticated - Boolean
|
Is user authenticated |
has_subscriptions - Boolean
|
Project has subscriptions |
has_auto_canonical_urls - Boolean
|
Project has auto-generated canonical urls |
has_credits - Boolean
|
Project has credits |
has_metric_action_fulfilment_notifications - Boolean
|
Project has metric action fulfilment notifications |
has_subscription_payment_registration_integration - Boolean
|
Project has payment flow integrated with registration |
has_subscription_payment_pricing_before_registration - Boolean
|
Project has subscription pricing shown before registration |
has_subscription_credit_integration - Boolean
|
Project has credits integrated within subscriptions |
has_entitlements - Boolean
|
Project has entitlements |
has_geo_restrictions - Boolean
|
Project has geo_restrictions |
has_article_favourites - Boolean
|
Project has article favourites |
has_article_ratings - Boolean
|
Project has article ratings |
has_article_nomadics - Boolean
|
Project has article nomadics |
has_article_series_nomadics - Boolean
|
Project has article nomadics in series |
has_article_entitlements - Boolean
|
Project has article entitlements |
has_article_history - Boolean
|
Project has article history |
has_article_recommendations - Boolean
|
Project has article recommendations |
has_article_offline_downloads - Boolean
|
Project has offline article downloads |
has_article_purchase_buttons - Boolean
|
Project has purchase buttons separately displayed on the article detail pages |
has_product_purchase_affiliation_categories - Boolean
|
Project has affiliation categories for products, to be displayed in the purchase modals |
has_subscription_purchase_affiliation_categories - Boolean
|
Project has affiliation categories for subscriptions, to be displayed in the purchase modals |
has_product_checkout_cart_in_menu - Boolean
|
The checkout cart is displayed in the main menu and accessible by clicking it |
has_checkout_combined_login_registration - Boolean
|
Project shows combined login and registration modal during checkout instead of only a registration form |
is_affiliation_category_selection_required - Boolean
|
Project affiliation category must be selected on purchase checkout |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
streampulse_completion_ratio - Float
|
Default ratio at which a video is considered to be completed |
encryption_fairplay_certificate_url - String
|
Encryption FairPlay certificate url |
article_ribbon_settings - [StructureKeyValueStringPair]
|
Article thumbnail ribbon settings |
article_offline_download_settings - [StructureKeyValueStringPair]
|
Article offline download settings |
article_recently_added_ttl - Int
|
Article ttl in seconds of items eligible for status "recently added" |
article_nomadic_visibility_ttl - Int
|
Article ttl in seconds of items eligible for status "nomadic" (i.e. continue watching) |
article_nomadic_visibility_max_num - Int
|
Article maximum number of visible nomadic items |
article_history_visibility_max_num - Int
|
Article maximum number of visible history items |
platform - ConfigPlatformEnvironment
|
Project platform specific environment variables |
urls - [StructureKeyValueStringPair]
|
Project urls |
base_url_slugs - [ConfigBaseUrlSlug]
|
Project website base url slugs |
locale_translations - [String]
|
A list of available translations |
locale_regions - [LocaleRegion]
|
A list of available locale regions |
image_resize_resolutions - [ImageResolution]
|
A list of image resolutions |
social_media_channels - [StructureKeyValueStringPair]
|
Social media channels of the project |
social_media_sharing_channels - [String]
|
Social media channels to which users can share pages |
subscriptions - [SubscriptionListed]
|
A list of subscriptions |
general_credit_upsell_products - [ProductListedAsRelation]
|
A list of credit products intended for up-sell |
payment_providers - [PaymentProviderListed]
|
A list of payment providers |
oauth_providers - [OauthProviderListed]
|
A list of OAuth2 Providers |
language_tags - [LanguageTag]
|
A list of language tags |
menus - [Menu]
|
A list of menus |
pages - [Page]
|
The pages configured for this project (for efficiency restrict to types like "home" which are necessary for first-page-load only) |
Arguments
|
|
auth_pages - [AuthPage]
|
A list of authenticated-only or authorized-only pages |
metric_actions - [MetricAction]
|
Metric actions |
notification_topics - [NotificationTopic]
|
Notification topics |
genders - [Gender]
|
A list of gender types |
gender_types - [String]
|
A list of gender types |
article_asset_linked_types - [String]
|
Project default article asset linked types |
article_types - [String]
|
Project default article types |
category_types - [String]
|
Project default category types |
page_types - [String]
|
Project default page types |
page_component_types - [String]
|
Project default page component types |
page_component_element_types - [String]
|
Project default page component element types |
voucher_claimable_product_types - [String]
|
Project product types that can be claimed with a voucher |
voucher_claimable_subscription_types - [String]
|
Project subscription types that can be claimed with a voucher |
amount_balance_purchasable_product_types - [String]
|
Project product types that can be purchased with amount balance |
amount_balance_purchasable_subscription_types - [String]
|
Project subscription types that can be purchased with amount balance |
user_consent_types - [String]
|
Project user consent types |
Example
{
"environment": "string",
"locale": "string",
"geo_region_code": "nl",
"project_id": 42,
"is_authenticated": false,
"has_subscriptions": true,
"has_auto_canonical_urls": "https://url.example.com",
"has_credits": true,
"has_metric_action_fulfilment_notifications": true,
"has_subscription_payment_registration_integration": false,
"has_subscription_payment_pricing_before_registration": true,
"has_subscription_credit_integration": true,
"has_entitlements": true,
"has_geo_restrictions": false,
"has_article_favourites": false,
"has_article_ratings": true,
"has_article_nomadics": true,
"has_article_series_nomadics": false,
"has_article_entitlements": false,
"has_article_history": false,
"has_article_recommendations": false,
"has_article_offline_downloads": true,
"has_article_purchase_buttons": true,
"has_product_purchase_affiliation_categories": true,
"has_subscription_purchase_affiliation_categories": false,
"has_product_checkout_cart_in_menu": false,
"has_checkout_combined_login_registration": true,
"is_affiliation_category_selection_required": true,
"max_concurrent_vod_stream_num": 42,
"streampulse_completion_ratio": 123.45,
"encryption_fairplay_certificate_url": "https://url.example.com",
"article_ribbon_settings": [
StructureKeyValueStringPair
],
"article_offline_download_settings": [
StructureKeyValueStringPair
],
"article_recently_added_ttl": 42,
"article_nomadic_visibility_ttl": 42,
"article_nomadic_visibility_max_num": 42,
"article_history_visibility_max_num": 42,
"platform": ConfigPlatformEnvironment,
"urls": ["https://url.example.com"],
"base_url_slugs": ["url-slug-string"],
"locale_translations": ["string"],
"locale_regions": [LocaleRegion],
"image_resize_resolutions": [ImageResolution],
"social_media_channels": [StructureKeyValueStringPair],
"social_media_sharing_channels": [
"string"
],
"subscriptions": [SubscriptionListed],
"general_credit_upsell_products": [
ProductListedAsRelation
],
"payment_providers": [PaymentProviderListed],
"oauth_providers": [OauthProviderListed],
"language_tags": [LanguageTag],
"menus": [Menu],
"pages": [Page],
"auth_pages": [AuthPage],
"metric_actions": [MetricAction],
"notification_topics": [NotificationTopic],
"genders": [Gender],
"gender_types": ["string"],
"article_asset_linked_types": ["film"],
"article_types": ["string"],
"category_types": ["string"],
"page_types": ["string"],
"page_component_types": ["string"],
"page_component_element_types": [
"string"
],
"voucher_claimable_product_types": [
"string"
],
"voucher_claimable_subscription_types": [
"string"
],
"amount_balance_purchasable_product_types": [
"string"
],
"amount_balance_purchasable_subscription_types": [
"string"
],
"user_consent_types": ["string"]
}
ConfigBaseUrlSlug
ConfigPlatformEnvironment
Description
General platform environment config
Fields
| Field Name | Description |
|---|---|
grid_configuration - [StructureKeyValueIntegerPair]
|
Project platform grid configuration |
image_configuration - [StructureKeyValueArrayKeyValueIntegerPair]
|
Project platform image configuration |
display_configuration_article_metadata_main - [StructureKeyValueStringPair]
|
Project platform article metadata main display configuration |
display_configuration_article_metadata_top - [StructureKeyValueStringPair]
|
Project platform article metadata top display configuration |
display_configuration_article_metadata_bottom - [StructureKeyValueStringPair]
|
Project platform article metadata bottom display configuration |
display_configuration_article_metadata_tooltip - [StructureKeyValueStringPair]
|
Project platform article metadata tooltip display configuration |
display_configuration_article_metadata_embed_player - [StructureKeyValueStringPair]
|
Project platform article metadata embed player display configuration |
captcha_site_key - String
|
The key used for signing reCaptcha requests in the frontend apps |
chromecast_receiver_app_id - String
|
Project platform chromecast receiver app id |
analytics_api - String
|
Project platform analytics api |
analytics_fbpx_id - String
|
Project platform facebook pixel id |
analytics_ga_id - String
|
Project platform google analytics tracking id |
analytics_gtm_id - String
|
Project platform google tag manager id |
analytics_mode - String
|
Project platform analytics mode |
contact_form_file_upload_max_num - Int
|
Project platform contact form maximum number of files allowed for upload |
contact_form_file_upload_max_size - Int
|
Project platform contact form maximum size per uploaded file |
is_display_browser_not_supported_warning - Boolean
|
Project platform display browser-not-supported warning |
is_display_carousel_bullets - Boolean
|
Project platform display carousel bullets |
is_display_carousel_metadata_inside_item - Boolean
|
Project platform display carousel metadata inside the thumbnail |
is_display_cookie_bar - Boolean
|
Project platform display cookie bar |
is_display_cookie_bar_combined_consents - Boolean
|
Project platform display combined consents in cookie bar |
is_allow_account_registration - Boolean
|
Project platform allow account registration |
is_allow_subscription_currency_payments - Boolean
|
Project platform allow subscription currency payments |
is_allow_product_currency_payments - Boolean
|
Project platform allow product currency payments |
is_allow_product_credit_payments - Boolean
|
Project platform allow product credit payments |
is_support_player_video_seeking - Boolean
|
Project platform supports player video seeking |
is_support_player_time_indexation - Boolean
|
Project platform supports player time indexation |
is_support_player_playback_speed_change - Boolean
|
Project platform supports player speed change |
is_support_player_locale_selection_storage - Boolean
|
Project platform supports player storage of user locale selection on audio and subtitle tracks |
is_support_player_playback_skip_interval - Boolean
|
Project platform supports player video interval seeking |
is_display_article_carousel_zoom - Boolean
|
Project platform display of subtle thumbnail zoom-effect when hovering over an Article thumbnail |
is_display_article_episode_detail_page - Boolean
|
Project platform display of article episode pages |
is_display_article_metadata_tooltip - Boolean
|
Project platform display of article tooltip with metadata in carousels |
random_page_cache_ttl - Int
|
Project platform random page redirecter cache ttl |
default_seo_title - String
|
default seo title of the project |
default_seo_description - String
|
default seo description of the project |
default_seo_keywords - String
|
default seo keywords of the project |
default_seo_og_title - String
|
default seo open-graph title of the project |
default_seo_og_description - String
|
default seo open-graph description of the project |
Example
{
"grid_configuration": [StructureKeyValueIntegerPair],
"image_configuration": [
StructureKeyValueArrayKeyValueIntegerPair
],
"display_configuration_article_metadata_main": [
StructureKeyValueStringPair
],
"display_configuration_article_metadata_top": [
StructureKeyValueStringPair
],
"display_configuration_article_metadata_bottom": [
StructureKeyValueStringPair
],
"display_configuration_article_metadata_tooltip": [
StructureKeyValueStringPair
],
"display_configuration_article_metadata_embed_player": [
StructureKeyValueStringPair
],
"captcha_site_key": "string",
"chromecast_receiver_app_id": "string",
"analytics_api": "string",
"analytics_fbpx_id": "string",
"analytics_ga_id": "string",
"analytics_gtm_id": "string",
"analytics_mode": "string",
"contact_form_file_upload_max_num": 42,
"contact_form_file_upload_max_size": 42,
"is_display_browser_not_supported_warning": true,
"is_display_carousel_bullets": false,
"is_display_carousel_metadata_inside_item": true,
"is_display_cookie_bar": false,
"is_display_cookie_bar_combined_consents": false,
"is_allow_account_registration": true,
"is_allow_subscription_currency_payments": "EUR",
"is_allow_product_currency_payments": "EUR",
"is_allow_product_credit_payments": true,
"is_support_player_video_seeking": true,
"is_support_player_time_indexation": true,
"is_support_player_playback_speed_change": false,
"is_support_player_locale_selection_storage": false,
"is_support_player_playback_skip_interval": false,
"is_display_article_carousel_zoom": true,
"is_display_article_episode_detail_page": true,
"is_display_article_metadata_tooltip": true,
"random_page_cache_ttl": 42,
"default_seo_title": "string",
"default_seo_description": "string",
"default_seo_keywords": "string",
"default_seo_og_title": "string",
"default_seo_og_description": "string"
}
CoreProject
Description
A core project
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the project |
name - String
|
The name of project |
created_at - String
|
The creation date (UTC) of the project |
updated_at - String
|
The last modification date (UTC) of the project |
users - [CoreUser]
|
Related list of users |
managers - [CoreUser]
|
Related list of managers |
status - Int
|
The status of project |
status_label - String
|
The status label of project |
Example
{
"id": 42,
"name": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"users": [CoreUser],
"managers": [CoreUser],
"status": "string",
"status_label": "string"
}
CoreUser
Description
Details of a user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
metas - [CoreUserMeta]
|
List of user metadata properties |
Arguments
|
|
managed_projects - [CoreProject]
|
List of managed projects |
managed_roles - [Role]
|
Roles that can be managed by given user |
recent_project - CoreProject
|
Last accessed project |
roles - [Role]
|
User roles |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"metas": [CoreUserMeta],
"managed_projects": [CoreProject],
"managed_roles": [Role],
"recent_project": CoreProject,
"roles": [Role]
}
CoreUserMeta
Description
A core user metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
user_id - Int
|
The metadata property parent user id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
translations - [UserMetaTranslation]
|
The translations for given metadata property |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
Example
{
"id": 42,
"user_id": 42,
"key": "string",
"value": "string",
"translations": [UserMetaTranslation],
"type": "array",
"format": "string"
}
Device
Description
A device
Example
{
"id": 42,
"name": "string",
"uuid": "string",
"project_id": 42,
"user_id": 42,
"created_at": "2000-12-31T12:34:56.000Z"
}
DeviceListed
Description
A listed device
Example
{
"id": 42,
"name": "string",
"uuid": "string",
"project_id": 42,
"user_id": 42,
"created_at": "2000-12-31T12:34:56.000Z"
}
DeviceModelContextEnum
Description
The device model context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"chromecast_legacy"
DevicePairingCode
Description
Device pairing code
Example
{
"pairing_code": "string",
"uuid": "string",
"name": "string",
"expires_in": 86400
}
DeviceTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"unknown"
DevicesListedWithPagination
Description
Device list with pagination
Fields
| Field Name | Description |
|---|---|
items - [DeviceListed]
|
|
pagination - Pagination
|
Example
{
"items": [DeviceListed],
"pagination": Pagination
}
File
Description
A file
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the file |
name - String
|
The original name of the file |
title - String
|
The alt/title of the file |
type - FileTypeEnum
|
The type of the file |
size - Int
|
The size of the file |
width - Int
|
The width of the file |
height - Int
|
The height of the file |
aspect_ratio_profile - String
|
The aspect ratio profile |
duration - Int
|
The duration of the (audio/video) file (seconds) |
locale - String
|
The language locale code of the file |
locale_label - String
|
The language locale label of the file |
base_url - String
|
The base url of the file |
base_path - String
|
The base url path of the file |
url - String
|
The url of the file |
proxy_file_path - String
|
The proxy url of the file |
proxy_url - String
|
The proxy url of the file |
file_name - String
|
The name of the file |
file_path - String
|
The path of the file |
Example
{
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string"
}
FileSubtitleFormatEnum
Description
The subtitle file format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"vtt"
FileTypeEnum
Description
The file type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"binary"
FilterByInput
Description
A filter-by input property
Fields
| Input Field | Description |
|---|---|
field - String
|
The field to filter on |
logic_operator - LogicOperatorEnum
|
The operator to apply |
value - String
|
The field value to filter on |
Example
{
"field": "string",
"logic_operator": "equals",
"value": "string"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
Gender
GeoRegion
GeoRegionListed
GeoRegionsListedWithPagination
Description
Geo region list with pagination
Fields
| Field Name | Description |
|---|---|
items - [GeoRegionListed]
|
|
pagination - Pagination
|
Example
{
"items": [GeoRegionListed],
"pagination": Pagination
}
ImageResolution
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
42
LanguageTag
Description
Language tag
Fields
| Field Name | Description |
|---|---|
key - String
|
The name of language tag |
value - String
|
The value of language tag |
format - MetaFormatEnum
|
The value rendering format |
id - Int!
|
The id of the language tag |
project_id - Int!
|
The project id of the language tag |
platform_context - String
|
The platform context of the language tag |
Example
{
"key": "string",
"value": "string",
"format": "date",
"id": 42,
"project_id": 42,
"platform_context": "string"
}
LocaleRegion
LogicOperatorEnum
Description
The logic operator type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"equals"
Menu
Description
A menu
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the menu |
project_id - Int!
|
The project id of the menu |
name - String
|
The name of the menu |
platform_contexts - [String]
|
The platform contexts of the menu |
locale_regions - [LocaleRegion]
|
List of locale regions this menu belongs to |
geo_regions - [GeoRegion]
|
List of geo regions this menu belongs to |
components - [MenuComponent]
|
The menu components |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [MenuComponent]
}
MenuComponent
Description
A menu component
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the component |
parent_id - Int
|
|
menu_id - Int!
|
The menu id of the component |
page_id - Int
|
The page id of the component |
page_full_url_slug - String
|
The full page url slug of the component |
type - MenuComponentTypeEnum
|
The type of the component |
title - String
|
The title of the component |
content - String
|
The content of the component |
Arguments
|
|
url - String
|
The url of the component |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"parent_id": 42,
"menu_id": 42,
"page_id": 42,
"page_full_url_slug": "url-slug-string",
"type": "button_url_link",
"title": "string",
"content": "string",
"url": "https://url.example.com",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File]
}
MenuComponentTypeEnum
Description
The menu component type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"button_url_link"
MetaFormatEnum
Description
The metadata format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"date"
MetaOutputTypeEnum
Description
The metadata output type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"html"
MetaTypeEnum
Description
The metadata type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"array"
MetricAction
Description
A metric action
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric action |
project_id - Int!
|
The project id of the metric action |
name - String
|
The name of the metric action |
title - String
|
The title of the metric action |
content - String
|
The content of the metric action |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
files - [File]
|
List of files |
Arguments
|
|
fulfilled_at - String
|
The user fulfilment date (UTC) of the metric action |
acknowledged_at - String
|
The user acknowledgement date (UTC) of the metric action |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"title": "string",
"content": "string",
"icons": [File],
"images": [File],
"files": [File],
"fulfilled_at": "2000-12-31T12:34:56.000Z",
"acknowledged_at": "2000-12-31T12:34:56.000Z"
}
MetricActionStatusEnum
Description
The metric action status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
MetricActionTypeEnum
Description
The metric action type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_entitlement"
MetricConditionTypeEnum
Description
The metric condition type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"appa"
MetricStatusEnum
Description
The metric status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
MetricTypeEnum
Description
The metric type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"article"
NotificationDeliveryTypeEnum
Description
The notification delivery type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"generic_users_on_topic"
NotificationTopic
Description
A notification topic
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification topic |
remote_notification_topic_id - String
|
The remote id of the notification topic (e.g. used for in-app push notifications) |
project_id - Int!
|
The project id of the notification topic |
name - String
|
The name of the notification topic |
title - String
|
The title of the notification topic |
description - String
|
The content of the notification topic |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string"
}
NotificationTopicTypeEnum
Description
The notification topic type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"general"
NotificationTopicsListedWithPagination
Description
Notification topic list with pagination
Fields
| Field Name | Description |
|---|---|
items - [NotificationTopic]
|
|
pagination - Pagination
|
Example
{
"items": [NotificationTopic],
"pagination": Pagination
}
NotificationTypeEnum
Description
The notification type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"single"
OauthProviderListed
Description
A listed OAuth2 provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the OAuth2 provider |
project_id - Int!
|
The project id of the OAuth2 provider |
call_to_action_tag - String
|
The call-to-action tag of the OAuth2 provider |
init_url - String
|
The URL to initiate an OAuth2 authentication flow with given OAuth2 provider |
call_to_action_icon_url - String
|
Icon to be display near the call to action tag or button |
Example
{
"id": 42,
"project_id": 42,
"call_to_action_tag": "string",
"init_url": "https://url.example.com",
"call_to_action_icon_url": "https://url.example.com"
}
OauthProvidersListedWithPagination
Description
An OAuth2 provider list with pagination
Fields
| Field Name | Description |
|---|---|
items - [OauthProviderListed]
|
|
pagination - Pagination
|
Example
{
"items": [OauthProviderListed],
"pagination": Pagination
}
OperatorContextEnum
Description
The operator context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"android"
Page
Description
A page
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the page |
project_id - Int!
|
The project id of the page |
category_id - Int
|
The category id of the page |
parent_id - Int
|
|
name - String
|
The name of the page |
url_slug - String
|
The url slug of the page |
Arguments
|
|
full_url_slug - String
|
The full url slug of the page |
Arguments
|
|
canonical_url - String
|
The canonical url of the page |
title - String
|
The title of the page |
type - PageTypeEnum
|
The type of the page |
is_in_sitemap - Boolean
|
Listing in general sitemap |
platform_contexts - [String]
|
The platform contexts of the page |
locale_regions - [LocaleRegion]
|
List of locale regions this page belongs to |
geo_regions - [GeoRegion]
|
List of geo regions this menu belongs to |
metas - [PageMeta]
|
List of page metadata properties |
Arguments
|
|
components - [PageComponent]
|
The page components |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
geo_region_code - String
|
The geo-region code to which this Page is restricted (depending on the specific User environment) |
locale - String
|
locale to which this Page is restricted (depending on the specific User environment) |
Example
{
"id": 42,
"project_id": 42,
"category_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"title": "string",
"type": "account_delete",
"is_in_sitemap": false,
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"metas": [PageMeta],
"components": [PageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"geo_region_code": "nl",
"locale": "string"
}
PageComponent
Description
A page component
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the component |
page_id - Int!
|
The page id of the component |
parent_id - Int
|
|
category_id - Int
|
Deprecated in favour of resource_categories |
title - String
|
The title of the component |
content - String
|
The content of the component |
url - String
|
The url of the component |
value - String
|
The value of the component |
style_type - String
|
The style type of the component |
display_type - String
|
The display type of the component |
type - PageComponentTypeEnum
|
The type of the component |
elements - [PageComponentElement]
|
The page component elements |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
List of resource articles |
resource_categories - [CategoryListedAsResource]
|
List of resource categories |
resource_pages - [PageListedAsResource]
|
List of resource pages |
resource_products - [ProductListedAsResource]
|
List of resource products |
resource_subscriptions - [SubscriptionListedAsResource]
|
List of resource subscriptions |
Example
{
"id": 42,
"page_id": 42,
"parent_id": 42,
"category_id": 42,
"title": "string",
"content": "string",
"url": "https://url.example.com",
"value": "string",
"style_type": "string",
"display_type": "string",
"type": "account_create",
"elements": [PageComponentElement],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"resource_articles": [ArticleListedAsResource],
"resource_categories": [CategoryListedAsResource],
"resource_pages": [PageListedAsResource],
"resource_products": [ProductListedAsResource],
"resource_subscriptions": [SubscriptionListedAsResource]
}
PageComponentElement
Description
A page component element
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the element |
page_component_id - Int!
|
The page component id of the element |
parent_id - Int
|
|
type - String
|
The type of the element |
title - String
|
The title of the element |
content - String
|
The content of the element |
label - String
|
The label of the element |
url - String
|
The url of the element |
value - String
|
The value of the element |
toggle - Boolean
|
The value of the toggle |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
List of resource articles |
resource_categories - [CategoryListedAsResource]
|
List of resource categories |
resource_pages - [PageListedAsResource]
|
List of resource pages |
resource_products - [ProductListedAsResource]
|
List of resource products |
resource_subscriptions - [SubscriptionListedAsResource]
|
List of resource subscriptions |
Example
{
"id": 42,
"page_component_id": 42,
"parent_id": 42,
"type": "string",
"title": "string",
"content": "string",
"label": "string",
"url": "https://url.example.com",
"value": "string",
"toggle": true,
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"resource_articles": [ArticleListedAsResource],
"resource_categories": [CategoryListedAsResource],
"resource_pages": [PageListedAsResource],
"resource_products": [ProductListedAsResource],
"resource_subscriptions": [SubscriptionListedAsResource]
}
PageComponentTypeEnum
Description
The page component type
Values
| Enum Value | Description |
|---|---|
|
|
This component allows you to configure the registration form a User must fill out to create a User account. |
|
|
This component allows you to configure the notification a User sees when registration is not allowed (typically due to geo-region restrictions). |
|
|
This component allows you to configure the "delete account" button on the payment account page, through which a User can initiate account deletion conform GDPR. |
|
|
This component displays all Articles a User is entitled to watch, either through purchase, rental or voucher redemption. |
|
|
This component displays all Articles a User has marked as "favourite". |
|
|
This component displays the most recent Articles a User has previously completely watched. |
|
|
This component displays the most recent Articles a User has not yet completely watched, so that they can continue watching. |
|
|
This component allows you to configure a large click-area which you can fill with an image/poster and text. Clicking the area directs the User to a given Page. |
|
|
This component allows you to configure a large click-area which you can fill with an image/poster and text. Clicking the area directs the User to a given Url. |
|
|
This component allows you to configure a large carousel, typically displayed a the top of a Page. The carousel can contain multiple slides, which allow you to display large posters or videos, and configure calls to action. |
|
|
This component allows you to configure an overview of all the child-Categories for a given Category. Clicking a Category directs the User to an automatically generated Category detail Page. |
|
|
This component allows you to configure a default carousel which displays all the Articles for a given Category. |
|
|
This component allows you to configure a block of custom HTML and/or JavaScript. |
|
|
This component is the placeholder under which you can configure the pairing code input field, and overview of already paired devices. |
|
|
This component allows you to configure the main filter section, under which multiple filter categories can be placed. Typically one filter section is sufficient. |
|
|
This component displays a generic support form, which a User can fill out. The contents of the form are sent to your support e-mail address which you have configured in the MailService. |
|
|
This component displays and overview of all fulfilled gamification actions, i.e. their "achievements". |
|
|
This component allows you to configure an overview of all the child-Pages for given Page (of type "blog"). It is typically used to show all available blogs. |
|
|
This component allows you to configure the main profile section that is displayed on the WEB/MOBILE profile page. There can be only component of this type on the Page. |
|
|
This component allows you to configure a call-to-action which leads to a random sub-page, given a provided parent Page. The typicall use-case is to offer the User a random Blog page ("pick a card"). |
|
|
This component allows you to configure a relative or absolute Url, to which the User must be redirected. |
|
|
This component allows you to configure a randomly selected Page, to which the User must be redirected. |
|
|
This component allows you to configure a pre-styled wide component well suited to display a short tag-line or quote. |
|
|
This component allows you to configure the main account detail section that is displayed on the WEB/MOBILE payment-account page. There can be only component of this type on the Page. |
|
|
This component allows you to configure a pricing overview with one or more Subscription banners. When placed on a Page of type "pricing", it defines the default Subscriptions that are automatically offered in the purchase flow. When placed on a Page of type "text", it allows you to create specific landing pages that offer given Subscriptions. |
|
|
This component is a basic multi-purpose component that allows you to place content on a Page using a WYSIWYG-editor. |
|
|
This component allows you to display multiple text/content blocks in a carousel, e.g. a set of short news messages or testimonials. |
|
|
This component allows you to display a few (typically 1-3) small text/content blocks side-by-side, e.g. a set of unique selling points (USPs). |
Example
"account_create"
PageListed
Description
A listed page
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the page |
project_id - Int!
|
The project id of the page |
category_id - Int
|
The category id of the page |
parent_id - Int
|
|
name - String
|
The name of the page |
url_slug - String
|
The url slug of the page |
Arguments
|
|
full_url_slug - String
|
The full url slug of the page |
Arguments
|
|
canonical_url - String
|
The canonical url of the page |
title - String
|
The title of the page |
type - PageTypeEnum
|
The type of the page |
is_in_sitemap - Boolean
|
Listing in general sitemap |
platform_contexts - [String]
|
The platform contexts of the page |
locale_regions - [LocaleRegion]
|
List of locale regions this page belongs to |
geo_regions - [GeoRegion]
|
List of geo regions this menu belongs to |
metas - [PageMeta]
|
List of page metadata properties |
Arguments
|
|
components - [PageComponent]
|
The page components |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"category_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"title": "string",
"type": "account_delete",
"is_in_sitemap": true,
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"metas": [PageMeta],
"components": [PageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File]
}
PageListedAsResource
Description
A listed page resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
PageMeta
Description
A page metadata property
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"page_id": 42
}
PageTypeEnum
Description
The page type
Values
| Enum Value | Description |
|---|---|
|
|
A WEB/MOBILE page with this type is used to offer the User the option to delete their User account. |
|
|
A MOBILE page with this type provides the User with an overview of all the Articles that have been downloaded within the native mobile app. |
|
|
A WEB/MOBILE page with this type can have multiple sub-pages, each sub-page then represents a single blog. |
|
|
This type is reserved for legacy TV apps only, and is deprecated. |
|
|
A WEB/MOBILE page with this type is used to allow the User to enter a pairing code and thus link a device. |
|
|
A WEB/MOBILE page with this type may contain multiple filter categories and allows for a filtered search experience. |
|
|
A page with this type is used as the default landing/opening page. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows you to display a pairing code, so that a User may link their device to their User account. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type shows the User an overview of their main User account with active subscriptions, purchase overview, voucher redemption and more. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type is used by the purchase flow to offer subscriptions to Users. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows a User to see their general profile information such as name and e-mail address, as well as information specific to the TV app such as "version", which is often helpful for customer support queries. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type allows the User to edit their user profile information such as name and e-mail address, reset their password or change their e-mail address. |
|
|
A WEB/MOBILE page with this type allows you to configure a redirect to another page or, an external URL. When this page is opened by a User, they are automatically redirected to the configured target. |
|
|
The single WEB/MOBILE page with this type allows a User to fill out the registration form and create a User account. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows the User to search and filter on specific Articles. There can be only one page with this type per platform context. |
|
|
This is the most generic page type, intended for most content purposes. |
|
|
The single TV page with this type is displayed to Users when first opening the TV app. There can be only one page with this type per platform context. |
Example
"account_delete"
PagesListedWithPagination
Description
Page list with pagination
Fields
| Field Name | Description |
|---|---|
items - [PageListed]
|
|
pagination - Pagination
|
Example
{
"items": [PageListed],
"pagination": Pagination
}
Pagination
PaymentArgumentsValidate
Description
Validated payment arguments result
Fields
| Field Name | Description |
|---|---|
voucher_validity - Boolean
|
The validity status of the payment voucher |
voucher_code - String
|
The given voucher code of the payment voucher |
voucher_name - String
|
The name of the payment voucher |
voucher_description - String
|
The description of the payment voucher |
voucher_installment_num - Int
|
The number of periodic installments of the voucher |
voucher_installment_time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of installments issued by the payment voucher |
voucher_price_diff - Float
|
The price difference due to the payment voucher |
amount_balance_price_diff - Float
|
The price difference due to the payment voucher |
total_price_before - Float
|
The total price before application of voucher and/or amount balance |
total_price_after - Float
|
The total price after application of voucher and/or amount balance |
currency - String
|
The currency for validated arguments result |
currency_symbol - String
|
The currency symbol for validated arguments result |
scoped_subscription - Subscription
|
The allowed subscription this voucher can be applied to |
scoped_products - [ProductListed]
|
The allowed products this voucher can be applied to |
products - [ProductListed]
|
The included products this voucher entitles |
affiliation_categories - [CategoryListed]
|
The available affiliation categories relevant for the purchase intent |
Example
{
"voucher_validity": false,
"voucher_code": "string",
"voucher_name": "string",
"voucher_description": "string",
"voucher_installment_num": 42,
"voucher_installment_time_unit": "day",
"voucher_price_diff": 7.99,
"amount_balance_price_diff": 7.99,
"total_price_before": 7.99,
"total_price_after": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"scoped_subscription": Subscription,
"scoped_products": [ProductListed],
"products": [ProductListed],
"affiliation_categories": [CategoryListed]
}
PaymentMethodEnum
Description
The payment method type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"acss"
PaymentMethodIdealIssuerEnum
Description
The issuer type for payment method "ideal"
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"abnamro"
PaymentMethodInput
Description
A payment method input property
Fields
| Input Field | Description |
|---|---|
method - PaymentMethodEnum
|
The payment method to be offered for given transaction |
creditcard_token - String
|
The creditcard token containing information on the credit card to be used for given transaction (only used of a single instance of PaymentMethodInput is present) |
ideal_issuer - PaymentMethodIdealIssuerEnum
|
The issuer for payment method "ideal" (e.g. "rabobank") to be used for given transaction (only used if a single instance of PaymentMethodInput is present) |
kbccbc_issuer - PaymentMethodKbcCbcIssuerEnum
|
The issuer for payment method "kbc/cbc" (e.g. "cbc") to be used for given transaction (only used if a single instance of PaymentMethodInput is present) |
klarna_type - PaymentMethodKlarnaTypeEnum
|
The issuer for given payment method (e.g. type "paynow") to be used for given transaction |
Example
{
"method": "acss",
"creditcard_token": "string",
"ideal_issuer": "abnamro",
"kbccbc_issuer": "kbc",
"klarna_type": "paynow"
}
PaymentMethodKbcCbcIssuerEnum
Description
The issuer type for payment method "kbc/cbc"
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"kbc"
PaymentMethodKlarnaTypeEnum
Description
The check-out type for payment method "klarna"
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"paynow"
PaymentProviderCurrencyEnum
Description
The currency used for payment with the payment provider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREDIT"
PaymentProviderListed
Description
A listed payment provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the payment provider |
project_id - Int!
|
The project id of the payment provider |
name - String
|
The name of the payment provider |
description - String
|
The description of the payment provider |
type - String
|
The type of the payment provider |
status - PaymentProviderStatusEnum
|
The status of the product |
device_capability - Int
|
The device payment capabilities of the payment provider |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42
}
PaymentProviderListedAsRelation
PaymentProviderStatusEnum
Description
The payment provider status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"active"
PaymentProvidersListedWithPagination
Description
Payment provider list with pagination
Fields
| Field Name | Description |
|---|---|
items - [PaymentProviderListed]
|
|
pagination - Pagination
|
Example
{
"items": [PaymentProviderListed],
"pagination": Pagination
}
PaymentSyndicateTypeEnum
Description
The subscription type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"internal"
PaymentSyndicateVoucherDiscountTypeEnum
Description
The payment syndicate voucher discount type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"percentage"
PaymentSyndicateVoucherInstallmentTypeEnum
Description
The payment syndicate voucher installment type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"fixed_date"
PaymentSyndicateVoucherListed
Description
Listed payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher |
project_id - Int!
|
The project id of the voucher |
description - String
|
The name of the voucher |
scoped_products - [ProductListed]
|
The scoped products to which the voucher can be applied (empty means ALL subscriptions) |
scoped_subscriptions - [SubscriptionListed]
|
The subscriptions on which this voucher can be applied (empty means ALL subscriptions) |
Example
{
"id": 42,
"project_id": 42,
"description": "string",
"scoped_products": [ProductListed],
"scoped_subscriptions": [SubscriptionListed]
}
PaymentSyndicateVoucherTypeEnum
Description
The payment syndicate voucher type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"generic"
PlatformContextEnum
Description
The platform context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"web"
Product
Description
A product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [ArticleListedAsRelation]
|
The related articles of the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
ProductDiscoverabilityEnum
Description
The product discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
ProductListed
Description
A listed product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [ArticleListedAsRelation]
|
The related articles of the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 123.45,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
ProductListedAsRelation
Description
A listed related product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [ArticleListedAsRelation]
|
The related articles of the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
ProductListedAsResource
ProductStackInput
ProductStatusEnum
Description
The product status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"unpublished"
ProductTypeEnum
Description
The product type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article"
ProductsListedWithPagination
Description
Product list with pagination
Fields
| Field Name | Description |
|---|---|
items - [ProductListed]
|
|
pagination - Pagination
|
Example
{
"items": [ProductListed],
"pagination": Pagination
}
ResourceAccessibilityEnum
Description
The resource accessibility type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"everyone"
ResourceEntitlementActionEnum
Description
The entitlement action on a given resource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"fulfil"
ResourceTypeEnum
Description
The resource type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article"
ResourceVisibilityEnum
Description
The resource visibility type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"everyone"
Role
Description
The role
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the role |
name - String
|
The name of the role |
type - RoleTypeEnum
|
The type of the role |
description - String
|
The description of the role |
Example
{
"id": 42,
"name": "string",
"type": "root",
"description": "string"
}
RoleTypeEnum
Description
The role types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"root"
SortByInput
Description
A sort-by input property
Fields
| Input Field | Description |
|---|---|
field - String
|
The sort order field |
direction - SortOrderEnum
|
The sort order direction |
Example
{"field": "string", "direction": "asc"}
SortOrderEnum
Description
The sort order type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"asc"
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
"string"
StructureKeyValueArrayKeyValueIntegerPair
Description
Structure key nested-integer-value list pair type
Fields
| Field Name | Description |
|---|---|
label - String
|
label |
type - String
|
type |
key - String
|
key |
value - [StructureKeyValueIntegerPair]
|
value |
Example
{
"label": "string",
"type": "string",
"key": "string",
"value": [StructureKeyValueIntegerPair]
}
StructureKeyValueIntegerPair
StructureKeyValueStringPair
Subscription
Description
A subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles that are part of the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [PaymentProviderListedAsRelation]
|
The related payment providers part of the given subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [PaymentProviderListedAsRelation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
SubscriptionDiscoverabilityEnum
Description
The subscription discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
SubscriptionEntitlementScopeEnum
Description
The subscription entitlement scope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"partial_exclusive"
SubscriptionListed
Description
A listed subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles that are part of the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [PaymentProviderListedAsRelation]
|
The related payment providers part of the given subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
is_pricing_highlighted - Boolean
|
The listed subscription is highlighted as "recommended" in pricing overviews |
is_pricing_display_recurring_price - Boolean
|
The recurring price of the subscription is automatically displayed in pricing overviews |
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [PaymentProviderListedAsRelation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"is_pricing_highlighted": false,
"is_pricing_display_recurring_price": 7.99
}
SubscriptionListedAsResource
SubscriptionStatusEnum
Description
The subscription status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
SubscriptionTimeUnitEnum
Description
The subscription time unit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"day"
SubscriptionTypeEnum
Description
The subscription type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"svod"
SubscriptionsListedWithPagination
Description
Subscription list with pagination
Fields
| Field Name | Description |
|---|---|
items - [SubscriptionListed]
|
|
pagination - Pagination
|
Example
{
"items": [SubscriptionListed],
"pagination": Pagination
}
Translation
User
Description
A user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [UserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [UserPaymentAccountOrder]
|
User orders |
Arguments
|
|
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
UserArticleSession
Description
A user article view session
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user-article-session record |
user_id - Int
|
The user id of the user-article-session record |
anonymous_user_id - String
|
The anonymous user id of the user-article-session record, i.e. an unknown user without a user account |
article_id - Int
|
The article id of the user-article-session record |
asset_id - Int
|
The asset id of the user-article-session record |
linked_type - String
|
The article-asset linked type of the user-article-session record |
time_watched - Int
|
The amount of time watched of the user-article-session record (only applies to event-types related to actual play time) |
time_delta - Float
|
The elapsed time for the given user-article-session record |
resolution_tag - String
|
The displayed resolution of the user-article session record |
event_type - String
|
The event type of the user-article-session record (Play-time event types: "play", "playing", "stop") |
event_payload - String
|
The recorded payload/message of the user-article-session record |
is_progress_marker1_completed - Boolean
|
The fulfilment of custom progress marker 1 of the user-article-session record |
is_progress_marker2_completed - Boolean
|
The fulfilment of custom progress marker 2 of the user-article-session record |
is_progress_marker3_completed - Boolean
|
The fulfilment of custom progress marker 3 of the user-article-session record |
is_completed - Boolean
|
The fulfilment of the asset completion marker of the user-article-session record |
device_type - String
|
The detected device-type of the user-article-session record |
device_brand - String
|
The detected device brand of the user-article-session record |
device_model - String
|
The detected device model of the user-article-session record |
telemetry_platform - String
|
The detected telemetry-platform of the user-article-session record |
ip_address - String
|
The IP address of the user-article-session record |
user_agent - String
|
The user agent of the UserArticle record, which represents the browser/agent through which the User has last watched this Article-Assset |
geo_region_code - String
|
The geo-region code of the user-article-session record |
audio_locale - String
|
The audio language ISO 639-1 code of the user-article-session record |
subtitle_locale - String
|
The subtitle language ISO 639-1 code of the user-article-session record |
started_at - String
|
The article-asset linked type of the user-article-session record |
article_name - String
|
The article name of the user-article-session record |
Example
{
"id": 42,
"user_id": 42,
"anonymous_user_id": "string",
"article_id": 42,
"asset_id": 42,
"linked_type": "film",
"time_watched": 42,
"time_delta": 123.45,
"resolution_tag": "string",
"event_type": "string",
"event_payload": "string",
"is_progress_marker1_completed": true,
"is_progress_marker2_completed": false,
"is_progress_marker3_completed": true,
"is_completed": false,
"device_type": "string",
"device_brand": "string",
"device_model": "string",
"telemetry_platform": "string",
"ip_address": "string",
"user_agent": "string",
"geo_region_code": "nl",
"audio_locale": "string",
"subtitle_locale": "string",
"started_at": "2000-12-31T12:34:56.000Z",
"article_name": "string"
}
UserConsent
Description
A user consent property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The user consent property id |
user_id - Int
|
The user consent property user id |
value - Boolean
|
The user consent property value |
type - UserConsentTypeEnum
|
The enum value of the user consent |
created_at - String
|
The creation date (UTC) of the user consent |
updated_at - String
|
The last modification date (UTC) of the user consent |
Example
{
"id": 42,
"user_id": 42,
"value": true,
"type": "cookie_analytics",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserConsentInput
Description
A user consent input property
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
The boolean value of the user consent |
type - UserConsentTypeEnum
|
The enum value of the user consent |
Example
{"value": true, "type": "cookie_analytics"}
UserConsentTypeEnum
Description
The user consent types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"cookie_analytics"
UserDetails
Description
Details of a user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [UserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [UserPaymentAccountOrder]
|
User orders |
Arguments
|
|
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
UserGenderTypeEnum
Description
The user gender types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"male"
UserMetaTranslation
Description
A user metadata translation
Example
{
"id": 42,
"user_meta_id": 42,
"value": "string",
"locale": "string"
}
UserNotifiableTypeEnum
Description
The user notifiable types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"none"
UserNotificationProfile
Description
A user notification profile property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The user notification profile property id |
user_id - Int
|
The user notification profile property user id |
notification_token - String
|
The notification token |
device_tag - String
|
The device tag |
created_at - String
|
The creation date (UTC) of the user notification profile |
updated_at - String
|
The last modification date (UTC) of the user notification profile |
Example
{
"id": 42,
"user_id": 42,
"notification_token": "string",
"device_tag": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserNotificationProfileInput
UserNotificationTopic
Description
A user notification topic property
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification topic |
remote_notification_topic_id - String
|
The remote id of the notification topic (e.g. used for in-app push notifications) |
project_id - Int!
|
The project id of the notification topic |
name - String
|
The name of the notification topic |
title - String
|
The title of the notification topic |
description - String
|
The content of the notification topic |
is_subscribed - Boolean
|
The user notification topic subscription status |
notify_at - String
|
The preferred time (UTC) to be notified |
notified_at - String
|
The last time (UTC) the user was notified on this topic |
created_at - String
|
The creation date (UTC) of the notification topic user subscription |
updated_at - String
|
The last modification date (UTC) of the notification topic user subscription |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string",
"is_subscribed": false,
"notify_at": "2000-12-31T12:34:56.000Z",
"notified_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserNotificationTopicInput
Description
A user notification topic input property
Example
{
"id": 42,
"notify_at": "string",
"is_subscribed": true
}
UserPaymentAccount
Description
A user payment account
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the account |
payment_provider_id - Int
|
The id of the payment provider |
amount_balance - Float
|
The amount balance of the account |
method - String
|
The payment method of the account |
method_details - String
|
The payment method details of the account |
geo_region_code - String
|
The geo region (i.e. country) from which the account creation originated |
orders - [UserPaymentAccountOrder]
|
The account orders |
Example
{
"id": 42,
"payment_provider_id": 42,
"amount_balance": 123.45,
"method": "string",
"method_details": "string",
"geo_region_code": "nl",
"orders": [UserPaymentAccountOrder]
}
UserPaymentAccountOrder
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the order |
user_id - Int
|
The user id of the order |
user_subscription_id - String
|
The user subscription id of the order |
payment_syndicate_voucher_id - Int
|
The payment syndicate voucher id attached to the order |
voucher_code - String
|
The voucher code attached to the order |
type - String
|
The type of the order |
recurring_type - String
|
The recurring type of the order |
discount_type - String
|
The discount type of the order |
payment_provider_type - String
|
The payment provider type of the order |
amount - Float
|
The amount of the order |
status - String
|
The status of the order |
status_name - String
|
The status name of the order |
description - String
|
The description of the order |
installed_at - String
|
The installation date (UTC) of the order |
paid_at - String
|
The payment fulfilment date (UTC) of the order |
cancelled_at - String
|
The cancellation date (UTC) of the order |
refunded_at - String
|
The refunded/charge-back date (UTC) of the order |
created_at - String
|
The creation date (UTC) of the order |
updated_at - String
|
The last modification date (UTC) of the order |
installments - [Int]
|
The order installments |
currency - String
|
The currency of the order |
currency_symbol - String
|
The currency symbol of the order |
products - [ProductListedAsRelation]
|
The related products of the order |
Example
{
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [42],
"currency": "EUR",
"currency_symbol": "EUR",
"products": [ProductListedAsRelation]
}
UserPaymentAccountPaymentMethodUpdate
Description
User payment account payment method update
Fields
| Field Name | Description |
|---|---|
user_payment_account_order_id - String
|
The user payment account order id |
payment_url - String
|
The payment url if filled, to which the User should be redirected to conduct payment via given payment provider (e.g. Mollie, Stripe) |
payment_object - String
|
The payment object if filled, which a frontend app should use to finalise a transaction with certain payment providers |
payment_signature - String
|
The payment signature if filled, which a frontend app use to verify a transaction with certain payment providers |
title - String
|
The acquisition title |
description - String
|
The acquisition description |
description_short - String
|
The acquisition short description |
price - Float
|
The acquisition price |
currency - String
|
The acquisition currency |
currency_symbol - String
|
The acquisition currency symbol |
status - String
|
The acquisition status |
price_per_installment - Float
|
The subscription price per installment |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
Example
{
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
UserPaymentCreditTypeEnum
Description
The credit type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"general"
UserPaymentVoucherRedeem
Description
User voucher redemption
Fields
| Field Name | Description |
|---|---|
user_payment_account_order_id - String
|
The user payment account order id |
payment_url - String
|
The payment url if filled, to which the User should be redirected to conduct payment via given payment provider (e.g. Mollie, Stripe) |
payment_object - String
|
The payment object if filled, which a frontend app should use to finalise a transaction with certain payment providers |
payment_signature - String
|
The payment signature if filled, which a frontend app use to verify a transaction with certain payment providers |
title - String
|
The acquisition title |
description - String
|
The acquisition description |
description_short - String
|
The acquisition short description |
price - Float
|
The acquisition price |
currency - String
|
The acquisition currency |
currency_symbol - String
|
The acquisition currency symbol |
status - String
|
The acquisition status |
price_per_installment - Float
|
The subscription price per installment |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
Example
{
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
UserPhoneStatusEnum
Description
The user phone status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"unverified"
UserProduct
Description
A user product
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the user product |
product_id - Int
|
The id of the product |
user_id - Int
|
The id of the product |
user_payment_account_order_id - Int
|
The id of the order |
is_fulfilled - Boolean
|
Fulfilment status |
fulfilment_expires_at - String
|
The last expiry date (UTC) of the fulfilment |
order - UserPaymentAccountOrder
|
The user payment account order |
product - Product
|
The parent product |
account - UserPaymentAccount
|
The user payment account |
Example
{
"id": 42,
"product_id": 42,
"user_id": 42,
"user_payment_account_order_id": 42,
"is_fulfilled": false,
"fulfilment_expires_at": "2000-12-31T12:34:56.000Z",
"order": UserPaymentAccountOrder,
"product": Product,
"account": UserPaymentAccount
}
UserProductAcquire
Description
User product acquisition
Fields
| Field Name | Description |
|---|---|
user_payment_account_order_id - String
|
The user payment account order id |
payment_url - String
|
The payment url if filled, to which the User should be redirected to conduct payment via given payment provider (e.g. Mollie, Stripe) |
payment_object - String
|
The payment object if filled, which a frontend app should use to finalise a transaction with certain payment providers |
payment_signature - String
|
The payment signature if filled, which a frontend app use to verify a transaction with certain payment providers |
title - String
|
The acquisition title |
description - String
|
The acquisition description |
description_short - String
|
The acquisition short description |
price - Float
|
The acquisition price |
currency - String
|
The acquisition currency |
currency_symbol - String
|
The acquisition currency symbol |
status - String
|
The acquisition status |
Example
{
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string"
}
UserProductListed
Description
A listed user product
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the user product |
product_id - Int
|
The id of the product |
user_id - Int
|
The id of the product |
user_payment_account_order_id - Int
|
The id of the order |
is_fulfilled - Boolean
|
Fulfilment status |
fulfilment_expires_at - String
|
The last expiry date (UTC) of the fulfilment |
Example
{
"id": 42,
"product_id": 42,
"user_id": 42,
"user_payment_account_order_id": 42,
"is_fulfilled": true,
"fulfilment_expires_at": "2000-12-31T12:34:56.000Z"
}
UserProductsListedWithPagination
Description
User product list with pagination
Fields
| Field Name | Description |
|---|---|
items - [UserProductListed]
|
|
pagination - Pagination
|
Example
{
"items": [UserProductListed],
"pagination": Pagination
}
UserPurchaseIntentAcquire
Description
User purchase intent acquisition reflecting a cart checkout
Fields
| Field Name | Description |
|---|---|
operator_context - String
|
The device operator context |
device_type - String
|
The User's device type |
user_payment_account_order_id - String
|
The user payment account order id, issued by AudiencePlayer |
remote_payment_order_id - String
|
The remote payment order id, issued by the payment provider (e.g. Mollie, Stripe, etc.) |
payment_url - String
|
The payment url if filled, to which the User should be redirected to conduct payment via given payment provider (e.g. Mollie, Stripe) |
payment_object - String
|
The payment object if filled, which a frontend app should use to finalise a transaction with certain payment providers |
payment_signature - String
|
The payment signature if filled, which a frontend app use to verify a transaction with certain payment providers |
description - String
|
The order description, visible in both the order details and as "statement descriptor" in external monetary transaction overviews (e.g. a credit card bill) |
price - Float
|
The order price |
printable_price - String
|
The order price suitable for printing, represented with the applicable comma/dot separator depending on the passed locale (only available with successful validation_status) |
price_before - Float
|
The price before the application of a voucher and/or amount balance |
price_voucher_diff - Float
|
The price difference due to the applied voucher (typically a reduction in price) |
price_amount_balance_diff - Float
|
price difference due to the applied amount balance (typically a reduction in price) |
currency - String
|
The order currency |
currency_symbol - String
|
The order currency symbol |
is_execute_dry_run - Boolean
|
Indicates if a dry-run (validation-only) or actual execution (payment transaction) has been executed" |
is_allow_voucher_usage - Boolean
|
Indicates if a voucher code may be used on given purchase intent stack |
is_allow_amount_balance_usage - Boolean
|
Indicates if amount balance may be used on given purchase intent stack |
is_allow_combined_amount_balance_voucher_usage - Boolean
|
Indicates if amount balance may be used together with a voucher code on given purchase intent stack |
voucher_code - String
|
The voucher code used for this purchase intent |
purchase_intent_stack - [UserPurchaseIntentStackItem]
|
The stack of resources (subscriptions, products) given as initial input |
stacked_subscriptions - [SubscriptionListed]
|
The stacked subscription(s) of the validated purchase intent (combination of both the given subscription stack and any other products issued by given subscription and/or given voucher) |
stacked_products - [ProductListed]
|
The stacked product(s) of the validated purchase intent (combination of both the given product stack and any other products issued by given subscription and/or given voucher) |
stacked_vouchers - [PaymentSyndicateVoucherListed]
|
The stacked voucher(s) of the validated purchase intent (if given voucher code was validated, this property is hydrated) |
categories - [CategoryListed]
|
The categories provided as input for the purchase intent |
affiliation_categories - [CategoryListed]
|
The available affiliation categories relevant for the purchase intent |
order_status - String
|
The order status |
order_items - [UserPurchaseIntentOrderItem]
|
All the stacked items of the validated purchase intent |
Arguments
|
|
validation_status - Boolean
|
The validation status of the order, specific warning/error messages are hydrated in property "validation_messages" |
validation_messages - [UserPurchaseIntentValidationMessage]
|
List of validation messages (warnings and/or errors) |
Example
{
"operator_context": "string",
"device_type": "string",
"user_payment_account_order_id": "string",
"remote_payment_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"description": "string",
"price": 7.99,
"printable_price": 7.99,
"price_before": 7.99,
"price_voucher_diff": 7.99,
"price_amount_balance_diff": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"is_execute_dry_run": false,
"is_allow_voucher_usage": true,
"is_allow_amount_balance_usage": true,
"is_allow_combined_amount_balance_voucher_usage": true,
"voucher_code": "string",
"purchase_intent_stack": [UserPurchaseIntentStackItem],
"stacked_subscriptions": [SubscriptionListed],
"stacked_products": [ProductListed],
"stacked_vouchers": [PaymentSyndicateVoucherListed],
"categories": [CategoryListed],
"affiliation_categories": [CategoryListed],
"order_status": "string",
"order_items": [UserPurchaseIntentOrderItem],
"validation_status": "string",
"validation_messages": [
UserPurchaseIntentValidationMessage
]
}
UserPurchaseIntentOrderItem
Description
A order item of the validated purchase intent (e.g. a product, subscription, applied voucher, deducted amount balance, etc.)
Fields
| Field Name | Description |
|---|---|
id - String
|
The id of the stacked item |
type - String
|
The type of the stacked item |
title - String
|
The title of the stacked item |
description - String
|
The description of the stacked item |
purchase_num - String
|
The item quantity of the stacked item |
price - Float
|
The listed price of the stacked item |
calculated_price - Float
|
The total calculated price of the stacked item based on the item quantity and/or applied discount |
printable_price - String
|
The listed price of the stacked item suitable for printing, represented with the applicable comma/dot separator depending on the passed locale |
printable_calculated_price - String
|
The total calculated price of the stacked item based on the item quantity and/or applied discount suitable for printing, represented with the applicable comma/dot separator depending on the passed locale |
currency - String
|
The price currency of the stacked item |
currency_symbol - String
|
The corresponding symbol of price currency |
is_inherited - Boolean
|
The item is inherited because it was included in the order by a Subscription or Voucher |
Example
{
"id": "string",
"type": "string",
"title": "string",
"description": "string",
"purchase_num": "string",
"price": 7.99,
"calculated_price": 7.99,
"printable_price": 7.99,
"printable_calculated_price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"is_inherited": false
}
UserPurchaseIntentStackItem
Description
A purchase intent stack input item, which reflects the resource (subscription or product) marked for checkout
Fields
| Field Name | Description |
|---|---|
id - Int
|
The resource id |
resource_type - ResourceTypeEnum
|
The resource type (subscription or product) |
currency - String
|
The desired currency to be used for payment |
purchase_num - Int
|
The item quantity of given resource |
Example
{"id": 42, "resource_type": "article", "currency": "EUR", "purchase_num": 42}
UserPurchaseIntentStackItemInput
Description
A purchase intent stack input item, which reflects the resource (subscription or product) marked for checkout
Fields
| Input Field | Description |
|---|---|
id - Int
|
The resource id |
resource_type - ResourceTypeEnum
|
The resource type (subscription or product) |
currency - PaymentProviderCurrencyEnum
|
The desired currency to be used for payment |
purchase_num - Int
|
The item quantity of given resource |
Example
{"id": 42, "resource_type": "article", "currency": "CREDIT", "purchase_num": 42}
UserPurchaseIntentValidationMessage
Description
Validation message warning/error) for given purchase intent
Example
{
"message": "string",
"code": 42,
"value": "string"
}
UserStatusEnum
Description
The user status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"disabled"
UserSubscription
Description
A user subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user subscription |
user_id - Int!
|
The id of the user |
project_id - Int!
|
The project id of the user subscription |
subscription_id - Int!
|
The subscription id of the user subscription |
switch_from_subscription_id - Int
|
The subscription id of the old subscription the user was switched from |
switch_to_subscription_id - Int
|
The subscription id of the new subscription to switch to at next renewal |
term - Int
|
The current term of the user subscription |
acquired_at - String
|
The acquisition date (UTC) of the user subscription |
expires_at - String
|
The expiry date (UTC) of the user subscription |
suspendable_at - String
|
The suspendability date (UTC) of the user subscription |
suspended_at - String
|
The suspension date of (UTC) of the user subscription |
invoiced_at - String
|
The next invoice date (UTC) of the user subscription |
status - UserSubscriptionStatusEnum
|
The status of the user subscription |
status_name - String
|
The status description of the user subscription |
is_valid - Boolean
|
The validity of the user subscription |
is_expired - Boolean
|
The expiry status of the user subscription |
is_suspendable - Boolean
|
The suspendability of the user subscription |
is_account_method_changeable - Boolean
|
The changeability of payment account method of the user subscription |
is_switchable - Boolean
|
The possibility of the user subscription to be switched |
orders - [UserPaymentAccountOrder]
|
The user payment account orders |
Arguments
|
|
subscription - Subscription
|
The parent subscription |
account - UserPaymentAccount
|
The user payment account |
Example
{
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": true,
"is_expired": false,
"is_suspendable": true,
"is_account_method_changeable": false,
"is_switchable": false,
"orders": [UserPaymentAccountOrder],
"subscription": Subscription,
"account": UserPaymentAccount
}
UserSubscriptionAcquire
Description
User subscription acquisition
Fields
| Field Name | Description |
|---|---|
user_payment_account_order_id - String
|
The user payment account order id |
payment_url - String
|
The payment url if filled, to which the User should be redirected to conduct payment via given payment provider (e.g. Mollie, Stripe) |
payment_object - String
|
The payment object if filled, which a frontend app should use to finalise a transaction with certain payment providers |
payment_signature - String
|
The payment signature if filled, which a frontend app use to verify a transaction with certain payment providers |
title - String
|
The acquisition title |
description - String
|
The acquisition description |
description_short - String
|
The acquisition short description |
price - Float
|
The acquisition price |
currency - String
|
The acquisition currency |
currency_symbol - String
|
The acquisition currency symbol |
status - String
|
The acquisition status |
price_per_installment - Float
|
The subscription price per installment |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
Example
{
"user_payment_account_order_id": "string",
"payment_url": "https://url.example.com",
"payment_object": "string",
"payment_signature": "string",
"title": "string",
"description": "string",
"description_short": "string",
"price": 7.99,
"currency": "EUR",
"currency_symbol": "EUR",
"status": "string",
"price_per_installment": 7.99,
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42
}
UserSubscriptionEventTypeEnum
Description
The user subscription event type
Values
| Enum Value | Description |
|---|---|
|
|
An error occurred when trying to create the first payment to activate the user subscription. |
|
|
A charge-back occurred, impacting the validity of the user subscription. |
|
|
A refund occurred, impacting the validity of the user subscription. |
|
|
A previously fulfilled payment has become unfulfilled. |
|
|
An error occurred when attempting the last renewal, impacting the continued validity of the user subscription. |
|
|
An error occurred when attempting the last renewal, a renewal mandate was expected but not found. |
|
|
A renewal payment order has been generated, but it has not yet been fufilled. |
|
|
When attempting renewal, given voucher code could not be processed. |
Example
"first_payment_error"
UserSubscriptionListed
Description
A listed user subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user subscription |
user_id - Int!
|
The id of the user |
project_id - Int!
|
The project id of the user subscription |
subscription_id - Int!
|
The subscription id of the user subscription |
switch_from_subscription_id - Int
|
The subscription id of the old subscription the user was switched from |
switch_to_subscription_id - Int
|
The subscription id of the new subscription to switch to at next renewal |
term - Int
|
The current term of the user subscription |
acquired_at - String
|
The acquisition date (UTC) of the user subscription |
expires_at - String
|
The expiry date (UTC) of the user subscription |
suspendable_at - String
|
The suspendability date (UTC) of the user subscription |
suspended_at - String
|
The suspension date of (UTC) of the user subscription |
invoiced_at - String
|
The next invoice date (UTC) of the user subscription |
status - UserSubscriptionStatusEnum
|
The status of the user subscription |
status_name - String
|
The status description of the user subscription |
is_valid - Boolean
|
The validity of the user subscription |
is_expired - Boolean
|
The expiry status of the user subscription |
is_suspendable - Boolean
|
The suspendability of the user subscription |
is_account_method_changeable - Boolean
|
The changeability of payment account method of the user subscription |
is_switchable - Boolean
|
The possibility of the user subscription to be switched |
orders - [UserPaymentAccountOrder]
|
The user payment account orders |
subscription - Subscription
|
The parent subscription |
account - UserPaymentAccount
|
The user payment account |
Example
{
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": false,
"is_expired": false,
"is_suspendable": false,
"is_account_method_changeable": false,
"is_switchable": false,
"orders": [UserPaymentAccountOrder],
"subscription": Subscription,
"account": UserPaymentAccount
}
UserSubscriptionStatusEnum
Description
The user subscription status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"initialised"
UserSubscriptionsListedWithPagination
Description
User subscription list with pagination
Fields
| Field Name | Description |
|---|---|
items - [UserSubscriptionListed]
|
|
pagination - Pagination
|
Example
{
"items": [UserSubscriptionListed],
"pagination": Pagination
}