AudiencePlayer API Documentation
USER SCHEMA
You are currently viewing the documentation for the AudiencePlayer GraphQL API USER SCHEMA, version 35.17.0, 2026-11-06 18:14:53 UTC.
☞ View the documentation for the ADMIN SCHEMA
Queries
Article
Description
Fetch a single published Article, by id, url_slug, or full_url_slug (exactly one is required). Unauthenticated callers may still fetch public Articles.
Response
Returns an Article
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the Article to fetch (mutually exclusive with url_slug/full_url_slug). |
locale - String
|
The locale to resolve this Article's translatable fields in. |
url_slug - String
|
The url_slug of the Article to fetch (mutually exclusive with id/full_url_slug). |
full_url_slug - String
|
The full_url_slug of the Article to fetch (mutually exclusive with id/url_slug). |
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
episode_list_display_type
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",
"episode_list_display_type": "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]
}
}
}
ArticleEntitlingResources
Description
Fetch the Products and Subscriptions that can entitle access to a given Article.
Response
Returns an ArticleEntitlingResources
Arguments
| Name | Description |
|---|---|
locale - String
|
The locale to resolve the entitling resources' translatable fields in. |
platform_context - PlatformContextEnum
|
Currently ignored: this argument is accepted but has no effect on the returned Products and Subscriptions or their texts. Default = web |
id - Int
|
The id of the Article to fetch the entitling resources for. |
is_include_children - Boolean
|
Whether to include Products/Subscriptions for the Article's level-1 children (e.g. the "seasons" of a series Article, but not the level-2 "episodes"). Default = false |
is_hide_user_entitlements - Boolean
|
Whether to hide resources the User is already entitled to. Default = false |
is_include_secondary_credit_entitlements - Boolean
|
Whether to include resources that provide secondary entitlements, e.g. through a Subscription that provides credits. Default = true |
is_intersect_with_subscription_pricing - Boolean
|
Whether the entitling Subscriptions are filtered down to only those 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
Fetch the authenticated User's latest nomadic (continue-watching) Article, optionally within the series of a given root Article.
Response
Returns an Article
Arguments
| Name | Description |
|---|---|
root_id - Int
|
The id of the series' root Article to scope the search to. When omitted, the User's latest watched Article across all series is used and the next Article is limited to its own siblings; the first-eligible-Article fallback needs this id. |
locale - String
|
Currently ignored: this argument is accepted but has no effect. |
is_fallback_to_first_eligible_article - Boolean
|
Fall back to the first eligible Article (e.g. the first episode) when the User has no nomadic watching state yet. Default = true |
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
episode_list_display_type
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",
"episode_list_display_type": "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]
}
}
}
ArticleList
Description
Fetch a paginated list of published Articles.
Response
Returns an ArticlesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
Full-text search string across Article fields. |
locale - String
|
The locale to resolve these Articles' translatable fields in. |
limit - Int
|
The pagination limit. |
offset - Int
|
The pagination offset. |
parent_id - Int
|
Filter to direct children of the Article with this id. Pass null/0 to filter to top-level Articles (no parent). |
parent_ids - [Int]
|
Filter to direct children of any of these Article ids. |
ancestor_id - Int
|
Filter to every descendant (at any depth) of the Article with this id, not just direct children. |
category_id - Int
|
The id of the Category the Article belongs to. |
category_ids - [Int]
|
The ids of the Categories (XOR) the Article belongs to. |
article_ids - [Int]
|
The exact Article ids to fetch. |
type - ArticleTypeEnum
|
Filter by Article type. |
types - [ArticleTypeEnum]
|
Filter by Article type (matches any of the given types). |
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
|
A preconfigured list filter/ordering (e.g. newest, most popular), as an alternative to sort_by/filter_by. |
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
Description
Fetch a single published Category, by id, url_slug, or full_url_slug (exactly one is required). Unauthenticated callers may still fetch public Categories.
Response
Returns a Category
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the Category to fetch (mutually exclusive with url_slug/full_url_slug). |
locale - String
|
The locale to resolve this Category's translatable fields in. |
url_slug - String
|
The url_slug of the Category to fetch (mutually exclusive with id/full_url_slug). |
full_url_slug - String
|
The full_url_slug of the Category to fetch (mutually exclusive with id/url_slug). |
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
Description
Fetch a paginated list of published Categories.
Response
Returns a CategoriesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
A search string to filter Categories by. |
locale - String
|
The locale to resolve each Category's translatable fields in. |
limit - Int
|
The maximum number of Categories to return. |
offset - Int
|
The number of Categories to skip. |
parent_id - Int
|
The id of the parent Category to list children for (omit to list root Categories). |
parent_ids - [Int]
|
The ids of the parent Categories to list children for. |
category_ids - [Int]
|
The Category ids to fetch. |
type - CategoryTypeEnum
|
Filter by the Category's 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
|
A preconfigured Category list filter, used in place of an explicit type argument. |
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 and decrypt an OAuth client payload.
Response
Returns a ClientPayload
Arguments
| Name | Description |
|---|---|
project_id - Int
|
Required, but currently not applied: the Project is not checked against the client or the payload. |
client_id - String
|
The OAuth client id used to authenticate the payload verification request. |
client_secret - String
|
The OAuth client secret paired with client_id. |
payload - String
|
The encrypted payload to verify and decrypt. |
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 a User through OAuth client credentials.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The currency to base displayed properties on, such as user_payment_currency and user_payment_currency_symbol. |
project_id - Int
|
The Project id that owns the User. |
client_id - String
|
The OAuth client id used to authenticate the query. |
client_secret - String
|
The OAuth client secret paired with client_id. |
id - Int
|
The id of the User to query. One of id or email is required; when both are given, both must match the same User. |
email - String
|
The e-mail address of the User to query. One of id or email is required; when both are given, both must match the same 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": false,
"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,
"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 User-facing Project configuration
Response
Returns a Config
Arguments
| Name | Description |
|---|---|
platform_context - PlatformContextEnum
|
The platform context to build the Config payload for |
operator_context - OperatorContextEnum
|
The payment operator context to use when filtering payment providers. Default = web |
device_type - DeviceTypeEnum
|
The device type to use when filtering payment providers and platform behavior |
locale - String
|
The locale to activate for translated Config resources |
geo_region_code - String
|
The GeoRegion code to activate for locale and GeoRegion filtering |
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
version_tag_api
locale
geo_region_code
project_id
is_authenticated
version_tag_mobile_ios
version_tag_mobile_android
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",
"version_tag_api": "string",
"locale": "string",
"geo_region_code": "nl",
"project_id": 42,
"is_authenticated": false,
"version_tag_mobile_ios": "string",
"version_tag_mobile_android": "string",
"has_subscriptions": true,
"has_auto_canonical_urls": false,
"has_credits": true,
"has_metric_action_fulfilment_notifications": false,
"has_subscription_payment_registration_integration": true,
"has_subscription_payment_pricing_before_registration": false,
"has_subscription_credit_integration": true,
"has_entitlements": false,
"has_geo_restrictions": true,
"has_article_favourites": false,
"has_article_ratings": true,
"has_article_nomadics": false,
"has_article_series_nomadics": true,
"has_article_entitlements": false,
"has_article_history": true,
"has_article_recommendations": false,
"has_article_offline_downloads": true,
"has_article_purchase_buttons": false,
"has_product_purchase_affiliation_categories": true,
"has_subscription_purchase_affiliation_categories": false,
"has_product_checkout_cart_in_menu": true,
"has_checkout_combined_login_registration": false,
"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"]
}
}
}
DeviceList
Description
List Devices for the currently authenticated User
Response
Returns a DevicesListedWithPagination
Example
Query
query DeviceList {
DeviceList {
items {
...DeviceListedFragment
}
pagination {
...PaginationFragment
}
}
}
Response
{
"data": {
"DeviceList": {
"items": [DeviceListed],
"pagination": Pagination
}
}
}
GeoRegionList
Description
List GeoRegions available for front-end filtering.
Response
Returns a GeoRegionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
Search text matched against GeoRegion codes and names. |
locale - String
|
The locale to activate before resolving translated GeoRegion names. |
sort_by - [SortByInput]
|
Sort GeoRegions by field(s): "id", "code", "is_country", "name" |
filter_by - [FilterByInput]
|
Filter GeoRegions 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
Fetch a single Menu. Unauthenticated callers may still fetch public Menus.
Response
Returns a Menu
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 NotificationTopic details.
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 NotificationTopics with pagination.
Response
Returns a NotificationTopicsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
Search NotificationTopics by indexed text. |
locale - String
|
The locale to activate while resolving translated NotificationTopic fields. |
limit - Int
|
The maximum number of NotificationTopics to return. |
offset - Int
|
The number of NotificationTopics to skip before returning results. |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter NotificationTopics by field(s). |
project_id - Int
|
The Project id that owns the NotificationTopics. |
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
Description
List OAuth2 providers available to the current User.
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
Fetch a single Page, by id, url_slug, or full_url_slug (exactly one is required). Unauthenticated callers may still fetch public Pages.
Response
Returns a Page
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the Page to fetch (mutually exclusive with url_slug/full_url_slug). |
locale - String
|
The locale to resolve this Page's translatable fields in. |
url_slug - String
|
The url_slug of the Page to fetch (mutually exclusive with id/full_url_slug). |
full_url_slug - String
|
The full_url_slug of the Page to fetch (mutually exclusive with id/url_slug). |
geo_region_code - String
|
The preferred geo-region to fetch the Page for (only applicable when matching by url_slug/full_url_slug, not id). |
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": 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"
}
}
}
PageList
Description
Fetch a paginated list of Pages for a platform context (Pages not tied to any platform context are included). Without search or parent_id, only root Pages are returned.
Response
Returns a PagesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
A search string to filter Pages by. |
locale - String
|
The locale to resolve each Page's translatable fields in. |
parent_id - Int
|
The id of the parent Page to list children for (omit to list root Pages). |
limit - Int
|
The maximum number of Pages to return. |
offset - Int
|
The number of Pages to skip. |
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
|
The platform context to list Pages for. |
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 legacy payment arguments before conducting a payment
Response
Returns a PaymentArgumentsValidate
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
The PaymentProvider id to validate against. If omitted, the server chooses a provider from request context. Default = null |
is_use_amount_balance - Boolean
|
Whether to include the current User's payment-account balance in validation. Default = false |
is_solo_validation - Boolean
|
Whether to validate voucher/payment arguments without requiring a full purchase stack. Default = false |
voucher_code - String
|
The Voucher Code to validate. |
currency - String
|
Currently ignored: this argument is accepted but has no effect. The currency is taken from the Product or Subscription being validated. |
subscription_id - Int
|
The Subscription id to validate for purchase. Default = null |
product_stack - [ProductStackInput]
|
The Product stack to validate for purchase. Default = null |
locale - String
|
The locale to activate while resolving validation messages. |
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 {
...SubscriptionListedFragment
}
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": SubscriptionListed,
"scoped_products": [ProductListed],
"products": [ProductListed],
"affiliation_categories": [CategoryListed]
}
}
}
PaymentProviderList
Description
List active PaymentProviders available to the current User.
Response
Returns a PaymentProvidersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
Currently ignored: this argument is accepted but has no effect. |
locale - String
|
The locale used for translated PaymentProvider fields. |
limit - Int
|
The maximum number of PaymentProviders to return. |
offset - Int
|
The number of PaymentProviders to skip before returning results. |
sort_by - [SortByInput]
|
Currently ignored: this argument is accepted but has no effect. PaymentProviders are always returned in their default order. |
filter_by - [FilterByInput]
|
Currently ignored: this argument is accepted but has no effect. |
operator_context - OperatorContextEnum
|
The operator context used to filter compatible PaymentProviders. 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
Fetch a single Product.
Response
Returns a 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
Description
Fetch a paginated list of published Products for the current Project.
Response
Returns a ProductsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
A search string to filter Products by. |
category_id - Int
|
The Category id to restrict Products to. |
type - ProductTypeEnum
|
A single Product type to filter by. Mutually exclusive with types. |
types - [ProductTypeEnum]
|
The Product types to filter on (filter type: "where in"). Mutually exclusive with type. |
locale - String
|
The locale used to resolve the Products' translated fields. |
limit - Int
|
The maximum number of Products to return. |
offset - Int
|
The number of Products to skip. |
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
}
}
}
Subscription
Description
Fetch a single Subscription.
Response
Returns a SubscriptionListed
Example
Query
query Subscription(
$id: Int,
$locale: String
) {
Subscription(
id: $id,
locale: $locale
) {
id
project_id
remote_subscription_id
name
title
description
description_short
type
price
price_per_installment
time_unit
time_unit_translation
frequency
currency
currency_symbol
initial_installment_num
initial_installment_time_unit
allow_suspend_after_installment_num
max_concurrent_vod_stream_num
newsletter_list_id
entitlement_scope
is_credit_issuing
purchase_num
max_purchase_num
articles {
...ArticleListedAsRelationFragment
}
categories {
...CategoryListedAsRelationFragment
}
payment_providers {
...PaymentProviderListedAsRelationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
created_at
updated_at
is_pricing_highlighted
is_pricing_display_recurring_price
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"Subscription": {
"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": true
}
}
}
SubscriptionList
Description
Fetch a paginated list of active Subscriptions for the current Project.
Response
Returns a SubscriptionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
A search string to filter Subscriptions by. |
type - SubscriptionTypeEnum
|
The Subscription type to filter by. Mutually exclusive with filter_by (it can be combined with sort_by). |
locale - String
|
The locale used to resolve the Subscriptions' translated fields. |
limit - Int
|
The maximum number of Subscriptions to return. |
offset - Int
|
The number of Subscriptions to skip. |
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]
|
The PaymentProvider ids to restrict Subscriptions to. Only Subscriptions with no PaymentProvider restriction, or with at least one of these PaymentProviders, are returned. |
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 details for the currently authenticated User.
Response
Returns a UserDetails
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The currency to base displayed properties on, 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
is_terms_and_conditions_renewal_required
}
}
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": false,
"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": [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",
"is_terms_and_conditions_renewal_required": false
}
}
}
UserPaymentAccountOrder
Description
Fetch one of the current User's payment orders
Response
Returns a UserPaymentAccountOrder
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the UserPaymentAccountOrder to fetch. |
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": 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]
}
}
}
UserProductList
Description
Fetch a paginated list of the current User's Product acquisition records (one per order line), restricted to the current Project. Unfulfilled and expired records are included: check is_fulfilled and fulfilment_expires_at.
Response
Returns a UserProductsListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
The locale used to resolve the UserProducts' translated fields. |
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 whether User registration is allowed for the current Project and platform context.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The currency to base displayed properties on, such as user_payment_currency and user_payment_currency_symbol. |
platform_context - PlatformContextEnum
|
The platform context for the User registration policy check. Default = web |
state_param - String
|
The OAuth registration state parameter for an SSO registration flow. |
Example
Query
query UserRegistrationAllowed(
$currency: PaymentProviderCurrencyEnum,
$platform_context: PlatformContextEnum,
$state_param: String
) {
UserRegistrationAllowed(
currency: $currency,
platform_context: $platform_context,
state_param: $state_param
)
}
Variables
{
"currency": "CREDIT",
"platform_context": "web",
"state_param": "string"
}
Response
{"data": {"UserRegistrationAllowed": false}}
UserSubscriptionList
Description
Fetch a paginated list of UserSubscriptions belonging to the current User, restricted to the current Project.
Response
Returns a UserSubscriptionsListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
The locale used to resolve the UserSubscriptions' translated fields. |
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
Check whether the current User has at least one valid UserSubscription, optionally restricted to a specific UserSubscription or Subscription.
Response
Returns a Boolean
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": true}}
Mutations
ArticleAssetPlay
Description
Create a play-out configuration for the currently authenticated user to play an Article's Asset, enforcing their actual entitlement/purchase status and the Asset's playability window. Unauthenticated callers may still play public Assets.
Response
Returns an ArticleAssetPlay
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The id of the Article to create a play configuration for. |
asset_id - Int
|
The id of the Asset to create a play configuration for. |
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": ["hls"],
"resolution": "w3840_h2160",
"resolution_max": "w3840_h2160",
"audio_quality_max": "audio_512kb",
"is_proxy_hls_manifest": true,
"is_include_subtitles_in_manifest": true,
"is_offline_download": false,
"manifest_audio_track_filter": "",
"platform_context": "web",
"device_model_context": "apple_native"
}
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": 987.65,
"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 response.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
captcha_response - String
|
The captcha response token to validate. |
Example
Query
mutation CaptchaValidate($captcha_response: String) {
CaptchaValidate(captcha_response: $captcha_response)
}
Variables
{"captcha_response": "string"}
Response
{"data": {"CaptchaValidate": false}}
ClientUserArticleAssetPlay
Description
Create a play-out configuration for a specified User, on behalf of a trusted OAuth client, bypassing that User's actual entitlement/purchase status. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns an ArticleAssetPlay
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The id of the Article to create a play configuration for. |
asset_id - Int
|
The id of the Asset to create a play configuration for. |
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
|
The Project id that owns the Article and the target User. |
client_id - String
|
The requesting OAuth client's id. |
client_secret - String
|
The requesting OAuth client's secret. |
user_id - Int
|
The id of the User to create the play-out configuration for. |
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": ["hls"],
"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": "apple_native",
"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": 123.45,
"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": 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
Authenticate an existing or auto-registered User through OAuth client credentials and issue access/refresh tokens. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
client_id - String
|
The OauthClient id used to authenticate. |
client_secret - String
|
The OauthClient secret paired with client_id. |
project_id - Int
|
The Project id to authenticate the User for. |
user_id - Int
|
The id of the User to authenticate. One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_email - String
|
The e-mail address of the User to authenticate (or create, when combined with auto_register). One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_password - String
|
The password to set on the User, when creating a new User via user_email. |
user_name - String
|
The name to set on the User, when creating a new User via user_email. |
user_locale - String
|
The locale to set on the User, when creating a new User via user_email. |
user_geo_region_code - String
|
The GeoRegion code to set on the User, when creating a new User via user_email. |
auto_register - Boolean
|
Whether to automatically create a new User from user_email when no existing User matches. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the newly created User accepts the terms and conditions, when creating a new User via user_email. |
is_newsletter_opt_in - Boolean
|
Whether the newly created User opts in to the newsletter, when creating a new User via user_email. |
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
is_terms_and_conditions_renewal_required
}
}
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": true,
"is_newsletter_opt_in": true
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
ClientUserDelete
Description
Delete a User through OAuth client credentials. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
project_id - Int
|
The Project id that owns the User. |
client_id - String
|
The OAuth client id used to authenticate the delete request. |
client_secret - String
|
The OAuth client secret paired with client_id. |
id - Int
|
The id of the User to delete. |
email - String
|
Currently ignored beyond being required: this e-mail address is not checked against the User identified by id. |
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": true}}
ClientUserProductEntitlementManage
Description
Entitle or expire a Product for a User, authenticating via OauthClient credentials rather than a User session. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
client_id - String
|
The OauthClient id used to authenticate. |
client_secret - String
|
The OauthClient secret paired with client_id. |
project_id - Int
|
The Project id to authenticate the User for. |
user_id - Int
|
The id of the User to authenticate. One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_email - String
|
The e-mail address of the User to authenticate (or create, when combined with auto_register). One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_password - String
|
The password to set on the User, when creating a new User via user_email. |
user_name - String
|
The name to set on the User, when creating a new User via user_email. |
user_locale - String
|
The locale to set on the User, when creating a new User via user_email. |
user_geo_region_code - String
|
The GeoRegion code to set on the User, when creating a new User via user_email. |
auto_register - Boolean
|
Whether to automatically create a new User from user_email when no existing User matches. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the newly created User accepts the terms and conditions, when creating a new User via user_email. |
is_newsletter_opt_in - Boolean
|
Whether the newly created User opts in to the newsletter, when creating a new User via user_email. |
product_id - Int
|
The id of the Product to entitle or expire for the User. |
action - ResourceEntitlementActionEnum
|
Whether to entitle or expire the Product for the User. |
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": false}}
ClientUserSubscriptionEntitlementManage
Description
Entitle or expire a Subscription for a User, authenticating via OauthClient credentials rather than a User session. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
client_id - String
|
The OauthClient id used to authenticate. |
client_secret - String
|
The OauthClient secret paired with client_id. |
project_id - Int
|
The Project id to authenticate the User for. |
user_id - Int
|
The id of the User to authenticate. One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_email - String
|
The e-mail address of the User to authenticate (or create, when combined with auto_register). One of user_id or user_email is required; when both are given, user_email is used and user_id is ignored. |
user_password - String
|
The password to set on the User, when creating a new User via user_email. |
user_name - String
|
The name to set on the User, when creating a new User via user_email. |
user_locale - String
|
The locale to set on the User, when creating a new User via user_email. |
user_geo_region_code - String
|
The GeoRegion code to set on the User, when creating a new User via user_email. |
auto_register - Boolean
|
Whether to automatically create a new User from user_email when no existing User matches. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the newly created User accepts the terms and conditions, when creating a new User via user_email. |
is_newsletter_opt_in - Boolean
|
Whether the newly created User opts in to the newsletter, when creating a new User via user_email. |
subscription_id - Int
|
The id of the Subscription to entitle or expire for the User. |
expires_at - String
|
The expiry date (UTC) for the resulting UserSubscription. |
action - ResourceEntitlementActionEnum
|
Whether to entitle or expire the Subscription for the User. |
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": true,
"is_terms_and_conditions_opt_in": true,
"is_newsletter_opt_in": true,
"subscription_id": 42,
"expires_at": "string",
"action": "fulfil"
}
Response
{"data": {"ClientUserSubscriptionEntitlementManage": true}}
ClientUserUpdate
Description
Update a User through OAuth client credentials. Exists for server-to-server integrations, such as a 3rd-party backend reacting to a webhook, to act on a User's behalf without an interactive User session.
Response
Returns an AdminUser
Arguments
| Name | Description |
|---|---|
name - String
|
The User's name. |
email - String
|
The User's e-mail address, unique within the Project. |
password - String
|
The User's password. |
gender - UserGenderTypeEnum
|
The User's gender. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
phone - String
|
The User's phone number. |
phone_country - String
|
The 2-letter country code paired with phone. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
consents - [UserConsentInput]
|
The User's cookie consent records. |
notification_topics - [UserNotificationTopicInput]
|
The NotificationTopics the User is subscribed to. |
notification_profiles - [UserNotificationProfileInput]
|
The User's notification delivery profiles. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
project_id - Int
|
The Project id that owns the User. |
client_id - String
|
The OAuth client id used to authenticate the update request. |
client_secret - String
|
The OAuth client secret paired with client_id. |
id - Int
|
The id of the User to update. |
status - UserStatusEnum
|
The User's lifecycle status. |
is_phone_verified - UserPhoneStatusEnum
|
The User's phone verification status. |
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": 123.45,
"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": true,
"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": 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": [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
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
force_device_delete - Boolean
|
Whether to delete the Device record while invalidating the current Device session. Default = true |
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
|
The Device UUID to authenticate with the pairing code. |
pairing_code - String
|
The pairing code previously issued for the Device. |
key - String
|
Optional Device authentication key to store after successful pairing. |
operator_context - OperatorContextEnum
|
Optional operator context to store on the Device after successful pairing. |
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
is_terms_and_conditions_renewal_required
}
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
DeviceAuthenticatePrimary
Description
Initiate an authenticated device session and request new tokens
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
uuid - String
|
The Device UUID to authenticate. |
name - String
|
The Device name. If omitted during auto-registration, the server derives a name from the current request. |
key - String
|
The Device authentication key. |
operator_context - OperatorContextEnum
|
The operator context to store on the Device. |
auto_register - Boolean
|
Whether to create a new User and primary Device when no existing Device matches. Default = false |
email - String
|
The e-mail address for the auto-registered User. |
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
is_terms_and_conditions_renewal_required
}
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
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 the currently authenticated device User.
Response
Returns a User
Arguments
| Name | Description |
|---|---|
name - String
|
The User's name. |
email - String
|
The User's e-mail address, unique within the Project. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
phone_country - String
|
The 2-letter country code paired with phone. |
custom_data - String
|
Custom data stored for the User. |
consents - [UserConsentInput]
|
The User's cookie consent records. |
notification_topics - [UserNotificationTopicInput]
|
The NotificationTopics the User is subscribed to. |
notification_profiles - [UserNotificationProfileInput]
|
The User's notification delivery profiles. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
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": false
}
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": false,
"birthday": "string",
"height": 987.65,
"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": [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 the authenticated User's nomadic watching state (UserArticle) for an Article/Asset, such as its favourite flag, continue-watching position, or rating. This is an upsert: only the given fields are changed, so marking and unmarking an Article as a favourite (is_favourite: 1 or is_favourite: 0) are both done here, without affecting the Article's other nomadic data.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The Article id to link/update the nomadic watching state for. |
asset_id - Int
|
The Asset id to link/update the nomadic watching state for, when the Article has multiple linked Assets. |
asset_play_position_abs - Float
|
The Asset's absolute play position, in seconds. |
asset_play_position_rel - Float
|
The Asset's relative play position (between 0 and 1). |
is_favourite - Int
|
Whether to mark the UserArticle as favourite (only evaluated for UserArticles with no linked Asset, or an Asset linked as "film" or "episode"). |
is_continue - Int
|
Whether to mark the UserArticle as "continue watching". |
rating_value - Float
|
The User's rating value. |
subtitle_locale - String
|
The User's selected subtitle locale. |
audio_locale - String
|
The User's 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": 987.65,
"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": true}}
UserArticleUnlink
Description
Completely remove the authenticated User's nomadic watching state (UserArticle) for an Article, deleting all its nomadic data (favourite/continue-watching/history flags, play position, rating) in one go. Marking or unmarking an Article as a favourite is not this operation's job, in either direction: both are done via UserArticleLink (an upsert-style update, with is_favourite: 1 or is_favourite: 0), which leaves all other nomadic data untouched.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The Article id to remove the nomadic watching state for. |
Example
Query
mutation UserArticleUnlink($article_id: Int) {
UserArticleUnlink(article_id: $article_id)
}
Variables
{"article_id": 42}
Response
{"data": {"UserArticleUnlink": true}}
UserAuthenticate
Description
Authenticate with e-mail and password, and issue new access/refresh tokens.
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
email - String
|
The User's e-mail address. |
password - String
|
The User's password. |
platform_context - PlatformContextEnum
|
The platform context for the User authentication policy check. Default = web |
Example
Query
mutation UserAuthenticate(
$email: String,
$password: String,
$platform_context: PlatformContextEnum
) {
UserAuthenticate(
email: $email,
password: $password,
platform_context: $platform_context
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
is_terms_and_conditions_renewal_required
}
}
Variables
{
"email": "string",
"password": "string",
"platform_context": "web"
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
UserAuthenticateInvalidate
Description
Invalidate the current authenticated User session and revoke its tokens.
Response
Returns a Boolean
Example
Query
mutation UserAuthenticateInvalidate {
UserAuthenticateInvalidate
}
Response
{"data": {"UserAuthenticateInvalidate": false}}
UserAuthenticateRefresh
Description
Refresh the current authenticated User session and issue new tokens.
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
refresh_token - String
|
The refresh token to exchange for new User access tokens. |
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
is_terms_and_conditions_renewal_required
}
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
UserDeletionRequest
Description
Request deletion of the currently authenticated User account.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
password_current - String
|
The currently authenticated User's current password. |
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 the currently authenticated User's phone number.
Response
Returns a Boolean
Example
Query
mutation UserDetailsPhoneVerifyRequest {
UserDetailsPhoneVerifyRequest
}
Response
{"data": {"UserDetailsPhoneVerifyRequest": false}}
UserDetailsPhoneVerifyValidate
Description
Validate the currently authenticated User's phone-number verification code.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
code - String
|
The phone-number verification code received by SMS. |
Example
Query
mutation UserDetailsPhoneVerifyValidate($code: String) {
UserDetailsPhoneVerifyValidate(code: $code)
}
Variables
{"code": "string"}
Response
{"data": {"UserDetailsPhoneVerifyValidate": true}}
UserDetailsUpdate
Description
Update details of the currently authenticated User.
Response
Returns a UserDetails
Arguments
| Name | Description |
|---|---|
name - String
|
The User's name. |
email - String
|
The User's e-mail address, unique within the Project. |
password - String
|
The User's password. |
gender - UserGenderTypeEnum
|
The User's gender. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
phone - String
|
The User's phone number. |
phone_country - String
|
The 2-letter country code paired with phone. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
consents - [UserConsentInput]
|
The User's cookie consent records. |
notification_topics - [UserNotificationTopicInput]
|
The NotificationTopics the User is subscribed to. |
notification_profiles - [UserNotificationProfileInput]
|
The User's notification delivery profiles. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
password_current - String
|
The currently authenticated User's current password. |
platform_context - PlatformContextEnum
|
Indicate the appropriate platform context for the requested User details update, used to evaluate whether regular (email/password) login is allowed. If omitted, the update is only blocked when regular login is disallowed on all platforms |
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,
$platform_context: PlatformContextEnum
) {
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,
platform_context: $platform_context
) {
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
is_terms_and_conditions_renewal_required
}
}
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",
"platform_context": "web"
}
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": false,
"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,
"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",
"is_terms_and_conditions_renewal_required": false
}
}
}
UserDevicePairingClaim
Description
Claim an existing device pairing code for the authenticated User.
Response
Returns a Device
Arguments
| Name | Description |
|---|---|
pairing_code - String
|
The device pairing code to claim. |
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 for the authenticated User: the Device is deleted and its access and refresh tokens are revoked, so the paired Device is signed out.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
device_id - Int
|
The id of the paired Device to unpair. |
Example
Query
mutation UserDevicePairingDelete($device_id: Int) {
UserDevicePairingDelete(device_id: $device_id)
}
Variables
{"device_id": 42}
Response
{"data": {"UserDevicePairingDelete": true}}
UserMetricActionAcknowledge
Description
Acknowledge a fulfilled MetricAction for the authenticated User.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
metric_action_id - Int
|
The id of the fulfilled MetricAction to acknowledge. |
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
Subscribe an e-mail address to a newsletter list.
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": false}}
UserNotificationProfileLink
Description
Link or update a notification profile for the authenticated User.
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 User.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
email - String
|
The e-mail address of the User requesting a password reset. |
Example
Query
mutation UserPasswordResetRequest($email: String) {
UserPasswordResetRequest(email: $email)
}
Variables
{"email": "string"}
Response
{"data": {"UserPasswordResetRequest": false}}
UserPasswordResetValidate
Description
Validate a User password reset token and, when password is given, set the new password.
Response
Returns a Boolean
Example
Query
mutation UserPasswordResetValidate(
$token: String,
$password: String,
$is_revoke_all_access_tokens: Boolean
) {
UserPasswordResetValidate(
token: $token,
password: $password,
is_revoke_all_access_tokens: $is_revoke_all_access_tokens
)
}
Variables
{
"token": "string",
"password": "string",
"is_revoke_all_access_tokens": false
}
Response
{"data": {"UserPasswordResetValidate": true}}
UserPaymentAccountOrderValidate
Description
Validate the current User's payment order with the PaymentProvider
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the current User's UserPaymentAccountOrder to validate. |
Example
Query
mutation UserPaymentAccountOrderValidate($id: Int) {
UserPaymentAccountOrderValidate(id: $id)
}
Variables
{"id": 42}
Response
{"data": {"UserPaymentAccountOrderValidate": false}}
UserPaymentAccountPaymentMethodUpdate
Description
Request a payment-method update for the current User
Response
Returns a UserPaymentAccountPaymentMethodUpdate
Arguments
| Name | Description |
|---|---|
user_payment_account_id - Int
|
The id of the UserPaymentAccount whose payment method should be changed. |
user_subscription_id - Int
|
The id of the UserSubscription whose linked payment account should be changed. |
redirect_url_path - String
|
The path the User is redirected to after completing the payment-method update at the PaymentProvider. |
payment_methods - [PaymentMethodInput]
|
Payment methods to use for the provider flow. Multiple methods restrict the checkout page; a single method enforces that method. |
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 the current User's payment account with a remote receipt or transaction reference from any configured PaymentProvider.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
The PaymentProvider id to synchronise the remote receipt with. |
remote_receipt - String
|
The remote in-app purchase receipt to synchronise. |
remote_product_id - String
|
The remote product id from the app-store purchase receipt. |
remote_product_price - Float
|
The remote product price from the app-store purchase receipt. |
remote_product_currency - String
|
The remote product currency from the app-store purchase receipt. |
categories - [Int]
|
Category ids to associate with synchronised fulfilment. |
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": 987.65,
"remote_product_currency": "string",
"categories": [42]
}
Response
{"data": {"UserPaymentAccountSynchronise": true}}
UserPaymentVoucherRedeem
Deprecated in favour of the combined checkout cart mutation "UserPurchaseIntentAcquire"
Description
Redeem a PaymentSyndicateVoucher Code for the current User.
Response
Returns a UserPaymentVoucherRedeem
Arguments
| Name | Description |
|---|---|
subscription_id - Int
|
The Subscription id. Default = null |
user_subscription_id - Int
|
The UserSubscription id. Default = null |
payment_provider_id - Int
|
The PaymentProvider id used to process the redemption. |
code - String
|
The Voucher Code to redeem. |
redirect_url_path - String
|
The path the User is redirected to after completing the redemption at the PaymentProvider. |
is_execute_recurring_payment - Boolean
|
Whether to charge automatically against the User's existing valid payment mandate. Has no effect when the User has no valid mandate. |
payment_methods - [PaymentMethodInput]
|
Payment methods that must be allowed by the PaymentProvider. They are only validated against the PaymentProvider and are not applied to the redemption itself. |
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 one or more Products for the current User.
Response
Returns a UserProductAcquire
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
The PaymentProvider id used to process the purchase. |
product_stack - [ProductStackInput]
|
The Products (and quantities) to purchase. |
voucher_code - String
|
A PaymentSyndicateVoucher Code to apply to the purchase. |
redirect_url_path - String
|
The path the User is redirected to after completing the purchase at the PaymentProvider. |
is_execute_recurring_payment - Boolean
|
Whether to execute the payment as part of a recurring-payment mandate: charged directly against the User's existing valid payment mandate when there is one, otherwise as the first payment that establishes one. Products do not create a Subscription. |
is_use_amount_balance - Boolean
|
Whether the User's existing account balance is applied to the purchase. |
payment_methods - [PaymentMethodInput]
|
The payment methods to use for this transaction (multiple methods restrict the displayed methods on the check-out page, a single method enforces using it). |
categories - [Int]
|
The Category ids attributed to this purchase (e.g. for Partner channel tracking). |
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
Validate or execute checkout for Products and Subscriptions in a User purchase-intent stack, selecting a PaymentProvider based on operator_context, the stack's currency, and device_type. Use is_execute_dry_run to validate the cart without executing payment. Fails when the selected PaymentProvider disallows multi-item carts and more than one item is present.
Response
Returns a UserPurchaseIntentAcquire
Arguments
| Name | Description |
|---|---|
operator_context - OperatorContextEnum
|
The operator context used to select the PaymentProvider for the transaction. |
device_type - DeviceTypeEnum
|
The User's device type. |
locale - String
|
The locale used to format monetary values. |
purchase_intent_stack - [UserPurchaseIntentStackItemInput]
|
The Products and Subscriptions to validate or acquire. |
voucher_code - String
|
The Voucher code to apply to the purchase intent. |
redirect_url_path - String
|
The frontend URL path to return the User to after a hosted payment-provider flow. |
is_allow_subscription_switch - Boolean
|
Whether the purchase intent may switch an existing User Subscription. Default = false |
is_execute_recurring_payment - Boolean
|
Whether to execute payment automatically when a valid payment mandate exists. Default = false |
is_execute_dry_run - Boolean
|
Whether to validate the purchase intent without executing the payment transaction. Default = false |
is_use_amount_balance - Boolean
|
Whether to apply the User's positive amount balance to reduce the amount due. Default = false |
payment_methods - [PaymentMethodInput]
|
The payment methods to allow for the transaction. |
categories - [Int]
|
The ids of Categories to tag on the created payment order. |
Example
Query
mutation UserPurchaseIntentAcquire(
$operator_context: OperatorContextEnum,
$device_type: DeviceTypeEnum,
$locale: String,
$purchase_intent_stack: [UserPurchaseIntentStackItemInput],
$voucher_code: String,
$redirect_url_path: String,
$is_allow_subscription_switch: Boolean,
$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_allow_subscription_switch: $is_allow_subscription_switch,
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_allow_subscription_switch": false,
"is_execute_recurring_payment": false,
"is_execute_dry_run": false,
"is_use_amount_balance": false,
"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": false,
"is_allow_voucher_usage": true,
"is_allow_amount_balance_usage": false,
"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
]
}
}
}
UserRegister
Description
Register a new User account, either with a password or through a validated SSO (Single Sign-On) registration flow, and issue access/refresh tokens.
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
name - String
|
The User's name. |
email - String
|
The User's e-mail address. |
password - String
|
The password to set for the new User. |
state_param - String
|
The OAuth registration state parameter for an SSO registration flow. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
geo_region_code - String
|
The GeoRegion code to assign to the User. |
phone - String
|
The User's phone number. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the User accepts the terms and conditions during registration. |
is_newsletter_opt_in - Boolean
|
Whether the User opts in to the newsletter during registration. |
consents - [UserConsentInput]
|
The User consent records to create during registration. |
notification_topics - [UserNotificationTopicInput]
|
The notification topics to subscribe the User to during registration. |
notification_profiles - [UserNotificationProfileInput]
|
The notification profiles to create for the User during registration. |
platform_context - PlatformContextEnum
|
The platform context for the User registration policy check. Default = web |
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],
$platform_context: PlatformContextEnum
) {
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,
platform_context: $platform_context
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
is_terms_and_conditions_renewal_required
}
}
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": 987.65,
"is_terms_and_conditions_opt_in": false,
"is_newsletter_opt_in": false,
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"platform_context": "web"
}
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",
"is_terms_and_conditions_renewal_required": true
}
}
}
UserRegistrationVerify
Description
Verify a newly registered User account.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
token - String
|
The account verification token received by e-mail. |
Example
Query
mutation UserRegistrationVerify($token: String) {
UserRegistrationVerify(token: $token)
}
Variables
{"token": "string"}
Response
{"data": {"UserRegistrationVerify": false}}
UserRestore
Description
Restore the authenticated User account by 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 Subscription for the current User.
Response
Returns a UserSubscriptionAcquire
Arguments
| Name | Description |
|---|---|
payment_provider_id - Int
|
The PaymentProvider id used to process the purchase. |
subscription_id - Int
|
The id of the Subscription to acquire. |
voucher_code - String
|
A PaymentSyndicateVoucher Code to apply to the purchase. |
redirect_url_path - String
|
The path the User is redirected to after completing the purchase at the PaymentProvider. |
uuid - String
|
The Device uuid this acquisition originates from, used to identify the requesting Device. |
key - String
|
The Device key paired with uuid, stored on the requesting Device. |
is_use_amount_balance - Boolean
|
Whether the User's existing account balance is applied to the purchase. |
payment_methods - [PaymentMethodInput]
|
The payment methods to use for this transaction (multiple methods restrict the displayed methods on the check-out page, a single method enforces using it). |
categories - [Int]
|
The Category ids attributed to this purchase (e.g. for Partner channel tracking). |
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 the current User's valid and active UserSubscription.
UserSubscriptionSwitch
Description
Schedule the current User's UserSubscription to switch to a different Subscription at its next renewal (invoiced_at), or undo an already scheduled switch. For an immediate switch instead, use UserPurchaseIntentAcquire with is_allow_subscription_switch.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the UserSubscription to schedule the switch for. |
switch_to_subscription_id - Int
|
The id of the Subscription to switch to at the UserSubscription's next renewal. Pass 0 (or the id of the UserSubscription's current Subscription) to cancel a previously scheduled switch. |
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 the current User's valid and suspended UserSubscription.
UserTermsAndConditionsAccept
Description
Accept the current terms and conditions for the authenticated User.
Response
Returns a Boolean
Example
Query
mutation UserTermsAndConditionsAccept {
UserTermsAndConditionsAccept
}
Response
{"data": {"UserTermsAndConditionsAccept": true}}
Types
ActivityLogLevelEnum
Description
An ActivityLog severity level
Values
| Enum Value | Description |
|---|---|
|
|
A system error log entry that indicates an unexpected technical failure. |
|
|
A configuration error log entry that indicates missing, invalid, or inconsistent Project settings. |
|
|
A warning log entry for a recoverable or attention-worthy condition. |
|
|
An informational log entry for expected operational activity. |
|
|
A debug log entry with low-level diagnostic details. |
Example
"system_error"
AdminActivityLog
Description
An admin ActivityLog
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the ActivityLog |
log_name - String
|
The ActivityLog event name |
description - String
|
The ActivityLog human-readable description |
created_at - String
|
The ActivityLog creation date in UTC |
updated_at - String
|
The ActivityLog last modification date in UTC |
project_id - Int
|
The Project id that owns the ActivityLog |
user_id - Int
|
The User id associated with the ActivityLog |
log_level - ActivityLogLevelEnum
|
The ActivityLog severity level |
status - Int
|
The ActivityLog processing status code |
properties - String
|
The ActivityLog JSON-encoded properties |
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 administrative Article representation with publication, Asset, categorization, and entitlement relations.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Article. |
project_id - Int!
|
The Project id that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [AdminArticleMeta]
|
The Article's metadata properties. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [AdminAsset]
|
The Article's Assets. |
categories - [AdminCategory]
|
The Categories this Article belongs to. |
Arguments
|
|
geo_regions - [GeoRegion]
|
The geo regions this Article's availability is restricted to. |
locale_regions - [LocaleRegion]
|
The locale regions this Article's availability is restricted to. |
products - [AdminProduct]
|
The Article's related Products. |
upsell_products - [AdminProduct]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
is_auto_generate_recommendations - Boolean
|
Whether the Article auto-generates its recommended Articles. |
is_show_in_all_geo_regions - Boolean
|
Whether the Article is shown in all geo-regions, regardless of its own geo-restriction. |
generic_url - String
|
The Article's generic (non-localized) url. |
url_slug_translations - [Translation]
|
The Article's url_slug, per locale. |
full_url_slug_translations - [Translation]
|
The Article's full_url_slug, per locale. |
canonical_url_translations - [Translation]
|
The Article's canonical_url, per locale. |
canonical_title_translations - [Translation]
|
The Article's canonical_title, per locale. |
upsell_product_call_to_action_tag_translations - [Translation]
|
The Article's upsell_product_call_to_action_tag, per locale. |
ribbon_title_translations - [Translation]
|
The Article's ribbon_title, per locale. |
children - [AdminArticle]
|
The Article's child Articles. |
recommended_articles - [AdminArticle]
|
The Article's recommended Articles. |
featured_on_categories - [AdminCategory]
|
The Categories this Article is featured on. |
files - [File]
|
The Article's Files. |
Arguments
|
|
entitling_subscriptions - [AdminSubscription]
|
The Subscriptions that can entitle access to this Article. |
published_from - String
|
The Article's publish-from date (UTC). |
published_until - String
|
The Article's publish-until date (UTC). |
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",
"episode_list_display_type": "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": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": false,
"is_show_in_all_geo_regions": true,
"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
A metadata property on an Article.
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 Article id that owns this metadata property. |
translations - [ArticleMetaTranslation]
|
The metadata property's per-locale translations. |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42,
"translations": [ArticleMetaTranslation]
}
AdminAsset
Description
The full Asset record, including administrative fields not present on the lighter AdminAssetListed shape.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Asset |
project_id - Int!
|
The Project id that owns the Asset |
source_blob_name - String
|
A descriptive name for the Asset's uploaded source file. |
thumbnail_asset_id - String
|
The Asset's identifier for its generated thumbnail image at the media provider. |
is_live - Boolean
|
Whether this Asset is being treated as live. Only meaningful for Assets of type "video" or "audio": a live_video-type Asset's live-ness is already implied by its type, independently of this flag. |
type - AssetTypeEnum
|
The Asset's media type. |
linked_type - ArticleAssetLinkedTypeEnum
|
The Asset's role within its Article (e.g. episode, film, preview, trailer). |
accessibility - ResourceAccessibilityEnum
|
The Asset's accessibility within its Article. |
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 Asset's duration (seconds) |
aspect_ratio - String
|
The Asset's human-readable aspect ratio (e.g. 16x9) |
aspect_ratio_fraction - String
|
The Asset's fractional aspect ratio (e.g. 1.778) |
subtitles - [File]
|
The Asset's subtitle Files |
Arguments
|
|
screenshots - [File]
|
The Asset's screenshot image Files |
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
|
The md5 checksum of the Asset's uploaded source file. |
source_asset_id - String
|
The Asset's identifier at the source/originating system, distinct from AudiencePlayer's own Asset id. |
encoded_asset_name - String
|
The Asset's file name for its encoded representation at the media provider. |
encoded_asset_id - String
|
The Asset's identifier for its encoded representation at the media provider. |
streaming_unit_id - String
|
Streaming unit id |
origin - String
|
Upload origin |
streaming_endpoint - String
|
Media url locator |
asset_status_id - Int!
|
The Asset's lifecycle status, as its raw numeric id. |
asset_status - AssetStatusEnum
|
The Asset's lifecycle status. The same underlying value as asset_status_id, exposed as a typed enum. |
ingestion_status - String
|
A coarser-grained bucket derived from asset_status_id, one of: processing, error, ok, unpublished, deleted. |
ingestion_status_description - String
|
A human-readable progress label for asset_status_id (e.g. "INGESTING 60% [4]"), not intended for programmatic matching. |
external_asset_id - String
|
An optional external/third-party identifier label for the Asset, used for administrative purposes only. |
stored_bytes - Float
|
Total amount of bytes stored on disk for this Asset |
stored_giga_bytes - Float
|
Total amount of gigabytes stored on disk for this Asset |
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) |
last_event_message - String
|
The last logged processing event message. Only populated while the Asset is currently in an error status; null otherwise, even if an event message exists from an earlier, now-resolved error. |
active_asset_recording_id - Int
|
The id of this live-video Asset's currently active (or last) recording. |
active_recording - AdminAssetRecording
|
This live-video Asset's currently active (or last) recording. |
recordings - [AdminAssetRecording]
|
All recordings for this live-video Asset, optionally filtered by status. |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": false,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 123.45,
"time_marker_end": 987.65,
"duration": 987.65,
"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",
"stored_bytes": 987.65,
"stored_giga_bytes": 987.65,
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [StructureKeyValueStringPair],
"last_event_message": "string",
"active_asset_recording_id": 42,
"active_recording": AdminAssetRecording,
"recordings": [AdminAssetRecording]
}
AdminAssetRecording
Description
A recording of a live-video Asset's channel.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the recording. |
asset_id - Int
|
The id of the Asset this recording belongs to. |
project_id - Int
|
The Project id that owns the Asset. |
remote_recording_id - String
|
Remote provider recording identifier |
time_delta - Float
|
Duration of the recording in seconds |
status - String
|
Recording status: active, finished, post_processing, completed, failed |
file_path - String
|
File path of the recording at the remote provider |
started_at - String
|
Datetime (UTC) at which the recording was started |
completed_at - String
|
Datetime (UTC) at which the recording was completed |
created_at - String
|
Datetime (UTC) at which this record was created |
updated_at - String
|
Datetime (UTC) at which this record was last updated |
download_url - String
|
Signed download URL for the recording MP4. Only populated for recordings with status "completed". Resolved via AdminAsset query. |
Example
{
"id": 42,
"asset_id": 42,
"project_id": 42,
"remote_recording_id": "string",
"time_delta": 987.65,
"status": "string",
"file_path": "string",
"started_at": "2000-12-31T12:34:56.000Z",
"completed_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"download_url": "https://url.example.com"
}
AdminCategory
Description
An administrative Category representation used to organize Articles and Products in a hierarchy.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Category. |
project_id - Int!
|
The Project id that owns this Category. |
name - String
|
The Category's name. |
url_slug - String
|
The Category's url slug. |
Arguments
|
|
full_url_slug - String
|
The Category's full url slug. |
Arguments
|
|
canonical_url - String
|
The Category's canonical url. |
type - CategoryTypeEnum
|
The Category's type. |
metas - [AdminCategoryMeta]
|
The Category's metadata properties. |
Arguments
|
|
articles - [AdminArticle]
|
The Articles in this Category. |
Arguments
|
|
products - [AdminProduct]
|
The Products in this Category. |
Arguments
|
|
featured_articles - [AdminArticle]
|
The Articles featured in this Category. |
icons - [File]
|
The Category's icon Files. |
images - [File]
|
The Category's image Files. |
videos - [File]
|
The Category's video Files. |
parent_id - Int
|
The id of the Category's parent Category. |
child_metas - [String]
|
The metadata field names available on this Category's child Categories. |
created_at - String
|
The Category's creation date (UTC). |
updated_at - String
|
The Category's last modification date (UTC). |
generic_url - String
|
The Category's generic (non-localized) url. |
url_slug_translations - [Translation]
|
The Category's url_slug, per locale. |
full_url_slug_translations - [Translation]
|
The Category's full_url_slug, per locale. |
canonical_url_translations - [Translation]
|
The Category's canonical_url, per locale. |
posters - [File]
|
The Category's poster Files. |
files - [File]
|
The Category's Files. |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
The Category's visibility. |
status - Int
|
The Category's status. |
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 metadata property on a Category.
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 Category id that owns this metadata property. |
translations - [CategoryMetaTranslation]
|
The metadata property's per-locale translations. |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42,
"translations": [CategoryMetaTranslation]
}
AdminDevice
Description
An admin Device
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Device. |
name - String
|
The Device's name. |
uuid - String
|
The Device's UUID. |
project_id - Int
|
The Project id that owns the Device. |
user_id - Int
|
The id of the User that owns the Device. |
created_at - String
|
The Device's creation date-time (UTC). |
type - String
|
The Device's type. |
operator_context - String
|
The Device's operator context. |
brand - String
|
The Device's detected brand. |
model - String
|
The Device's detected model. |
key - String
|
The Device's encoded authentication key. |
ip_address - String
|
The Device's last recorded 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 administrative Metric representation containing the conditions, resources, eligible Users, and MetricActions needed to inspect or manage an eligibility rule.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Metric. |
project_id - Int!
|
The Project id that owns this Metric. |
name - String
|
The Metric's name. |
description - String
|
The Metric's description. |
time_window - Int
|
The Metric's time window (hours), leading up to the moment of evaluation. |
type - MetricTypeEnum
|
The Metric's type. |
published_from - String
|
The UTC date/time from which the Metric may be evaluated. |
published_until - String
|
The UTC date/time until which the Metric may be evaluated. |
created_at - String
|
The creation date (UTC) of the Metric. |
updated_at - String
|
The last modification date (UTC) of the Metric. |
status - MetricStatusEnum
|
The Metric's publication status. |
conditions - [AdminMetricCondition]
|
The MetricConditions for this Metric. |
articles - [AdminArticle]
|
The Articles that scope this Metric. |
categories - [AdminCategory]
|
The Categories that scope this Metric. |
products - [AdminProduct]
|
The Products that scope this Metric. |
subscriptions - [AdminSubscription]
|
The Subscriptions that scope this Metric. |
eligible_users - [AdminUser]
|
The Users eligible for this Metric. |
metric_actions - [AdminMetricAction]
|
The MetricActions triggered by this 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 administrative MetricAction representation containing the fulfillment configuration, linked Metrics, Products, and eligible Users used when a Metric matches.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the MetricAction. |
project_id - Int!
|
The Project id that owns this MetricAction. |
name - String
|
The MetricAction's name. |
title - String
|
The MetricAction's title. |
content - String
|
The MetricAction's content. |
icons - [File]
|
The MetricAction's icon Files. |
images - [File]
|
The MetricAction's image Files. |
files - [File]
|
The MetricAction's Files. |
Arguments
|
|
title_translations - [Translation]
|
The MetricAction's title translations. |
content_translations - [Translation]
|
The MetricAction's content translations. |
Arguments
|
|
type - MetricActionTypeEnum
|
The MetricAction's type. |
status - MetricActionStatusEnum
|
The MetricAction's publication status. |
webhook_url - String
|
The MetricAction's webhook URL. |
user_subscription_installment_num - Int
|
The number of User subscription installments this MetricAction entitles. |
user_subscription_installment_time_unit - String
|
The time unit for the User subscription installments this MetricAction entitles. |
created_at - String
|
The creation date (UTC) of the MetricAction. |
updated_at - String
|
The last modification date (UTC) of the MetricAction. |
products - [AdminProductListedAsRelation]
|
The Products this MetricAction entitles when fulfilled. |
eligible_users - [AdminUser]
|
The Users eligible for this MetricAction. |
metrics - [AdminMetric]
|
The Metrics that may trigger this MetricAction. |
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 administrative MetricCondition representation used by a Metric to determine whether a User matches.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the MetricCondition. |
metric_id - Int
|
The Metric id that owns this MetricCondition. |
type - MetricConditionTypeEnum
|
The MetricCondition's type, the resource property it evaluates. |
logic_operator - LogicOperatorEnum
|
The MetricCondition's logic operator, used to compare its "type" against "value". |
value - String
|
The MetricCondition's comparison value. |
created_at - String
|
The creation date (UTC) of the MetricCondition. |
updated_at - String
|
The last modification date (UTC) of the MetricCondition. |
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 administrative Notification representation with delivery, content, targeting, and publication settings.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Notification. |
project_id - Int!
|
The Project id that owns the Notification. |
parent_id - Int
|
The id of the parent Notification. |
name - String
|
The Notification's internal name. |
title - String
|
The Notification's localized title. |
content - String
|
The Notification's localized content. |
url - String
|
The URL or route triggered when the Notification is tapped. |
delivery_type - NotificationDeliveryTypeEnum
|
The Notification's delivery audience strategy. |
type - NotificationTypeEnum
|
The Notification's lifecycle and behavior type. |
notification_channel_contexts - [String]
|
The delivery channel contexts used by this Notification. |
icons - [File]
|
Icon Files attached to this Notification. |
images - [File]
|
Image Files attached to this Notification. |
posters - [File]
|
Poster Files attached to this Notification. |
videos - [File]
|
Video Files attached to this Notification. |
files - [File]
|
Files attached to this Notification. |
Arguments
|
|
children - [AdminNotification]
|
Child Notifications of this Notification. |
title_translations - [Translation]
|
The Notification's title translations. |
content_translations - [Translation]
|
The Notification's content translations. |
Arguments
|
|
articles - [AdminArticle]
|
Articles linked to this Notification. |
Arguments
|
|
categories - [AdminCategory]
|
Categories linked to this Notification. |
Arguments
|
|
notification_topics - [AdminNotificationTopic]
|
NotificationTopics under which this Notification is sent. |
Arguments
|
|
frequency - Float
|
The Notification's recurring delivery frequency per time unit. |
time_unit - SubscriptionTimeUnitEnum
|
The Notification's recurring delivery time unit. |
status - Int
|
The Notification's publication status. |
schedule_at - String
|
The UTC datetime when the Notification is scheduled for delivery. |
delivered_at - String
|
The UTC datetime when the Notification was delivered. |
created_at - String
|
The UTC datetime when the Notification was created. |
updated_at - String
|
The UTC datetime when the Notification was last updated. |
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 administrative NotificationTopic representation that Users may subscribe to for targeted delivery.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the NotificationTopic. |
remote_notification_topic_id - String
|
The remote id of the NotificationTopic used by push-notification providers. |
project_id - Int!
|
The Project id that owns the NotificationTopic. |
name - String
|
The NotificationTopic's internal name. |
title - String
|
The NotificationTopic's localized title. |
description - String
|
The NotificationTopic's localized description. |
title_translations - [Translation]
|
The NotificationTopic's title translations. |
description_translations - [Translation]
|
The NotificationTopic's description translations. |
Arguments
|
|
notifications - [AdminNotification]
|
Notifications assigned to this NotificationTopic. |
Arguments
|
|
type - NotificationTopicTypeEnum
|
The NotificationTopic's content type. |
status - Int
|
The NotificationTopic's publication status. |
created_at - String
|
The UTC datetime when the NotificationTopic was created. |
updated_at - String
|
The UTC datetime when the NotificationTopic was last updated. |
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
An administrated PaymentProvider listed as a relation.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PaymentProvider. |
project_id - Int!
|
The Project id that owns the PaymentProvider. |
name - String
|
The PaymentProvider's name. |
description - String
|
The PaymentProvider's description. |
type - String
|
The PaymentProvider's provider type. |
status - PaymentProviderStatusEnum
|
The PaymentProvider's status. |
device_capability - Int
|
The PaymentProvider's device payment capability flags. |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42
}
AdminPaymentSyndicate
Description
An administrative PaymentSyndicate representation that owns PaymentSyndicateVouchers.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PaymentSyndicate. |
project_id - Int!
|
The Project id that owns the PaymentSyndicate. |
name - String
|
The PaymentSyndicate's name. |
type - PaymentSyndicateTypeEnum
|
The PaymentSyndicate's type. |
created_at - String
|
The PaymentSyndicate's creation date (UTC). |
updated_at - String
|
The PaymentSyndicate's last modification date (UTC). |
vouchers - [AdminPaymentSyndicateVoucher]
|
The PaymentSyndicateVouchers belonging to the PaymentSyndicate. |
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
An administrative PaymentSyndicateVoucher representation defining eligibility, validity, claims, and entitlement effects.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PaymentSyndicateVoucher. |
project_id - Int!
|
The Project id that owns the PaymentSyndicateVoucher. |
description - String
|
The PaymentSyndicateVoucher's description. |
name - String
|
The PaymentSyndicateVoucher's name. |
payment_syndicate_id - Int
|
The PaymentSyndicate id that owns the PaymentSyndicateVoucher. |
subscription_id - Int
|
The Subscription id this PaymentSyndicateVoucher is scoped to, when applicable. |
description_translations - [Translation]
|
The PaymentSyndicateVoucher's description, translated per locale. |
currency - String
|
The PaymentSyndicateVoucher's currency code (e.g. "EUR"). |
currency_symbol - String
|
The PaymentSyndicateVoucher's currency symbol (e.g. "€"). |
amount - Float
|
The PaymentSyndicateVoucher's price/discount amount, interpreted according to discount_type. |
installment_num - Int
|
The number of periodical subscription installments this PaymentSyndicateVoucher applies to, in units of time_unit. |
max_claimed_num - Int
|
The maximum number of times a Voucher Code belonging to this PaymentSyndicateVoucher can be claimed in total. |
max_claimed_per_user_num - Int
|
The maximum number of times a unique Voucher Code can be claimed by a unique User. |
claimed_num - Int
|
The total number of times Voucher Codes belonging to this PaymentSyndicateVoucher have been claimed. |
is_allow_on_valid_subscription - Boolean
|
Whether this PaymentSyndicateVoucher may be applied even when the User already has a valid Subscription. |
user_subscription_status_action - String
|
The UserSubscription status forced after this PaymentSyndicateVoucher is validated. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon claiming this PaymentSyndicateVoucher. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit in which installment_num is expressed. |
discount_type - PaymentSyndicateVoucherDiscountTypeEnum
|
How amount is applied to the resource price. |
installment_type - PaymentSyndicateVoucherInstallmentTypeEnum
|
The PaymentSyndicateVoucher's installment type. |
type - PaymentSyndicateVoucherTypeEnum
|
The resource type this PaymentSyndicateVoucher is applicable to. |
issue_installments_until - String
|
The fixed date (UTC) up until which installments are issued for this PaymentSyndicateVoucher. |
installed_at - String
|
The date (UTC) from which this PaymentSyndicateVoucher's Voucher Codes may be claimed. |
expires_at - String
|
The date (UTC) until which this PaymentSyndicateVoucher's Voucher Codes may be claimed. |
created_at - String
|
The PaymentSyndicateVoucher's creation date (UTC). |
updated_at - String
|
The PaymentSyndicateVoucher's last modification date (UTC). |
syndicate - AdminPaymentSyndicate
|
The PaymentSyndicate that owns the PaymentSyndicateVoucher. |
batches - [AdminPaymentSyndicateVoucherCodeBatch]
|
The Voucher Code batches belonging to the PaymentSyndicateVoucher. |
scoped_products - [AdminProduct]
|
The Products this PaymentSyndicateVoucher may be applied to. Empty means no restriction. |
products - [AdminProductListedAsRelation]
|
The Products this PaymentSyndicateVoucher issues to the User upon being claimed. |
subscription - AdminSubscription
|
The Subscription this PaymentSyndicateVoucher is scoped to, when applicable. |
eligible_email_addresses - [String]
|
The e-mail addresses (or address fragments) eligible to claim this PaymentSyndicateVoucher. |
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": 987.65,
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"claimed_num": 42,
"is_allow_on_valid_subscription": true,
"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
A PaymentSyndicateVoucher Code.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Voucher Code. |
payment_syndicate_voucher_id - Int!
|
The PaymentSyndicateVoucher id that owns the Voucher Code. |
payment_syndicate_voucher_code_batch_id - Int!
|
The Voucher Code batch id that owns the Voucher Code. |
code - String
|
The Voucher Code's value, as claimed by a User. |
claimed_num - Int!
|
The number of times the Voucher Code has been claimed. |
claimed_at - String
|
The Voucher Code's most recent claim date (UTC). |
created_at - String
|
The Voucher Code's creation date (UTC). |
updated_at - String
|
The Voucher Code's last modification date (UTC). |
batch - AdminPaymentSyndicateVoucherCodeBatch
|
The Voucher Code batch that owns 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
A batch of PaymentSyndicateVoucher Codes.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Voucher Code batch. |
payment_syndicate_voucher_id - Int!
|
The PaymentSyndicateVoucher id that owns the Voucher Code batch. |
installment - Int
|
The Voucher Code batch's installment number. |
created_at - String
|
The Voucher Code batch's creation date (UTC). |
updated_at - String
|
The Voucher Code batch's last modification date (UTC). |
codes - AdminPaymentSyndicateVoucherCodesListedWithPagination
|
The Voucher Codes belonging to the Voucher Code batch. |
code_num - Int
|
The number of Voucher Codes in the Voucher Code batch. |
claimed_num - Int
|
The number of times Voucher Codes belonging to the 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
A paginated list of PaymentSyndicateVoucher Codes.
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentSyndicateVoucherCode]
|
The Voucher Codes. |
pagination - Pagination
|
The pagination details for this list. |
Example
{
"items": [AdminPaymentSyndicateVoucherCode],
"pagination": Pagination
}
AdminProduct
Description
An administrative Product representation with pricing, publication, and content-entitlement settings.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Product. |
project_id - Int!
|
The Project id that owns the Product. |
remote_product_id - String
|
The Product's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Product's name. |
title - String
|
The Product's title. |
description - String
|
The Product's description. |
Arguments
|
|
description_short - String
|
The Product's short description. |
Arguments
|
|
call_to_action_tag - String
|
The Product's call-to-action tag. |
type - ProductTypeEnum
|
The Product's type. |
credit_type - UserPaymentCreditTypeEnum
|
The type of credit this Product issues, when type is "credit" or "service_recurring_credit". |
currency - String
|
The Product's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Product's currency symbol (e.g. "€"). |
price - Float
|
The Product's price. |
credit_price - Float
|
The Product's price expressed in credits, as an alternative to price. |
credit_amount - Float
|
The quantity of credits this Product issues. |
amount_balance - Float
|
The monetary account balance amount this Product issues, when type is "amount_balance". |
purchase_num - Int
|
The number of times this Product has been purchased, in the context this Product is being resolved in (e.g. as part of a UserSubscription). |
max_purchase_num - Int
|
The maximum number of times a User may purchase this Product. |
expires_in - Int
|
The number of hours after purchase until entitlement from this Product expires (a "rental" window). |
expires_at - String
|
The fixed date (UTC) until which entitlement from this Product expires. |
created_at - String
|
The Product's creation date (UTC). |
updated_at - String
|
The Product's last modification date (UTC). |
icons - [File]
|
The Product's icon Files. |
images - [File]
|
The Product's image Files. |
posters - [File]
|
The Product's poster Files. |
videos - [File]
|
The Product's video Files. |
articles - [AdminArticle]
|
The Articles this Product entitles the User to, when type is "article" or "free_article". |
categories - [CategoryListedAsRelation]
|
The Categories the Product belongs to. |
Arguments
|
|
period_renewal_day - Int
|
The day of the period on which this Product renews (0 means relative to the day of acquisition, 1 means e.g. the first of the month). |
is_sync_installments - Boolean
|
Whether this recurring type Product is synchronised with its Subscription's own installments, rather than using its own time_unit/frequency. |
frequency - Float
|
How often, in units of time_unit, a recurring type Product not synced to its Subscription's installments is applied. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit in which frequency is expressed, for a recurring type Product not synced to its Subscription's installments. |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
The offset in seconds since midnight (UTC) applied to recurring_entitlement_expires_in_time_unit_num. |
recurring_entitlement_expires_in_time_unit_num - Int
|
Alternative to recurring_entitlement_expires_in: the number of time units after which a recurring type Product's issued entitlement/credit expires. |
recurring_entitlement_expires_in - Int
|
The number of hours after which a recurring type Product's issued entitlement/credit expires. |
title_translations - [Translation]
|
The Product's title, translated per locale. |
description_translations - [Translation]
|
The Product's description, translated per locale. |
Arguments
|
|
description_short_translations - [Translation]
|
The Product's short description, translated per locale. |
call_to_action_tag_translations - [Translation]
|
The Product's call-to-action tag, translated per locale. |
discoverability - ProductDiscoverabilityEnum
|
How discoverable the Product is to Users. |
status - ProductStatusEnum
|
The Product's publication status. |
published_from - String
|
The date (UTC) from which the Product may be purchased. |
published_until - String
|
The date (UTC) until which the Product may be purchased. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon purchasing this Product. |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The PaymentSyndicateVouchers this Product issues Voucher Codes from, when type is "voucher_code". |
notification_topics - [AdminNotificationTopic]
|
The NotificationTopics the User is subscribed to upon purchasing this Product. |
files - [File]
|
The Product's 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": 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]
}
AdminProductListedAsRelation
Description
A Product, as a relation on another resource.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Product. |
project_id - Int!
|
The Project id that owns the Product. |
remote_product_id - String
|
The Product's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Product's name. |
title - String
|
The Product's title. |
description - String
|
The Product's description. |
Arguments
|
|
description_short - String
|
The Product's short description. |
Arguments
|
|
call_to_action_tag - String
|
The Product's call-to-action tag. |
type - ProductTypeEnum
|
The Product's type. |
credit_type - UserPaymentCreditTypeEnum
|
The type of credit this Product issues, when type is "credit" or "service_recurring_credit". |
currency - String
|
The Product's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Product's currency symbol (e.g. "€"). |
price - Float
|
The Product's price. |
credit_price - Float
|
The Product's price expressed in credits, as an alternative to price. |
credit_amount - Float
|
The quantity of credits this Product issues. |
amount_balance - Float
|
The monetary account balance amount this Product issues, when type is "amount_balance". |
purchase_num - Int
|
The quantity of this Product in the context it is being resolved in. |
max_purchase_num - Int
|
The maximum number of times a User may purchase this Product. |
expires_in - Int
|
The number of hours after purchase until entitlement from this Product expires (a "rental" window). |
expires_at - String
|
The fixed date (UTC) until which entitlement from this Product expires. |
created_at - String
|
The Product's creation date (UTC). |
updated_at - String
|
The Product's last modification date (UTC). |
icons - [File]
|
The Product's icon Files. |
images - [File]
|
The Product's image Files. |
posters - [File]
|
The Product's poster Files. |
videos - [File]
|
The Product's video Files. |
articles - [AdminArticle]
|
The Articles this Product entitles the User to, when type is "article" or "free_article". |
categories - [CategoryListedAsRelation]
|
The Categories the Product belongs to. |
Arguments
|
|
period_renewal_day - Int
|
The day of the period on which this Product renews (0 means relative to the day of acquisition, 1 means e.g. the first of the month). |
is_sync_installments - Boolean
|
Whether this recurring type Product is synchronised with its Subscription's own installments, rather than using its own time_unit/frequency. |
frequency - Float
|
How often, in units of time_unit, a recurring type Product not synced to its Subscription's installments is applied. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit in which frequency is expressed, for a recurring type Product not synced to its Subscription's installments. |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
The offset in seconds since midnight (UTC) applied to recurring_entitlement_expires_in_time_unit_num. |
recurring_entitlement_expires_in_time_unit_num - Int
|
Alternative to recurring_entitlement_expires_in: the number of time units after which a recurring type Product's issued entitlement/credit expires. |
recurring_entitlement_expires_in - Int
|
The number of hours after which a recurring type Product's issued entitlement/credit expires. |
title_translations - [Translation]
|
The Product's title, translated per locale. |
description_translations - [Translation]
|
The Product's description, translated per locale. |
Arguments
|
|
description_short_translations - [Translation]
|
The Product's short description, translated per locale. |
call_to_action_tag_translations - [Translation]
|
The Product's call-to-action tag, translated per locale. |
discoverability - ProductDiscoverabilityEnum
|
How discoverable the Product is to Users. |
status - ProductStatusEnum
|
The Product's publication status. |
published_from - String
|
The date (UTC) from which the Product may be purchased. |
published_until - String
|
The date (UTC) until which the Product may be purchased. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon purchasing this Product. |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The PaymentSyndicateVouchers this Product issues Voucher Codes from, when type is "voucher_code". |
notification_topics - [AdminNotificationTopic]
|
The NotificationTopics the User is subscribed to upon purchasing this Product. |
files - [File]
|
The Product's Files. |
Arguments
|
|
product_price - Float
|
A price override for this Product in the context it is being resolved in, replacing its own price. |
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": true,
"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
An admin Project
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Project. |
name - String
|
The Project's name. |
users - [User]
|
The Users related to this Project. |
managers - [User]
|
The manager Users related to this Project. |
status - Int
|
The Project's lifecycle status. |
status_label - String
|
The Project's lifecycle status label. |
Example
{
"id": 42,
"name": "string",
"users": [User],
"managers": [User],
"status": "string",
"status_label": "string"
}
AdminSubscription
Description
An administrative Subscription representation with billing, availability, and content-entitlement settings.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Subscription. |
project_id - Int!
|
The Project id that owns the Subscription. |
remote_subscription_id - String
|
The Subscription's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Subscription's name. |
title - String
|
The Subscription's title. |
description - String
|
The Subscription's description. |
Arguments
|
|
description_short - String
|
The Subscription's short description. |
Arguments
|
|
type - SubscriptionTypeEnum
|
The Subscription's type. |
price - Float
|
The Subscription's initial price (on first payment). |
price_per_installment - Float
|
The Subscription's price per recurring periodic installment. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's recurring periodic installment. |
time_unit_translation - String
|
The translated label of time_unit. |
frequency - Float
|
How often, in units of time_unit, the Subscription's recurring periodic installment repeats. |
currency - String
|
The Subscription's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Subscription's currency symbol (e.g. "€"). |
initial_installment_num - Int
|
The Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's initial installment. |
allow_suspend_after_installment_num - Int
|
The number of periodic installments after which a UserSubscription is allowed to be suspended. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for a UserSubscription. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon purchasing this Subscription. |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
Which Articles the Subscription entitles. |
is_credit_issuing - Boolean
|
Whether the Subscription periodically issues credits through one of its Products. |
purchase_num - Int
|
The quantity of the Subscription in the context it is being resolved in. Always 1. |
max_purchase_num - Int
|
The maximum quantity that may be purchased of this Subscription. Always 1. |
articles - [ArticleListedAsRelation]
|
The Articles individually selected (excluding descendant Categories) as part of the Subscription's entitlement_scope. |
categories - [CategoryListedAsRelation]
|
The Categories individually selected as part of the Subscription's entitlement_scope. |
payment_providers - [AdminPaymentProviderListedAsRelation]
|
The PaymentProviders through which this Subscription may be purchased. Empty means all PaymentProviders are allowed. |
icons - [File]
|
The Subscription's icon Files. |
images - [File]
|
The Subscription's image Files. |
posters - [File]
|
The Subscription's poster Files. |
videos - [File]
|
The Subscription's video Files. |
created_at - String
|
The Subscription's creation date (UTC). |
updated_at - String
|
The Subscription's last modification date (UTC). |
user_subscription_status_action - String
|
The UserSubscription status forced after purchasing this Subscription. |
title_translations - [Translation]
|
The Subscription's title, translated per locale. |
description_translations - [Translation]
|
The Subscription's description, translated per locale. |
Arguments
|
|
description_short_translations - [Translation]
|
The Subscription's short description, translated per locale. |
discoverability - SubscriptionDiscoverabilityEnum
|
How discoverable the Subscription is to Users. |
status - SubscriptionStatusEnum
|
The Subscription's publication status. |
products - [AdminProductListedAsRelation]
|
The Products included with a purchase of this Subscription. |
entitleable_articles - [ArticleListedAsRelation]
|
The complete list of Articles (including descendants of selected Categories) entitled through the Subscription. |
files - [File]
|
The Subscription's 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": false,
"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
|
The Project id that owns the User. |
name - String
|
The User's name. |
display_name - String
|
The User's display name, typically the User's first name or first part of the e-mail address. |
email - String
|
The User's e-mail address. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
status - UserStatusEnum
|
The User's verification status. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
geo_region_code - String
|
The User's country code. |
phone - String
|
The User's phone number. |
is_phone_verified - UserPhoneStatusEnum
|
The User's phone number verification status. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the User has accepted the terms and conditions. |
is_marked_for_deletion - Boolean
|
Whether the User's account is marked for deletion. |
delete_at - String
|
The date (UTC) at which the User's account will be deleted, when is_marked_for_deletion is true. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for the User. |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the User's current UserSubscription, if any. |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The most recent event of importance generated for the User's current UserSubscription, if any. |
subscription_id - Int
|
The Subscription id the User's current UserSubscription is an instance of, if any. |
favourite_articles - [ArticleRelated]
|
The Articles the User marked as favourite. |
nomadic_articles - [ArticleRelated]
|
The Articles the User has an active (in-progress) nomadic playback position for. |
history_articles - [ArticleRelated]
|
The Articles the User has completed. |
entitled_articles - [ArticleRelated]
|
The complete list of Articles the User is entitled to. |
entitled_root_articles - [ArticleRelated]
|
The root-level Articles the User is entitled to. |
articles - [ArticleRelated]
|
The Articles related to the User (favourite, nomadic, and/or history). |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
The User's latest active nomadic Article. |
consents - [UserConsent]
|
The User's cookie consent records. |
metric_actions - [MetricAction]
|
The MetricActions fulfilled by the User. |
notification_profiles - [UserNotificationProfile]
|
The User's notification delivery profiles. |
notification_topics - [UserNotificationTopic]
|
The NotificationTopics the User is subscribed to. |
user_subscriptions - [AdminUserSubscription]
|
The User's UserSubscriptions. |
user_products - [UserProduct]
|
The User's purchased Products. |
orders - [AdminUserPaymentAccountOrder]
|
The User's UserPaymentAccountOrders, excluding open, cancelled, aborted, and expired ones. |
user_payment_credit_amount - Float
|
The User's available credit amount for the given credit type. |
Arguments
|
|
user_payment_general_credit_amount - Float
|
The User's available general credit amount. |
user_payment_free_article_credit_amount - Float
|
The User's available free-article credit amount. |
user_payment_currency_amount - Float
|
The User's available account balance amount, in the currency indicated by user_payment_currency. |
user_payment_currency_symbol - String
|
The currency symbol paired with user_payment_currency. |
user_payment_currency - String
|
The currency code user_payment_currency_amount is expressed in. |
external_user_id - String
|
A third-party identifier for the User. |
metas - [AdminUserMeta]
|
The User's meta properties. |
Arguments
|
|
managed_projects - [AdminProject]
|
The Projects the User manages. |
recent_project - AdminProject
|
The Project the User most recently accessed. |
roles - [Role]
|
The User's Roles. |
user_product_orders - [AdminUserPaymentAccountOrder]
|
The User's UserPaymentAccountOrders for non-recurring Products and payment-method changes. |
payment_accounts - [AdminUserPaymentAccount]
|
The User's UserPaymentAccounts. |
article_view_sessions - [UserArticleSession]
|
The User's Article view sessions. |
Arguments
|
|
devices - [AdminDevice]
|
The User's paired Devices. |
activity_logs - [AdminActivityLog]
|
The User's activity log entries. |
Arguments
|
|
created_at - String
|
The User's creation date (UTC). |
updated_at - String
|
The User's last modification date (UTC). |
active_at - String
|
The User's last video viewing activity date (UTC). |
credits - [AdminUserPaymentCredit]
|
The User's payment credits. |
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": true,
"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": [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 meta property belonging to a User.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the meta property. |
user_id - Int
|
The User id that owns the meta property. |
key - String
|
The meta property's key. |
value - String
|
The meta property's value. |
translations - [UserMetaTranslation]
|
The meta property's value, translated per locale. |
type - MetaTypeEnum
|
The meta property's type. |
format - String
|
The meta property's rendering format. |
Example
{
"id": 42,
"user_id": 42,
"key": "string",
"value": "string",
"translations": [UserMetaTranslation],
"type": "array",
"format": "string"
}
AdminUserPaymentAccount
Description
An admin UserPaymentAccount
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserPaymentAccount. |
payment_provider_id - Int
|
The id of the PaymentProvider linked to the UserPaymentAccount. |
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 GeoRegion code from which the UserPaymentAccount creation originated. |
orders - [UserPaymentAccountOrder]
|
The UserPaymentAccountOrders for this account. |
remote_payment_user_id - String
|
The remote payment User id registered at the PaymentProvider or gateway. |
remote_payment_mandate_id - String
|
The remote payment mandate id registered at the PaymentProvider 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
An administrative UserPaymentAccountOrder representation with payment and installment details.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserPaymentAccountOrder. |
user_id - Int
|
The id of the User that owns the UserPaymentAccountOrder. |
user_subscription_id - String
|
The id of the UserSubscription related to the UserPaymentAccountOrder. |
payment_syndicate_voucher_id - Int
|
The id of the PaymentSyndicateVoucher attached to the UserPaymentAccountOrder. |
voucher_code - String
|
The Voucher Code attached to the UserPaymentAccountOrder. |
type - String
|
The UserPaymentAccountOrder's type. |
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 UserPaymentAccountOrder's amount. |
status - String
|
The UserPaymentAccountOrder's payment status. |
status_name - String
|
The UserPaymentAccountOrder's translated payment status name. |
description - String
|
The UserPaymentAccountOrder's description. |
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 UserPaymentAccountOrder's currency. |
currency_symbol - String
|
The UserPaymentAccountOrder's currency symbol. |
user - AdminUser
|
The User connected to the UserPaymentAccountOrder. |
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 GeoRegion code from which this UserPaymentAccountOrder 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
|
Whether the UserPaymentAccountOrder is 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 UserPaymentAccount for this order. |
user_subscription - AdminUserSubscription
|
The related user subscription |
products - [AdminProductListedAsRelation]
|
The Products related to the UserPaymentAccountOrder. |
Arguments
|
|
user_subscription_products - [AdminUserSubscriptionProduct]
|
The UserSubscriptionProducts related through the pivot relation. |
Arguments
|
|
categories - [AdminCategory]
|
The affiliation Categories this UserPaymentAccountOrder 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": true,
"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
An admin UserPaymentCredit
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserPaymentCredit. |
user_id - Int
|
The id of the User that owns the UserPaymentCredit. |
status - String
|
The UserPaymentCredit's status. |
type - String
|
The UserPaymentCredit's type. |
amount - Float
|
The UserPaymentCredit's original amount. |
amount_balance - Float
|
The UserPaymentCredit's remaining amount balance. |
installed_at - String
|
The UserPaymentCredit's installation date-time (UTC). |
expires_at - String
|
The UserPaymentCredit's expiry date-time (UTC). |
fulfilment_order - AdminUserPaymentAccountOrder
|
The UserPaymentAccountOrder through which this UserPaymentCredit was fulfilled. |
fulfilment_order_origin - String
|
The fulfilment order origin. |
fulfilment_order_purchase_origin - String
|
The fulfilment order purchase origin. |
orders - [AdminUserPaymentAccountOrder]
|
The UserPaymentAccountOrders through which this UserPaymentCredit was used. |
Example
{
"id": 42,
"user_id": 42,
"status": "string",
"type": "string",
"amount": 123.45,
"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
An administrative UserSubscription representation, including its status, renewal, entitlement, and payment details.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserSubscription. |
user_id - Int!
|
The User id that owns the UserSubscription. |
project_id - Int!
|
The Project id that owns the UserSubscription. |
subscription_id - Int!
|
The Subscription id the UserSubscription is an instance of. |
switch_from_subscription_id - Int
|
The Subscription id the UserSubscription was switched from, when applicable. |
switch_to_subscription_id - Int
|
The Subscription id the UserSubscription is scheduled to switch to at its next renewal, when status is "switch_at_renewal". |
term - Int
|
The UserSubscription's current term number (how many renewals it has completed). |
acquired_at - String
|
The UserSubscription's acquisition date (UTC). |
expires_at - String
|
The UserSubscription's current expiry date (UTC). |
suspendable_at - String
|
The date (UTC) from which the UserSubscription becomes eligible to be suspended. |
suspended_at - String
|
The date (UTC) at which the UserSubscription was suspended. |
invoiced_at - String
|
The UserSubscription's next invoice date (UTC). |
status - UserSubscriptionStatusEnum
|
The UserSubscription's status. |
status_name - String
|
The UserSubscription's status, as an upper-case label. |
is_valid - Boolean
|
Whether the UserSubscription is currently valid. |
is_expired - Boolean
|
Whether the UserSubscription's expires_at date has passed. |
is_suspendable - Boolean
|
Whether the UserSubscription is currently eligible to be suspended. |
is_account_method_changeable - Boolean
|
Whether the UserSubscription's payment account method may currently be changed. |
is_switchable - Boolean
|
Whether the UserSubscription may currently be switched to a different Subscription. |
user_subscription_products - [AdminUserSubscriptionProduct]
|
The Products entitled through the UserSubscription, as pivot relations carrying purchase/pricing details. |
Arguments
|
|
products - [AdminProductListedAsRelation]
|
The Products entitled through the UserSubscription. |
Arguments
|
|
orders - [AdminUserPaymentAccountOrder]
|
The UserPaymentAccountOrders associated with the UserSubscription. |
Arguments
|
|
subscription - AdminSubscription
|
The Subscription the UserSubscription is an instance of. |
switch_to_subscription - AdminSubscription
|
The Subscription the User will switch to at the UserSubscription's next renewal, when status is "switch_at_renewal". |
switch_from_subscription - AdminSubscription
|
The Subscription the UserSubscription was switched from, when applicable. |
account - AdminUserPaymentAccount
|
The UserPaymentAccount the UserSubscription is billed through. |
last_event_type - UserSubscriptionEventTypeEnum
|
The most recent event of importance generated for the UserSubscription, 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": false,
"is_expired": true,
"is_suspendable": false,
"is_account_method_changeable": true,
"is_switchable": false,
"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 Product entitled to a User through a UserSubscription.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the UserSubscriptionProduct. |
product_id - Int
|
The id of the Product entitled through the UserSubscription. |
user_subscription_id - Int
|
The UserSubscription id that entitles the Product. |
user_payment_account_order_id - Int
|
The UserPaymentAccountOrder id through which the Product was entitled. |
purchase_num - Int
|
The quantity of the Product entitled through the UserSubscription. |
product_price - Float
|
A price override for the Product in the context of this UserSubscription, replacing its own price. |
created_at - String
|
The UserSubscriptionProduct's creation date (UTC). |
renews_at - String
|
The date (UTC) on which the entitlement to the Product next renews. |
expires_at - String
|
The date (UTC) until which the entitlement to the Product remains valid. |
product - AdminProduct
|
The entitled Product. |
order - AdminUserPaymentAccountOrder
|
The UserPaymentAccountOrder through which the Product was entitled. |
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 that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [ArticleMeta]
|
The Article's SEO/metadata key-value entries. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [Asset]
|
The Assets linked to this Article. |
categories - [CategoryListedAsRelation]
|
The Categories this Article belongs to. |
Arguments
|
|
geo_regions - [GeoRegion]
|
The geo regions this Article's availability is restricted to. |
locale_regions - [LocaleRegion]
|
The locale regions this Article's availability is restricted to. |
products - [ProductListedAsRelation]
|
The Article's related Products. |
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
featured_on_categories - [CategoryListedAsRelation]
|
The Categories this Article is featured on. |
recommended_articles - [ArticleRelated]
|
The Article's recommended Articles. |
children - [Article]
|
The Article's child Articles. At most 200 nested Articles (all levels combined, in their listed order) are returned for the requested Article, the rest is left out without an error: request a smaller part of a large series instead, e.g. one season at a time. |
entitling_subscriptions - [SubscriptionListed]
|
The Subscriptions that can entitle access to this 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",
"episode_list_display_type": "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
How an Asset is linked to an Article (e.g. episode, film, preview, trailer), which also determines its default accessibility.
Values
| Enum Value | Description |
|---|---|
|
|
A regular episode of the Article. Defaults to authorized-only accessibility unless overridden explicitly. |
|
|
The main film content of the Article. Defaults to authorized-only accessibility unless overridden explicitly. |
|
|
A preview clip of the Article. Defaults to authenticated-only accessibility unless overridden explicitly. |
|
|
A trailer for the Article. Defaults to everyone accessibility unless overridden explicitly. |
Example
"episode"
ArticleAssetPlay
Description
An Article-Asset playback 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 Asset's duration (seconds) |
aspect_ratio - String
|
The Asset's human-readable aspect ratio (e.g. 16x9) |
aspect_ratio_fraction - Float
|
The Asset's fractional aspect ratio (e.g. 1.778) |
linked_type - ArticleAssetLinkedTypeEnum
|
The Asset's role within this Article (e.g. episode, film, preview, trailer). |
subtitles - [File]
|
The Asset's subtitle Files |
Arguments
|
|
entitlements - [ArticleAssetPlayEntitlement]
|
The Asset's playback entitlements |
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products |
appa - Float
|
The Asset's absolute play position |
appr - Float
|
The Asset's relative play position |
pulse_updated_at - String
|
The Asset's pulse updated date (UTC) |
pulse_token - String
|
The Asset's pulse token |
concurrent_user_num - Int
|
The number of concurrent Users currently playing this Article-Asset combination. |
fairplay_certificate_url - String
|
The FairPlay certificate url |
user_subtitle_locale - String
|
The User's preferred subtitle locale |
user_audio_locale - String
|
The User's 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": 987.65,
"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"
}
ArticleAssetPlayEntitlement
Description
An Article-Asset playback entitlement.
Fields
| Field Name | Description |
|---|---|
media_provider - String
|
The media provider |
encryption_type - String
|
The DRM/encryption technology applied to this playback entitlement. Null when no encryption is applied (never the literal "none" value), for compatibility with legacy clients. |
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
|
Whether this playback is being treated as live. Only meaningful for Assets of type "video" or "audio": a live_video-type Asset's live-ness is already implied by its type, independently of this flag. |
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's discoverability through listing/browse/search surfaces.
Values
| Enum Value | Description |
|---|---|
|
|
Hidden from all listing/browse/search surfaces, but still directly reachable by id or direct link. |
|
|
Discoverable through listing/browse/search surfaces. |
Example
"hidden"
ArticleEntitlingResources
Description
The Products and Subscriptions that can entitle access to a given Article.
Fields
| Field Name | Description |
|---|---|
subscriptions - [SubscriptionListed]
|
The entitling Subscriptions. |
products - [ProductListed]
|
The entitling Products. |
Example
{
"subscriptions": [SubscriptionListed],
"products": [ProductListed]
}
ArticleFeatured
Description
An Article, as it appears when listed as featured.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Article. |
project_id - Int!
|
The Project id that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [ArticleMeta]
|
The Article's SEO/metadata key-value entries. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [Asset]
|
The Article's Assets. |
categories - [CategoryListedAsRelation]
|
The Categories this Article belongs to. |
Arguments
|
|
products - [ProductListedAsRelation]
|
The Article's related Products. |
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
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",
"episode_list_display_type": "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": true,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListFilterTypeEnum
Description
A preconfigured Article list filter, used in place of explicit sort_by/filter_by arguments.
Values
| Enum Value | Description |
|---|---|
|
|
Articles trending in recent popularity. |
|
|
The most popular Articles overall. |
|
|
The most recently added Articles. |
Example
"trending"
ArticleListed
Description
An Article, as it appears within a list of Articles.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Article. |
project_id - Int!
|
The Project id that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [ArticleMeta]
|
The Article's SEO/metadata key-value entries. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [Asset]
|
The Assets linked to this Article. |
categories - [CategoryListedAsRelation]
|
The Categories this Article belongs to. |
Arguments
|
|
geo_regions - [GeoRegion]
|
The geo regions this Article's availability is restricted to. |
locale_regions - [LocaleRegion]
|
The locale regions this Article's availability is restricted to. |
products - [ProductListedAsRelation]
|
The Article's related Products. |
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
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",
"episode_list_display_type": "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"
}
ArticleListedAsRelation
Description
An Article, as it appears when listed as a related resource of another Article.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Article. |
project_id - Int!
|
The Project id that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [ArticleMeta]
|
The Article's SEO/metadata key-value entries. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [Asset]
|
The Assets linked to this Article. |
categories - [CategoryListedAsRelation]
|
The Categories this Article belongs to. |
Arguments
|
|
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
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",
"episode_list_display_type": "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": true,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListedAsResource
Description
An Article, as it appears within a generic resource listing.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
The Article's visibility. |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
ArticleMeta
Description
A metadata property on an Article.
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 Article id that owns this metadata property. |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42
}
ArticleMetaTranslation
Description
A single-locale translation of an ArticleMeta property.
Example
{
"id": 42,
"value": "string",
"locale": "string",
"article_meta_id": 42
}
ArticlePlayAudioQualityEnum
Description
The audio stream quality
Values
| Enum Value | Description |
|---|---|
|
|
512kbps audio bitrate (highest quality, multi-channel/AC3 range). |
|
|
384kbps audio bitrate (multi-channel/AC3 range). |
|
|
256kbps audio bitrate (maximum for standard stereo). |
|
|
128kbps audio bitrate (lowest quality). |
Example
"audio_512kb"
ArticlePlayProtocolEnum
Description
The media stream protocol
Values
| Enum Value | Description |
|---|---|
|
|
HTTP Live Streaming (general usage): Recommended for the Apple ecosystem and most other clients, including Chromecast, SmartTV etc. |
|
|
MPEG Dynamic Adaptive Streaming over HTTP (general usage): Recommended for the Google/Android ecosystem. |
|
|
Microsoft Smooth Streaming: DEPRECATED. Not recommended for general usage and not under default support. |
|
|
Microsoft Smooth Streaming (manifest version 2.0, legacy/compatibility variant): DEPRECATED. Not recommended for general usage and not under default support. |
|
|
HTTP Live Streaming (manifest version 3, legacy/compatibility variant): Not recommended for general usage and not under default support. |
|
|
HTTP Live Streaming (manifest version 4, legacy/compatibility variant): Not recommended for general usage and not under default support. |
|
|
HTTP Live Streaming (manifest version 7, legacy/compatibility variant): Not recommended for general usage and not under default support. |
|
|
Progressive Download (direct, non-adaptive file playback). Only to be used for extreme legacy devices, not under default support. |
Example
hls
ArticlePlayResolutionEnum
Description
The media stream resolution
Values
| Enum Value | Description |
|---|---|
|
|
4K Ultra HD (3840×2160, landscape). |
|
|
Quad HD (2560×1440, landscape). |
|
|
Full HD (1920×1080, landscape). |
|
|
HD (1280×720, landscape). |
|
|
qHD (960×540, landscape). |
|
|
nHD (640×360, landscape). |
|
|
Lowest supported resolution (320×180, landscape). |
|
|
4K Ultra HD (2160×3840, portrait). |
|
|
Quad HD (1440×2560, portrait). |
|
|
Full HD (1080×1920, portrait). |
|
|
HD (720×1280, portrait). |
|
|
qHD (540×960, portrait). |
|
|
nHD (360×640, portrait). |
|
|
Lowest supported resolution (180×320, portrait). |
Example
"w3840_h2160"
ArticleRelated
Description
An Article, as it appears when listed as related to a User's viewing or entitlement history.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Article. |
project_id - Int!
|
The Project id that owns the Article. |
parent_id - Int
|
The id of the parent Article, for a hierarchical Article. |
name - String
|
The Article's name. |
url_slug - String
|
The Article's url slug. |
Arguments
|
|
full_url_slug - String
|
The Article's full (hierarchical) url slug. |
Arguments
|
|
canonical_url - String
|
The Article's canonical url. |
canonical_title - String
|
The Article's canonical title. |
episode_list_display_type - String
|
How child episodes are displayed for this Article, when it is a season-type Article. |
upsell_product_call_to_action_tag - String
|
The call-to-action tag shown alongside the Article's upsell Products. |
ribbon_title - String
|
The Article thumbnail's ribbon title. |
ribbon_settings - String
|
Style settings (JSON) for the Article thumbnail's ribbon. |
type - ArticleTypeEnum
|
The Article's type (e.g. film, trailer, episode). |
metas - [ArticleMeta]
|
The Article's SEO/metadata key-value entries. |
Arguments
|
|
icons - [File]
|
The Article's icon Files. |
images - [File]
|
The Article's image Files. |
posters - [File]
|
The Article's poster image Files. |
videos - [File]
|
The Article's video Files. |
documents - [File]
|
The Article's document Files. |
assets - [Asset]
|
The Assets linked to this Article. |
categories - [CategoryListedAsRelation]
|
The Categories this Article belongs to. |
Arguments
|
|
geo_regions - [GeoRegion]
|
The geo regions this Article's availability is restricted to. |
locale_regions - [LocaleRegion]
|
The locale regions this Article's availability is restricted to. |
products - [ProductListedAsRelation]
|
The Article's related Products. |
upsell_products - [ProductListedAsRelation]
|
The Article's related upsell Products. |
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 Article's popularity index. |
visibility - ResourceVisibilityEnum
|
The Article's own visibility as a resource (e.g. whether its detail page is displayable), independent of whether its linked Asset is playable or entitled. |
discoverability - ArticleDiscoverabilityEnum
|
The Article's discoverability (e.g. whether it appears in search/listings). |
is_downloadable - Boolean
|
Whether the Article is available for in-app download. |
is_auth_required - Boolean
|
Whether the Article requires authentication to view. |
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
|
The Article's status. |
asset_id - Int
|
The Asset id this related Article represents. |
is_favourite - Boolean
|
Whether the Article is marked as favourite (only set when this related Article represents a viewed UserArticle). |
is_continue - Boolean
|
Whether the Article is marked as continue-watching (only set when this related Article represents a viewed UserArticle). |
is_history - Boolean
|
Whether the Article is marked as history (only set when this related Article represents a viewed UserArticle). |
subtitle_locale - String
|
The User's selected subtitle locale (only set when this related Article represents a viewed UserArticle). |
audio_locale - String
|
The User's selected audio locale (only set when this related Article represents a viewed UserArticle). |
rating_value - Float
|
The User's assigned rating value for the Article (only set when this related Article represents a viewed UserArticle). |
root_article_id - Int
|
The id of the entitled Article's root ancestor (typically an Article of type "series"). |
appa - Float
|
The Asset's absolute play position (only set when this related Article represents a viewed UserArticle). |
appr - Float
|
The Asset's relative play position (only set when this related Article represents a viewed UserArticle). |
linked_type - ArticleAssetLinkedTypeEnum
|
The Article's linked Asset type. |
entitling_product_id - Int
|
The id of the Product that entitled this Article (only set when this related Article represents an entitled Article). |
issuing_user_payment_account_order_id - Int
|
The id of the UserPaymentAccountOrder that issued this Article's entitlement (only set when this related Article represents an entitled Article). |
is_entitlement_expired - Boolean
|
Whether the Article's entitlement has expired (only set when this related Article represents an entitled Article). |
expires_in - Int
|
The entitlement's expiry interval, in seconds (only set when this related Article represents an entitled Article). |
expires_at - String
|
The entitlement's expiry date (UTC) (only set when this related Article represents an entitled Article). |
entitled_at - String
|
The entitlement date (UTC) (only set when this related Article represents an entitled Article). |
nomadic_updated_at - String
|
The nomadic UserArticle's last-updated date (UTC) (only set when this related Article represents a viewed UserArticle). |
nomadic_completed_at - String
|
The nomadic UserArticle's completion date (UTC) (only set when this related Article represents a viewed UserArticle). |
nomadic_num_completed - Int
|
The number of times the nomadic UserArticle has been completely viewed (only set when this related Article represents a viewed UserArticle). |
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",
"episode_list_display_type": "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's type.
Values
| Enum Value | Description |
|---|---|
|
|
A single episode within a season (depth 2 in the series hierarchy). |
|
|
A standalone film, not part of a series. |
|
|
A season within a series, grouping its episodes (depth 1 in the series hierarchy). |
|
|
A series, the top-level container for its seasons and episodes. |
|
|
A standalone text/article resource, not a playable video. |
|
|
A standalone playable video, not part of a series. |
Example
"episode"
ArticlesListedWithPagination
Description
A paginated list of Articles.
Fields
| Field Name | Description |
|---|---|
items - [ArticleListed]
|
The page of Articles. |
pagination - Pagination
|
Pagination info for this list. |
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 that owns the Asset |
source_blob_name - String
|
A descriptive name for the Asset's uploaded source file. |
thumbnail_asset_id - String
|
The Asset's identifier for its generated thumbnail image at the media provider. |
is_live - Boolean
|
Whether this Asset is being treated as live. Only meaningful for Assets of type "video" or "audio": a live_video-type Asset's live-ness is already implied by its type, independently of this flag. |
type - AssetTypeEnum
|
The Asset's media type. |
linked_type - ArticleAssetLinkedTypeEnum
|
The Asset's role within its Article (e.g. episode, film, preview, trailer). |
accessibility - ResourceAccessibilityEnum
|
The Asset's accessibility within its Article. |
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 Asset's duration (seconds) |
aspect_ratio - String
|
The Asset's human-readable aspect ratio (e.g. 16x9) |
aspect_ratio_fraction - String
|
The Asset's fractional aspect ratio (e.g. 1.778) |
subtitles - [File]
|
The Asset's subtitle Files |
Arguments
|
|
screenshots - [File]
|
The Asset's screenshot image Files |
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": false,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"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,
"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
Encoding profile name applied to an Asset after source upload.
Values
| Enum Value | Description |
|---|---|
|
|
Standard Definition, 540p, landscape (16:9). |
|
|
Standard Definition, 540p, portrait (9:16). |
|
|
High Definition, 1080p, landscape (16:9). |
|
|
High Definition, 1080p, portrait (9:16). |
|
|
4K Ultra HD, 2160p, landscape (16:9). |
|
|
Automatically selects the closest fixed profile (SD/HD/4K) based on the source video's own resolution. |
|
|
Builds a custom encoding ladder directly from the source video's own tracks, rather than a fixed SD/HD/4K profile. |
|
|
Audio-only encoding profile, for audio-type Assets. |
Example
"sd_540p_16x9"
AssetEncryptionProfileNameEnum
Description
Encryption profile name applied to an Asset after source upload.
Values
| Enum Value | Description |
|---|---|
|
|
No DRM/encryption. Encryption and DRM are not applied to the video streams. |
|
|
Hybrid DRM/ClearKey encryption. DRM (Widevine/PlayReady) is applied to DASH and MSS video streams, ClearKey encryption is applied to HLS video streams. |
|
|
Full DRM encryption. DRM (Widevine/PlayReady/Fairplay) is applied to DASH, MSS and HLS video streams. |
Example
"none"
AssetStatusEnum
Description
The Asset's lifecycle status.
Values
| Enum Value | Description |
|---|---|
|
|
Asset record created; encoding has not started yet. |
|
|
Media provider is encoding the source file. |
|
|
Encoding failed. |
|
|
Encoding finished successfully; thumbnail generation is next. |
|
|
Thumbnail generation in progress. |
|
|
Thumbnail generation failed. |
|
|
Thumbnails generated successfully; ready to be published. |
|
|
DRM/content-key policy configuration failed. No longer produced by current media-provider integrations, reserved for legacy/future use. |
|
|
Fully processed but not published; not yet playable. |
|
|
Publish requested and pending. |
|
|
Publish failed. |
|
|
Published and playable. |
|
|
Unpublish requested and pending. |
|
|
Unpublish failed. |
|
|
Republish requested while already published, e.g. after a settings or DRM change. |
|
|
Delete requested and pending. |
|
|
Delete failed. |
|
|
Permanently deleted. |
|
|
Source file upload in progress. |
|
|
Source file upload finished; awaiting preprocessing. |
|
|
Source file preprocessing/sanity checks in progress. |
|
|
Source file preprocessing failed. |
|
|
Source file upload failed. |
|
|
Publish in progress. |
|
|
Source file failed sanity validation. |
|
|
Content replacement requested and pending, via AssetContentReplace. |
|
|
Content replacement in progress. |
|
|
Content replacement failed. |
|
|
Live-video channel exists but is not currently running. |
|
|
Live-video channel created; not yet started. |
|
|
Live-video channel creation failed. |
|
|
Live-video channel is active and playable. |
|
|
Live-video channel start requested and pending. |
|
|
Live-video channel start in progress. |
|
|
Live-video channel failed to start. |
|
|
Live-video channel stop requested and pending. |
|
|
Live-video channel stop in progress. |
|
|
Live-video channel failed to stop. |
Example
"source_asset_created"
AssetTypeEnum
Description
The Asset's media type.
Values
| Enum Value | Description |
|---|---|
|
|
Audio-only Asset, with no video track. |
|
|
Test Asset backed by the mock media provider, not a real media pipeline. |
|
|
Regular on-demand video Asset. |
|
|
Live-video Asset backed by a live-streaming channel. |
Example
"audio"
AuthPage
Description
A reduced view of an authenticated-only or authorized-only Page, exposing only its routing/navigation fields (not its full content).
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Page. |
parent_id - Int
|
The id of the Page's parent Page. |
name - String
|
The Page's name. |
url_slug - String
|
The Page's url slug. |
Arguments
|
|
full_url_slug - String
|
The Page's full url slug. |
Arguments
|
|
canonical_url - String
|
The Page's canonical url. |
title - String
|
The Page's title. |
type - PageTypeEnum
|
The Page's type. |
visibility - ResourceVisibilityEnum
|
The Page's visibility. |
geo_region_code - String
|
The geo-region code this Page is restricted to (depending on the requesting User's environment). |
locale - String
|
The locale this Page is restricted to (depending on the requesting User's 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 |
is_terms_and_conditions_renewal_required - Boolean
|
Renewed acceptance of the terms and conditions is required |
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",
"is_terms_and_conditions_renewal_required": true
}
Boolean
Description
The Boolean scalar type represents true or false.
CategoriesListedWithPagination
Description
A paginated list of Categories.
Fields
| Field Name | Description |
|---|---|
items - [CategoryListed]
|
The page of Categories. |
pagination - Pagination
|
Pagination info for this list. |
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 that owns this Category. |
name - String
|
The Category's name. |
url_slug - String
|
The Category's url slug. |
Arguments
|
|
full_url_slug - String
|
The Category's full url slug. |
Arguments
|
|
canonical_url - String
|
The Category's canonical url. |
type - CategoryTypeEnum
|
The Category's type. |
metas - [CategoryMeta]
|
The Category's metadata properties. |
Arguments
|
|
articles - [ArticleListedAsRelation]
|
The Articles in this Category. |
Arguments
|
|
products - [ProductListedAsRelation]
|
The Products in this Category. |
Arguments
|
|
featured_articles - [ArticleFeatured]
|
The Articles featured in this Category. |
icons - [File]
|
The Category's icon Files. |
images - [File]
|
The Category's image Files. |
videos - [File]
|
The Category's video Files. |
parent_id - Int
|
The id of the Category's parent Category. |
child_metas - [String]
|
The metadata field names available on this Category's child Categories. |
created_at - String
|
The Category's creation date (UTC). |
updated_at - String
|
The Category's last modification date (UTC). |
posters - [File]
|
The Category's poster Files. |
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
A preconfigured Category list filter, used in place of an explicit type argument.
Values
| Enum Value | Description |
|---|---|
|
|
Limit to Categories that can have Articles explicitly tagged to them (type "article_label"). |
Example
"article_taggable"
CategoryListed
Description
A Category, as it appears within a list of Categories.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Category. |
project_id - Int!
|
The Project id that owns this Category. |
name - String
|
The Category's name. |
url_slug - String
|
The Category's url slug. |
Arguments
|
|
full_url_slug - String
|
The Category's full url slug. |
Arguments
|
|
canonical_url - String
|
The Category's canonical url. |
type - CategoryTypeEnum
|
The Category's type. |
metas - [CategoryMeta]
|
The Category's metadata properties. |
Arguments
|
|
articles - [ArticleListedAsRelation]
|
The Articles in this Category. |
Arguments
|
|
products - [ProductListedAsRelation]
|
The Products in this Category. |
Arguments
|
|
featured_articles - [ArticleFeatured]
|
The Articles featured in this Category. |
icons - [File]
|
The Category's icon Files. |
images - [File]
|
The Category's image Files. |
videos - [File]
|
The Category's video Files. |
parent_id - Int
|
The id of the Category's parent Category. |
child_metas - [String]
|
The metadata field names available on this Category's child Categories. |
created_at - String
|
The Category's creation date (UTC). |
updated_at - String
|
The Category's last modification date (UTC). |
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 Category, as it appears when listed as a related resource of another resource.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Category. |
project_id - Int!
|
The Project id that owns this Category. |
name - String
|
The Category's name. |
url_slug - String
|
The Category's url slug. |
Arguments
|
|
full_url_slug - String
|
The Category's full url slug. |
Arguments
|
|
canonical_url - String
|
The Category's canonical url. |
type - CategoryTypeEnum
|
The Category's type. |
metas - [CategoryMeta]
|
The Category's metadata properties. |
Arguments
|
|
icons - [File]
|
The Category's icon Files. |
images - [File]
|
The Category's image Files. |
videos - [File]
|
The Category's video Files. |
parent_id - Int
|
The id of the Category's parent Category. |
child_metas - [String]
|
The metadata field names available on this Category's child Categories. |
created_at - String
|
The Category's creation date (UTC). |
updated_at - String
|
The Category's last modification date (UTC). |
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 Category, as it appears within a generic resource listing.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
The Category's visibility. |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
CategoryMeta
Description
A metadata property on a Category.
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 Category id that owns this metadata property. |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42
}
CategoryMetaTranslation
Description
A single-locale translation of a CategoryMeta property.
Example
{
"id": 42,
"value": "string",
"locale": "string",
"category_meta_id": 42
}
CategoryTypeEnum
Description
The Category's type.
Values
| Enum Value | Description |
|---|---|
|
|
A regular, manually curated Category (its Articles/Products are explicitly assigned, not auto-populated). |
|
|
An auto-populated Category listing the most popular Articles. |
|
|
An auto-populated Category listing the most recently added Articles. |
|
|
An auto-populated Category listing Articles trending in recent popularity. |
|
|
An auto-populated Category listing Article recommendations based on the User's purchase history. |
Example
"article_label"
ClientPayload
Config
Description
User-facing Project configuration payload
Fields
| Field Name | Description |
|---|---|
environment - String
|
The API environment name |
version_tag_api - String
|
The AudiencePlayer API version tag |
locale - String
|
The activated locale |
geo_region_code - String
|
The activated GeoRegion code |
project_id - Int
|
The Project id |
is_authenticated - Boolean
|
Whether the request is authenticated as a User |
version_tag_mobile_ios - String
|
expected minimum version tag of a connected iOS app |
version_tag_mobile_android - String
|
expected minimum version tag of a connected Android app |
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 uses GeoRegion 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 settings |
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 visible Pages configured for this Project after platform, locale, and GeoRegion filtering |
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",
"version_tag_api": "string",
"locale": "string",
"geo_region_code": "nl",
"project_id": 42,
"is_authenticated": false,
"version_tag_mobile_ios": "string",
"version_tag_mobile_android": "string",
"has_subscriptions": true,
"has_auto_canonical_urls": false,
"has_credits": true,
"has_metric_action_fulfilment_notifications": false,
"has_subscription_payment_registration_integration": true,
"has_subscription_payment_pricing_before_registration": false,
"has_subscription_credit_integration": true,
"has_entitlements": false,
"has_geo_restrictions": true,
"has_article_favourites": false,
"has_article_ratings": true,
"has_article_nomadics": false,
"has_article_series_nomadics": true,
"has_article_entitlements": false,
"has_article_history": true,
"has_article_recommendations": false,
"has_article_offline_downloads": true,
"has_article_purchase_buttons": false,
"has_product_purchase_affiliation_categories": true,
"has_subscription_purchase_affiliation_categories": false,
"has_product_checkout_cart_in_menu": true,
"has_checkout_combined_login_registration": false,
"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
Description
Project website base URL slug
Example
{
"resource": "string",
"type": "string",
"value": "string"
}
ConfigPlatformEnvironment
Description
Platform-specific Project configuration
Fields
| Field Name | Description |
|---|---|
article_image_orientation - String
|
Project platform article image orientation ("landscape" or "portrait") |
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 |
player_settings - String
|
JSON-encoded preset of player settings |
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_regular_login - Boolean
|
Project platform allow regular (email/password) login |
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 redirect cache TTL |
default_seo_title - String
|
Project default SEO title |
default_seo_description - String
|
Project default SEO description |
default_seo_keywords - String
|
Project default SEO keywords |
default_seo_og_title - String
|
Project default Open Graph SEO title |
default_seo_og_description - String
|
Project default Open Graph SEO description |
Example
{
"article_image_orientation": "string",
"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,
"player_settings": "string",
"is_display_browser_not_supported_warning": false,
"is_display_carousel_bullets": true,
"is_display_carousel_metadata_inside_item": false,
"is_display_cookie_bar": true,
"is_display_cookie_bar_combined_consents": false,
"is_allow_account_registration": true,
"is_allow_regular_login": false,
"is_allow_subscription_currency_payments": true,
"is_allow_product_currency_payments": false,
"is_allow_product_credit_payments": true,
"is_support_player_video_seeking": false,
"is_support_player_time_indexation": true,
"is_support_player_playback_speed_change": false,
"is_support_player_locale_selection_storage": true,
"is_support_player_playback_skip_interval": false,
"is_display_article_carousel_zoom": true,
"is_display_article_episode_detail_page": false,
"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 Project's name. |
created_at - String
|
The Project's creation date-time (UTC). |
updated_at - String
|
The Project's last modification date-time (UTC). |
users - [CoreUser]
|
The Users related to this Project. |
managers - [CoreUser]
|
The manager Users related to this Project. |
status - Int
|
The Project's lifecycle status. |
status_label - String
|
The Project's lifecycle status label. |
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
A core User.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the User. |
project_id - Int
|
The Project id that owns the User. |
name - String
|
The User's name. |
display_name - String
|
The User's display name, typically the User's first name or first part of the e-mail address. |
email - String
|
The User's e-mail address. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
status - UserStatusEnum
|
The User's verification status. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
geo_region_code - String
|
The User's country code. |
phone - String
|
The User's phone number. |
is_phone_verified - UserPhoneStatusEnum
|
The User's phone number verification status. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the User has accepted the terms and conditions. |
is_marked_for_deletion - Boolean
|
Whether the User's account is marked for deletion. |
delete_at - String
|
The date (UTC) at which the User's account will be deleted, when is_marked_for_deletion is true. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for the User. |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the User's current UserSubscription, if any. |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The most recent event of importance generated for the User's current UserSubscription, if any. |
subscription_id - Int
|
The Subscription id the User's current UserSubscription is an instance of, if any. |
metas - [CoreUserMeta]
|
The User's meta properties. |
Arguments
|
|
managed_projects - [CoreProject]
|
The Projects the User manages. |
managed_roles - [Role]
|
The Roles the User is allowed to assign to other Users. |
recent_project - CoreProject
|
The Project the User most recently accessed. |
roles - [Role]
|
The User's 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": true,
"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": 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,
"metas": [CoreUserMeta],
"managed_projects": [CoreProject],
"managed_roles": [Role],
"recent_project": CoreProject,
"roles": [Role]
}
CoreUserMeta
Description
A core User meta property.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the meta property. |
user_id - Int
|
The User id that owns the meta property. |
key - String
|
The meta property's key. |
value - String
|
The meta property's value. |
translations - [UserMetaTranslation]
|
The meta property's value, translated per locale. |
type - MetaTypeEnum
|
The meta property's type. |
format - String
|
The meta property's 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
Device model context
Values
| Enum Value | Description |
|---|---|
|
|
Apple native platforms (iOS/tvOS/macOS applications). |
|
|
Legacy Chromecast devices (Cast OS, not Android-based). |
|
|
Chromecast with Google TV (4K), Android TV based. |
|
|
Legacy LG Smart TV platform (pre-webOS). |
|
|
LG webOS Smart TV platform. |
|
|
Samsung Tizen Smart TV platform. |
|
|
TP Vision (Philips) Smart TV platform. |
Example
"apple_native"
DevicePairingCode
Description
A Device pairing code
Example
{
"pairing_code": "string",
"uuid": "string",
"name": "string",
"expires_in": 86400
}
DeviceTypeEnum
Description
Device type
Values
| Enum Value | Description |
|---|---|
|
|
Unknown or unclassified Device type. |
|
|
Google Chrome web browser Device. |
|
|
Microsoft Edge web browser Device. |
|
|
Apple Safari web browser Device. |
|
|
Android mobile application Device. |
|
|
iOS mobile application Device. |
|
|
Generic managed application framework Device. |
|
|
Horizon managed application framework Device. |
|
|
KPN managed application framework Device. |
|
|
Delta managed application framework Device. |
|
|
Caiway managed application framework Device. |
|
|
Telfort managed application framework Device. |
|
|
XS4ALL managed application framework Device. |
|
|
Samsung Orsay TV Device. |
|
|
Samsung Tizen TV Device. |
|
|
LG webOS TV Device. |
|
|
TP Vision TV Device. |
|
|
AirPlay playback Device. |
|
|
Chromecast playback Device. |
|
|
Apple TV Device. |
|
|
Android TV Device. |
Example
"unknown"
DevicesListedWithPagination
Description
Devices with pagination
Fields
| Field Name | Description |
|---|---|
items - [DeviceListed]
|
Devices for the current page. |
pagination - Pagination
|
Pagination metadata for the Device list. |
Example
{
"items": [DeviceListed],
"pagination": Pagination
}
File
Description
A File
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the File |
name - String
|
The File's original name |
title - String
|
The File's display title or generated title fallback |
type - FileTypeEnum
|
The File's type |
size - Int
|
The File's size in bytes |
width - Int
|
The File's width in pixels |
height - Int
|
The File's height in pixels |
aspect_ratio_profile - String
|
The File's calculated aspect-ratio profile |
duration - Int
|
The File's duration in seconds, where applicable |
locale - String
|
The File's language locale code |
locale_label - String
|
The File's language locale label |
base_url - String
|
The File's base URL |
base_path - String
|
The File's base URL path |
url - String
|
The File's public URL |
proxy_file_path - String
|
The File's proxy path |
proxy_url - String
|
The File's proxy URL |
file_name - String
|
The File's storage file name |
file_path - String
|
The File's storage path |
Example
{
"id": 42,
"name": "string",
"title": "string",
"type": "audio",
"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
Subtitle file format
Values
| Enum Value | Description |
|---|---|
|
|
WebVTT subtitle format. |
|
|
SubRip subtitle format. |
|
|
Timed Text Markup Language subtitle format. |
Example
"vtt"
FileTypeEnum
Description
Secondary file type assigned to an uploaded File, such as image, icon, poster, document, subtitle, video, or audio.
Values
| Enum Value | Description |
|---|---|
|
|
An audio File, usually used for localized audio tracks or other audio-only attachments. |
|
|
A generic binary File without stricter type-specific extension validation. |
|
|
A CSS stylesheet File. |
|
|
A document File, such as a PDF, DOCX, spreadsheet, text, archive, or downloadable audio document. |
|
|
An icon File, typically uploaded as a small graphic or favicon-style image. |
|
|
A general image File. |
|
|
A poster image File. |
|
|
A screenshot image File, often attached to Assets. |
|
|
A subtitle File in VTT, SRT, or TTML format. |
|
|
A video File. |
Example
"audio"
FilterByInput
Description
A filter input
Fields
| Input Field | Description |
|---|---|
field - String
|
The field to filter by. |
logic_operator - LogicOperatorEnum
|
The comparison operator to apply. |
value - String
|
The value to compare against. |
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
123.45
Gender
GeoRegion
GeoRegionListed
GeoRegionsListedWithPagination
Description
A paginated list of GeoRegions.
Fields
| Field Name | Description |
|---|---|
items - [GeoRegionListed]
|
The GeoRegions in this page. |
pagination - Pagination
|
Pagination metadata for the GeoRegion list. |
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
A translatable LanguageTag exposed to front-end clients.
Fields
| Field Name | Description |
|---|---|
key - String
|
The LanguageTag key. |
value - String
|
The LanguageTag value in the active locale. |
format - MetaFormatEnum
|
The rendering format to use for the LanguageTag value. |
id - Int!
|
The id of the LanguageTag. |
project_id - Int!
|
The Project id that owns the LanguageTag. |
platform_context - String
|
The platform context the LanguageTag belongs to. |
Example
{
"key": "string",
"value": "string",
"format": "date",
"id": 42,
"project_id": 42,
"platform_context": "string"
}
LocaleRegion
LogicOperatorEnum
Description
Logic comparison operator
Values
| Enum Value | Description |
|---|---|
|
|
Equals comparison. |
|
|
Not-equals comparison. |
|
|
Greater-than comparison. |
|
|
Greater-than-or-equal comparison. |
|
|
Less-than comparison. |
|
|
Less-than-or-equal comparison. |
Example
"equals"
Menu
Description
A Menu is a presentation resource that configures navigation in a frontend app through configurable controls.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Menu. |
project_id - Int!
|
The Project id that owns this Menu. |
name - String
|
The Menu's name. |
platform_contexts - [String]
|
The platform contexts the Menu is available on. |
locale_regions - [LocaleRegion]
|
The LocaleRegions this Menu belongs to. |
geo_regions - [GeoRegion]
|
The GeoRegions this Menu belongs to. |
components - [MenuComponent]
|
The Menu's MenuComponents. |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [MenuComponent]
}
MenuComponent
Description
A MenuComponent is a presentation resource that configures one navigation control in a frontend app.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the MenuComponent. |
parent_id - Int
|
The id of the MenuComponent's parent MenuComponent. |
menu_id - Int!
|
The Menu id that owns this MenuComponent. |
page_id - Int
|
The id of the Page this MenuComponent links to. |
page_full_url_slug - String
|
The full url slug of the Page this MenuComponent links to. |
type - MenuComponentTypeEnum
|
The MenuComponent's type. |
title - String
|
The MenuComponent's title. |
content - String
|
The MenuComponent's content. |
Arguments
|
|
url - String
|
The MenuComponent's url. |
icons - [File]
|
The MenuComponent's icon Files. |
images - [File]
|
The MenuComponent's image Files. |
posters - [File]
|
The MenuComponent's poster Files. |
videos - [File]
|
The MenuComponent's video Files. |
files - [File]
|
The MenuComponent's 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 navigation-control role a MenuComponent fulfils in a frontend app.
Values
| Enum Value | Description |
|---|---|
|
|
A button that opens a relative or absolute url. |
|
|
A button that exits the app (typically used on TV apps). |
|
|
A container for a set of footer links. |
|
|
A single link within a footer container. |
|
|
A generic navigational link. |
|
|
A locale-switcher control. |
|
|
A button that opens the login flow. Only shown when the User is not logged in. |
|
|
A button that logs the User out. Only shown when the User is logged in. |
|
|
A link to a specific Page (see "page_id"/"page_full_url_slug"). |
|
|
A Chromecast casting control. |
|
|
A search control. |
|
|
Displays the authenticated User's available credit balance. |
Example
"button_url_link"
MetaFormatEnum
Description
Metadata value format
Values
| Enum Value | Description |
|---|---|
|
|
Date metadata format. |
|
|
Date-time metadata format. |
|
|
Floating-point metadata format. |
|
|
Integer metadata format. |
|
|
String metadata format. |
|
|
Rich-text metadata format. |
|
|
Plain-text metadata format. |
Example
"date"
MetaOutputTypeEnum
Description
Metadata output format
Values
| Enum Value | Description |
|---|---|
|
|
Return metadata as HTML. |
|
|
Return metadata as Markdown. |
|
|
Return metadata as plain text stripped from HTML. |
Example
"html"
MetaTypeEnum
Description
Metadata value type
Values
| Enum Value | Description |
|---|---|
|
|
Array metadata value. |
|
|
Boolean metadata value. |
|
|
Floating-point metadata value. |
|
|
Integer metadata value. |
|
|
Object metadata value. |
|
|
String metadata value. |
Example
"array"
MetricAction
Description
A MetricAction.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the MetricAction. |
project_id - Int!
|
The Project id that owns this MetricAction. |
name - String
|
The MetricAction's name. |
title - String
|
The MetricAction's title. |
content - String
|
The MetricAction's content. |
icons - [File]
|
The MetricAction's icon Files. |
images - [File]
|
The MetricAction's image Files. |
files - [File]
|
The MetricAction's Files. |
Arguments
|
|
fulfilled_at - String
|
The User fulfillment date (UTC) of the MetricAction. |
acknowledged_at - String
|
The User acknowledgement date (UTC) of the MetricAction. |
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 MetricAction's publication status.
Values
| Enum Value | Description |
|---|---|
|
|
Inactive MetricAction. It is not fulfilled for Users. |
|
|
Active MetricAction. It may be fulfilled for eligible Users when its Metrics match. |
Example
"inactive"
MetricActionTypeEnum
Description
The MetricAction's type.
Values
| Enum Value | Description |
|---|---|
|
|
Entitles eligible Users to the configured Products and/or Subscription installments when fulfilled. |
Example
"user_entitlement"
MetricConditionTypeEnum
Description
The MetricCondition's type, the resource property it evaluates.
Values
| Enum Value | Description |
|---|---|
|
|
Article play percentage amount, evaluated as a numeric threshold. |
|
|
Article play percentage ratio, evaluated as a numeric threshold. |
|
|
Article linked-Asset type, evaluated against Asset linked-type values such as episode, film, preview, or trailer. |
|
|
Number of completed Article sessions, evaluated as a numeric threshold. |
|
|
Product type, evaluated against Product type values. |
|
|
Number of purchases, evaluated as a numeric threshold. |
|
|
Purchase origin, evaluated against UserPaymentAccountOrder purchase-origin values. |
|
|
Subscription retention duration in days, evaluated as a numeric threshold. |
|
|
Subscription type, evaluated against Subscription type values. |
|
|
Telemetry platform, evaluated against telemetry platform values. |
|
|
Subscription term number, evaluated as a numeric threshold. |
Example
"appa"
MetricStatusEnum
Description
The Metric's publication status.
Values
| Enum Value | Description |
|---|---|
|
|
Inactive Metric. It is not evaluated for Users. |
|
|
Active Metric. It may be evaluated for matching Users. |
Example
"inactive"
MetricTypeEnum
Description
The Metric's type.
Values
| Enum Value | Description |
|---|---|
|
|
Evaluates Users by Article viewing behaviour. |
|
|
Evaluates Users by Product purchase or entitlement behaviour. |
|
|
Evaluates Users by Subscription purchase behaviour and periodic Subscription activity. |
Example
"article"
NotificationDeliveryTypeEnum
Description
Notification delivery audience strategies.
Values
| Enum Value | Description |
|---|---|
|
|
Send a generic Notification to Users subscribed to the linked NotificationTopics. |
|
|
Send a personalized Notification to Users subscribed to the linked NotificationTopics. |
|
|
Send the Notification to all Users in the Project. |
Example
"generic_users_on_topic"
NotificationTopic
Description
A NotificationTopic.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the NotificationTopic. |
remote_notification_topic_id - String
|
The remote id of the NotificationTopic used by push-notification providers. |
project_id - Int!
|
The Project id that owns the NotificationTopic. |
name - String
|
The NotificationTopic's internal name. |
title - String
|
The NotificationTopic's localized title. |
description - String
|
The NotificationTopic's localized description. |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string"
}
NotificationTopicTypeEnum
Description
NotificationTopic content types.
Values
| Enum Value | Description |
|---|---|
|
|
A general NotificationTopic that Users can subscribe to. |
Example
"general"
NotificationTopicsListedWithPagination
Description
NotificationTopics with pagination.
Fields
| Field Name | Description |
|---|---|
items - [NotificationTopic]
|
The NotificationTopics on this page. |
pagination - Pagination
|
Pagination metadata for the NotificationTopic result set. |
Example
{
"items": [NotificationTopic],
"pagination": Pagination
}
NotificationTypeEnum
Description
Notification lifecycle and behavior types.
Values
| Enum Value | Description |
|---|---|
|
|
A one-time Notification scheduled or sent once. |
|
|
A recurring Notification sent periodically by frequency and time unit. |
|
|
A recurring inactivity reminder Notification that can choose related Notifications or Categories based on User viewing activity. |
|
|
A child Notification used as related content for an inactivity reminder Notification. |
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 that owns the OAuth2 provider. |
call_to_action_tag - String
|
The OAuth2 provider's call-to-action label. |
init_url - String
|
The URL used to start an OAuth2 authentication flow with this OAuth2 provider. |
call_to_action_icon_url - String
|
The icon URL displayed near the call-to-action label 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
A paginated list of OAuth2 providers.
Fields
| Field Name | Description |
|---|---|
items - [OauthProviderListed]
|
The OAuth2 providers on this page. |
pagination - Pagination
|
The pagination metadata for the OAuth2 provider list. |
Example
{
"items": [OauthProviderListed],
"pagination": Pagination
}
OperatorContextEnum
Description
Operator context
Values
| Enum Value | Description |
|---|---|
|
|
Android operator context. |
|
|
Horizon operator context. |
|
|
iOS operator context. |
|
|
KPN operator context. |
|
|
Web operator context. |
|
|
Ziggo operator context. |
|
|
Delta operator context. |
|
|
Caiway operator context. |
|
|
XS4ALL operator context. |
Example
"android"
Page
Description
A Page is a presentation resource that provides a frontend app's layout and routing.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Page. |
project_id - Int!
|
The Project id that owns this Page. |
category_id - Int
|
The id of the Category this Page is dedicated to (e.g. a category landing page). |
parent_id - Int
|
The id of the Page's parent Page. |
name - String
|
The Page's name. |
url_slug - String
|
The Page's url slug. |
Arguments
|
|
full_url_slug - String
|
The Page's full url slug. |
Arguments
|
|
canonical_url - String
|
The Page's canonical url. |
title - String
|
The Page's title. |
type - PageTypeEnum
|
The Page's type. |
is_in_sitemap - Boolean
|
Whether the Page is listed in the general sitemap. |
platform_contexts - [String]
|
The platform contexts the Page is available on. |
locale_regions - [LocaleRegion]
|
The LocaleRegions this Page belongs to. |
geo_regions - [GeoRegion]
|
The GeoRegions this Page belongs to. |
metas - [PageMeta]
|
The Page's metadata properties. |
Arguments
|
|
components - [PageComponent]
|
The Page's PageComponents. |
Arguments
|
|
icons - [File]
|
The Page's icon Files. |
images - [File]
|
The Page's image Files. |
posters - [File]
|
The Page's poster Files. |
videos - [File]
|
The Page's video Files. |
documents - [File]
|
The Page's document Files. |
files - [File]
|
The Page's Files. |
Arguments
|
|
geo_region_code - String
|
The geo-region code this Page is restricted to (depending on the requesting User's environment). |
locale - String
|
The locale this Page is restricted to (depending on the requesting User's 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 PageComponent is a presentation resource that contributes a typed section to a Page's layout.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PageComponent. |
page_id - Int!
|
The Page id that owns this PageComponent. |
parent_id - Int
|
The id of the PageComponent's parent PageComponent. |
category_id - Int
|
The id of the Category this PageComponent is dedicated to. Deprecated, use resource_categories instead. Deprecated in favour of resource_categories |
title - String
|
The PageComponent's title. |
content - String
|
The PageComponent's content. |
url - String
|
The PageComponent's url. |
value - String
|
The PageComponent's value. |
style_type - String
|
The PageComponent's style type. |
display_type - String
|
The PageComponent's display type. |
type - PageComponentTypeEnum
|
The PageComponent's type. |
elements - [PageComponentElement]
|
The PageComponent's PageComponentElements. |
Arguments
|
|
icons - [File]
|
The PageComponent's icon Files. |
images - [File]
|
The PageComponent's image Files. |
posters - [File]
|
The PageComponent's poster Files. |
videos - [File]
|
The PageComponent's video Files. |
documents - [File]
|
The PageComponent's document Files. |
files - [File]
|
The PageComponent's Files. |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
The Articles this PageComponent references. |
resource_categories - [CategoryListedAsResource]
|
The Categories this PageComponent references. |
resource_pages - [PageListedAsResource]
|
The Pages this PageComponent references. |
resource_products - [ProductListedAsResource]
|
The Products this PageComponent references. |
resource_subscriptions - [SubscriptionListedAsResource]
|
The Subscriptions this PageComponent references. |
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 PageComponentElement is a presentation resource that configures one renderable part of a PageComponent.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PageComponentElement. |
page_component_id - Int!
|
The PageComponent id that owns this PageComponentElement. |
parent_id - Int
|
The id of the PageComponentElement's parent PageComponentElement. |
type - String
|
The PageComponentElement's type. |
title - String
|
The PageComponentElement's title. |
content - String
|
The PageComponentElement's content. |
label - String
|
The PageComponentElement's label. |
url - String
|
The PageComponentElement's url. |
value - String
|
The PageComponentElement's value. |
toggle - Boolean
|
The PageComponentElement's toggle value. |
icons - [File]
|
The PageComponentElement's icon Files. |
images - [File]
|
The PageComponentElement's image Files. |
posters - [File]
|
The PageComponentElement's poster Files. |
videos - [File]
|
The PageComponentElement's video Files. |
documents - [File]
|
The PageComponentElement's document Files. |
files - [File]
|
The PageComponentElement's Files. |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
The Articles this PageComponentElement references. |
resource_categories - [CategoryListedAsResource]
|
The Categories this PageComponentElement references. |
resource_pages - [PageListedAsResource]
|
The Pages this PageComponentElement references. |
resource_products - [ProductListedAsResource]
|
The Products this PageComponentElement references. |
resource_subscriptions - [SubscriptionListedAsResource]
|
The Subscriptions this PageComponentElement references. |
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": false,
"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 presentation role a PageComponent fulfils in a Page layout.
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. AudiencePlayer is not responsible for included content that is broken, malicious, or otherwise misbehaves when using this component. |
|
|
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 loyalty 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 Page, as it appears within a list of Pages.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Page. |
project_id - Int!
|
The Project id that owns this Page. |
category_id - Int
|
The id of the Category this Page is dedicated to (e.g. a category landing page). |
parent_id - Int
|
The id of the Page's parent Page. |
name - String
|
The Page's name. |
url_slug - String
|
The Page's url slug. |
Arguments
|
|
full_url_slug - String
|
The Page's full url slug. |
Arguments
|
|
canonical_url - String
|
The Page's canonical url. |
title - String
|
The Page's title. |
type - PageTypeEnum
|
The Page's type. |
is_in_sitemap - Boolean
|
Whether the Page is listed in the general sitemap. |
platform_contexts - [String]
|
The platform contexts the Page is available on. |
locale_regions - [LocaleRegion]
|
The LocaleRegions this Page belongs to. |
geo_regions - [GeoRegion]
|
The GeoRegions this Page belongs to. |
metas - [PageMeta]
|
The Page's metadata properties. |
Arguments
|
|
components - [PageComponent]
|
The Page's PageComponents. |
Arguments
|
|
icons - [File]
|
The Page's icon Files. |
images - [File]
|
The Page's image Files. |
posters - [File]
|
The Page's poster Files. |
videos - [File]
|
The Page's video Files. |
documents - [File]
|
The Page's document Files. |
files - [File]
|
The Page's 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 Page, as it appears within a generic resource listing.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
The Page's visibility. |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
PageMeta
Description
A metadata property on a Page.
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 |
page_id - Int
|
The Page id that owns this metadata property. |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"page_id": 42
}
PageTypeEnum
Description
The presentation role a Page fulfils in a frontend app.
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
A paginated list of Pages.
Fields
| Field Name | Description |
|---|---|
items - [PageListed]
|
The page of Pages. |
pagination - Pagination
|
Pagination info for this list. |
Example
{
"items": [PageListed],
"pagination": Pagination
}
Pagination
Description
List pagination
Fields
| Field Name | Description |
|---|---|
limit - Int
|
The requested page size. |
offset - Int
|
The requested result offset. |
count - Int
|
The number of items returned in the current page. |
total_count - Int
|
The total number of matching items. |
page_count - Int
|
The total number of pages. |
page_current - Int
|
The current page number. |
Example
{
"limit": 42,
"offset": 42,
"count": 42,
"total_count": 42,
"page_count": 42,
"page_current": 42
}
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 - SubscriptionListed
|
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": SubscriptionListed,
"scoped_products": [ProductListed],
"products": [ProductListed],
"affiliation_categories": [CategoryListed]
}
PaymentMethodEnum
Description
Payment method
Values
| Enum Value | Description |
|---|---|
|
|
ACSS Direct Debit payment method. |
|
|
Afterpay payment method. |
|
|
Alipay payment method. |
|
|
BECS Direct Debit payment method. |
|
|
Bacs Direct Debit payment method. |
|
|
Bancontact payment method. |
|
|
Bank transfer payment method. |
|
|
Belfius payment method. |
|
|
Boleto payment method. |
|
|
Credit card payment method. |
|
|
EPS payment method. |
|
|
FPX payment method. |
|
|
Gift card payment method. |
|
|
Giropay payment method. |
|
|
GrabPay payment method. |
|
|
iDEAL payment method. |
|
|
Interac payment method. |
|
|
KBC/CBC payment method. |
|
|
Klarna payment method. |
|
|
MyBank payment method. |
|
|
OXXO payment method. |
|
|
P24 payment method. |
|
|
PayPal payment method. |
|
|
Paysafecard payment method. |
|
|
Przelewy24 payment method. |
|
|
SEPA Direct Debit payment method. |
|
|
SOFORT payment method. |
|
|
WeChat Pay payment method. |
Example
"acss"
PaymentMethodIdealIssuerEnum
Description
iDEAL payment-method issuer
Values
| Enum Value | Description |
|---|---|
|
|
ABN AMRO iDEAL issuer. |
|
|
ASN Bank iDEAL issuer. |
|
|
bunq iDEAL issuer. |
|
|
Handelsbanken iDEAL issuer. |
|
|
ING iDEAL issuer. |
|
|
Knab iDEAL issuer. |
|
|
Rabobank iDEAL issuer. |
|
|
RegioBank iDEAL issuer. |
|
|
Revolut iDEAL issuer. |
|
|
SNS Bank iDEAL issuer. |
|
|
Triodos Bank iDEAL issuer. |
|
|
Van Lanschot iDEAL issuer. |
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) Abandoned in favour of centralised selection as of 2025-03-31, please see: https://ideal.nl/en/laatste-stap-in-ideal-migratie |
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
KBC/CBC payment-method issuer
Values
| Enum Value | Description |
|---|---|
|
|
KBC payment-method issuer. |
|
|
CBC payment-method issuer. |
Example
"kbc"
PaymentMethodKlarnaTypeEnum
Description
Klarna checkout type
Values
| Enum Value | Description |
|---|---|
|
|
Klarna Pay Now checkout type. |
|
|
Klarna Pay Later checkout type. |
|
|
Klarna Slice It checkout type. |
Example
"paynow"
PaymentProviderCurrencyEnum
Description
The currency used for payment with the PaymentProvider.
Values
| Enum Value | Description |
|---|---|
|
|
General credit balance. |
|
|
Free-article credit balance. |
|
|
Australian dollar. |
|
|
Canadian dollar. |
|
|
Danish krone. |
|
|
Euro. |
|
|
British pound sterling. |
|
|
Hong Kong dollar. |
|
|
Indian rupee. |
|
|
Icelandic krona. |
|
|
Japanese yen. |
|
|
Malaysian ringgit. |
|
|
Norwegian krone. |
|
|
Swedish krona. |
|
|
Singapore dollar. |
|
|
Thai baht. |
|
|
United States dollar. |
Example
"CREDIT"
PaymentProviderListed
Description
A listed PaymentProvider.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PaymentProvider. |
project_id - Int!
|
The Project id that owns the PaymentProvider. |
name - String
|
The PaymentProvider's name. |
description - String
|
The PaymentProvider's description. |
type - String
|
The PaymentProvider's provider type. |
status - PaymentProviderStatusEnum
|
The PaymentProvider's status. |
device_capability - Int
|
The PaymentProvider's device payment capability flags. |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42
}
PaymentProviderListedAsRelation
PaymentProviderStatusEnum
Description
The PaymentProvider status.
Values
| Enum Value | Description |
|---|---|
|
|
Payment provider is active for compatible payment flows. |
|
|
Payment provider is configured but inactive. |
Example
"active"
PaymentProvidersListedWithPagination
Description
A paginated list of PaymentProviders.
Fields
| Field Name | Description |
|---|---|
items - [PaymentProviderListed]
|
The PaymentProviders on this page. |
pagination - Pagination
|
The pagination metadata for the PaymentProvider list. |
Example
{
"items": [PaymentProviderListed],
"pagination": Pagination
}
PaymentSyndicateTypeEnum
Description
The PaymentSyndicate's type.
Values
| Enum Value | Description |
|---|---|
|
|
A PaymentSyndicate managed internally by the Project. |
|
|
A PaymentSyndicate representing a third-party affiliate. |
Example
"internal"
PaymentSyndicateVoucherDiscountTypeEnum
Description
How a PaymentSyndicateVoucher's amount is applied to the resource price.
Values
| Enum Value | Description |
|---|---|
|
|
Apply a percentage discount (0-100) equal to amount (e.g. amount 10 gives "price * (1 - 10 / 100)"). |
|
|
Replace the resource price with amount (e.g. "price = amount"). |
|
|
Subtract amount from the resource price (e.g. "price = price - amount"). |
|
|
Same as gift_card, but any remaining negative amount is written to the User's account balance instead of being lost. |
Example
"percentage"
PaymentSyndicateVoucherInstallmentTypeEnum
Description
A PaymentSyndicateVoucher's installment type.
Values
| Enum Value | Description |
|---|---|
|
|
Issue installments periodically until issue_installments_until. |
|
|
Issue a single, one-off installment. |
Example
"fixed_date"
PaymentSyndicateVoucherListed
Description
A PaymentSyndicateVoucher, as part of a list.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the PaymentSyndicateVoucher. |
project_id - Int!
|
The Project id that owns the PaymentSyndicateVoucher. |
description - String
|
The PaymentSyndicateVoucher's description. |
scoped_products - [ProductListed]
|
The Products this PaymentSyndicateVoucher may be applied to. Empty means no restriction. |
scoped_subscriptions - [SubscriptionListed]
|
The Subscriptions this PaymentSyndicateVoucher may be applied to. Empty means no restriction. |
Example
{
"id": 42,
"project_id": 42,
"description": "string",
"scoped_products": [ProductListed],
"scoped_subscriptions": [SubscriptionListed]
}
PaymentSyndicateVoucherTypeEnum
Description
The resource type a PaymentSyndicateVoucher is applicable to.
Values
| Enum Value | Description |
|---|---|
|
|
Applicable to all resource types. |
|
|
Applicable to Products (TVOD). |
|
|
Applicable to Subscriptions (SVOD). |
Example
"generic"
PlatformContextEnum
Description
Platform context
Values
| Enum Value | Description |
|---|---|
|
|
Web platform context. |
|
|
Mobile platform context. |
|
|
TV platform context. |
|
|
Metrological platform context. |
Example
"web"
Product
Description
A Product.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Product. |
project_id - Int!
|
The Project id that owns the Product. |
remote_product_id - String
|
The Product's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Product's name. |
title - String
|
The Product's title. |
description - String
|
The Product's description. |
Arguments
|
|
description_short - String
|
The Product's short description. |
Arguments
|
|
call_to_action_tag - String
|
The Product's call-to-action tag. |
type - ProductTypeEnum
|
The Product's type. |
credit_type - UserPaymentCreditTypeEnum
|
The type of credit this Product issues, when type is "credit" or "service_recurring_credit". |
currency - String
|
The Product's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Product's currency symbol (e.g. "€"). |
price - Float
|
The Product's price. |
credit_price - Float
|
The Product's price expressed in credits, as an alternative to price. |
credit_amount - Float
|
The quantity of credits this Product issues. |
amount_balance - Float
|
The monetary account balance amount this Product issues, when type is "amount_balance". |
purchase_num - Int
|
The number of times this Product has been purchased, in the context this Product is being resolved in (e.g. as part of a UserSubscription). |
max_purchase_num - Int
|
The maximum number of times a User may purchase this Product. |
expires_in - Int
|
The number of hours after purchase until entitlement from this Product expires (a "rental" window). |
expires_at - String
|
The fixed date (UTC) until which entitlement from this Product expires. |
created_at - String
|
The Product's creation date (UTC). |
updated_at - String
|
The Product's last modification date (UTC). |
icons - [File]
|
The Product's icon Files. |
images - [File]
|
The Product's image Files. |
posters - [File]
|
The Product's poster Files. |
videos - [File]
|
The Product's video Files. |
articles - [ArticleListedAsRelation]
|
The Articles this Product entitles the User to, when type is "article" or "free_article". |
categories - [CategoryListedAsRelation]
|
The Categories the Product 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]
}
ProductDiscoverabilityEnum
Description
How discoverable the Product is to Users.
Values
| Enum Value | Description |
|---|---|
|
|
Hidden from all listing/browse/search surfaces, but still directly reachable by id or direct link. |
|
|
Discoverable through listing/browse/search surfaces. |
Example
"hidden"
ProductListed
Description
A Product, as part of a list.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Product. |
project_id - Int!
|
The Project id that owns the Product. |
remote_product_id - String
|
The Product's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Product's name. |
title - String
|
The Product's title. |
description - String
|
The Product's description. |
Arguments
|
|
description_short - String
|
The Product's short description. |
Arguments
|
|
call_to_action_tag - String
|
The Product's call-to-action tag. |
type - ProductTypeEnum
|
The Product's type. |
credit_type - UserPaymentCreditTypeEnum
|
The type of credit this Product issues, when type is "credit" or "service_recurring_credit". |
currency - String
|
The Product's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Product's currency symbol (e.g. "€"). |
price - Float
|
The Product's price. |
credit_price - Float
|
The Product's price expressed in credits, as an alternative to price. |
credit_amount - Float
|
The quantity of credits this Product issues. |
amount_balance - Float
|
The monetary account balance amount this Product issues, when type is "amount_balance". |
purchase_num - Int
|
The number of times this Product has been purchased, in the context this Product is being resolved in (e.g. as part of a UserSubscription). |
max_purchase_num - Int
|
The maximum number of times a User may purchase this Product. |
expires_in - Int
|
The number of hours after purchase until entitlement from this Product expires (a "rental" window). |
expires_at - String
|
The fixed date (UTC) until which entitlement from this Product expires. |
created_at - String
|
The Product's creation date (UTC). |
updated_at - String
|
The Product's last modification date (UTC). |
icons - [File]
|
The Product's icon Files. |
images - [File]
|
The Product's image Files. |
posters - [File]
|
The Product's poster Files. |
videos - [File]
|
The Product's video Files. |
articles - [ArticleListedAsRelation]
|
The Articles this Product entitles the User to, when type is "article" or "free_article". |
categories - [CategoryListedAsRelation]
|
The Categories the Product 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 Product, as a relation on another resource.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Product. |
project_id - Int!
|
The Project id that owns the Product. |
remote_product_id - String
|
The Product's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Product's name. |
title - String
|
The Product's title. |
description - String
|
The Product's description. |
Arguments
|
|
description_short - String
|
The Product's short description. |
Arguments
|
|
call_to_action_tag - String
|
The Product's call-to-action tag. |
type - ProductTypeEnum
|
The Product's type. |
credit_type - UserPaymentCreditTypeEnum
|
The type of credit this Product issues, when type is "credit" or "service_recurring_credit". |
currency - String
|
The Product's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Product's currency symbol (e.g. "€"). |
price - Float
|
The Product's price. |
credit_price - Float
|
The Product's price expressed in credits, as an alternative to price. |
credit_amount - Float
|
The quantity of credits this Product issues. |
amount_balance - Float
|
The monetary account balance amount this Product issues, when type is "amount_balance". |
purchase_num - Int
|
The number of times this Product has been purchased, in the context this Product is being resolved in (e.g. as part of a UserSubscription). |
max_purchase_num - Int
|
The maximum number of times a User may purchase this Product. |
expires_in - Int
|
The number of hours after purchase until entitlement from this Product expires (a "rental" window). |
expires_at - String
|
The fixed date (UTC) until which entitlement from this Product expires. |
created_at - String
|
The Product's creation date (UTC). |
updated_at - String
|
The Product's last modification date (UTC). |
icons - [File]
|
The Product's icon Files. |
images - [File]
|
The Product's image Files. |
posters - [File]
|
The Product's poster Files. |
videos - [File]
|
The Product's video Files. |
articles - [ArticleListedAsRelation]
|
The Articles this Product entitles the User to, when type is "article" or "free_article". |
categories - [CategoryListedAsRelation]
|
The Categories the Product 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]
}
ProductListedAsResource
ProductStackInput
Description
A Product and its purchase quantity, as part of a stack of Products.
Example
{"id": 42, "purchase_num": 42, "product_price": 987.65}
ProductStatusEnum
Description
The Product's publication status.
Values
| Enum Value | Description |
|---|---|
|
|
The Product is not published and cannot be purchased. |
|
|
The Product is published and can be purchased, subject to its publish_interval. |
Example
"unpublished"
ProductTypeEnum
Description
The Product's type.
Values
| Enum Value | Description |
|---|---|
|
|
Entitles the User to the linked Articles upon purchase. |
|
|
Entitles the User to the linked Articles at no cost. |
|
|
A generic, non-recurring Product with no built-in entitlement beyond its own purchase. |
|
|
Issues a one-off amount of credits of a given credit_type to the User. |
|
|
A generic, non-recurring Product with no built-in entitlement beyond its own purchase. |
|
|
Issues a PaymentSyndicateVoucher Code from the linked PaymentSyndicateVoucher upon purchase. |
|
|
Issues a monetary account balance top-up (e.g. a gift card) to the User. |
|
|
Recurring; only applicable in combination with a Subscription. Adjusts the price of each recurring Subscription installment by a fixed amount (negative for a discount, positive for a surcharge). |
|
|
Recurring; only applicable in combination with a Subscription. Issues a quantity of credits alongside each recurring Subscription installment. |
|
|
Recurring; only applicable in combination with a Subscription. Entitles the User to receive SMS text notifications, when configured for the Project. |
Example
"article"
ProductsListedWithPagination
Description
A paginated list of Products.
Fields
| Field Name | Description |
|---|---|
items - [ProductListed]
|
The Products. |
pagination - Pagination
|
The pagination details for this list. |
Example
{
"items": [ProductListed],
"pagination": Pagination
}
ResourceAccessibilityEnum
Description
Resource accessibility type
Values
| Enum Value | Description |
|---|---|
|
|
Accessible to everyone. |
|
|
Accessible only to unauthenticated visitors. |
|
|
Accessible only to authenticated Users. |
|
|
Accessible only to authenticated Users with authorization for the resource. |
Example
"everyone"
ResourceEntitlementActionEnum
Description
Resource entitlement action
Values
| Enum Value | Description |
|---|---|
|
|
Fulfil entitlement for the resource. |
|
|
Revoke entitlement for the resource. |
Example
"fulfil"
ResourceTypeEnum
Description
Resource type
Values
| Enum Value | Description |
|---|---|
|
|
Article resource. |
|
|
Asset resource. |
|
|
Category resource. |
|
|
Metric resource. |
|
|
MetricAction resource. |
|
|
Page resource. |
|
|
PageComponent resource. |
|
|
PageComponentElement resource. |
|
|
PaymentSyndicateVoucher resource. |
|
|
Product resource. |
|
|
Subscription resource. |
Example
"article"
ResourceVisibilityEnum
Description
Resource visibility type
Values
| Enum Value | Description |
|---|---|
|
|
Visible to everyone. |
|
|
Visible only to unauthenticated visitors. |
|
|
Visible only to authenticated Users. |
|
|
Visible only to authenticated Users without authorization for the resource. |
|
|
Visible only to authenticated Users with authorization for the resource. |
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
Role type
Values
| Enum Value | Description |
|---|---|
|
|
Super user |
|
|
Builder |
|
|
Reseller |
|
|
Administrator |
|
|
Moderator |
|
|
End user |
Example
"root"
SortByInput
Description
A sort input
Fields
| Input Field | Description |
|---|---|
field - String
|
The field to sort by. |
direction - SortOrderEnum
|
The sort direction. |
Example
{"field": "string", "direction": "asc"}
SortOrderEnum
Description
Sort direction
Values
| Enum Value | Description |
|---|---|
|
|
Sort in ascending order. |
|
|
Sort in descending order. |
|
|
Sort in random order. |
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
|
The display label for this structure entry. |
type - String
|
The value type for this structure entry. |
key - String
|
The machine-readable key for this structure entry. |
value - [StructureKeyValueIntegerPair]
|
The typed value for this structure entry. |
Example
{
"label": "string",
"type": "string",
"key": "string",
"value": [StructureKeyValueIntegerPair]
}
StructureKeyValueIntegerPair
Description
Structure key integer-value list pair type
Example
{
"label": "string",
"type": "string",
"key": "string",
"value": 42
}
StructureKeyValueStringPair
Description
Structure key string-value list pair type
Example
{
"label": "string",
"type": "string",
"key": "string",
"value": "string"
}
Subscription
Description
A Subscription.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Subscription. |
project_id - Int!
|
The Project id that owns the Subscription. |
remote_subscription_id - String
|
The Subscription's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Subscription's name. |
title - String
|
The Subscription's title. |
description - String
|
The Subscription's description. |
Arguments
|
|
description_short - String
|
The Subscription's short description. |
Arguments
|
|
type - SubscriptionTypeEnum
|
The Subscription's type. |
price - Float
|
The Subscription's initial price (on first payment). |
price_per_installment - Float
|
The Subscription's price per recurring periodic installment. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's recurring periodic installment. |
time_unit_translation - String
|
The translated label of time_unit. |
frequency - Float
|
How often, in units of time_unit, the Subscription's recurring periodic installment repeats. |
currency - String
|
The Subscription's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Subscription's currency symbol (e.g. "€"). |
initial_installment_num - Int
|
The Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's initial installment. |
allow_suspend_after_installment_num - Int
|
The number of periodic installments after which a UserSubscription is allowed to be suspended. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for a UserSubscription. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon purchasing this Subscription. |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
Which Articles the Subscription entitles. |
is_credit_issuing - Boolean
|
Whether the Subscription periodically issues credits through one of its Products. |
purchase_num - Int
|
The quantity of the Subscription in the context it is being resolved in. Always 1. |
max_purchase_num - Int
|
The maximum quantity that may be purchased of this Subscription. Always 1. |
articles - [ArticleListedAsRelation]
|
The Articles individually selected as part of the Subscription's entitlement_scope. |
categories - [CategoryListedAsRelation]
|
The Categories individually selected as part of the Subscription's entitlement_scope. |
payment_providers - [PaymentProviderListedAsRelation]
|
The PaymentProviders through which this Subscription may be purchased. Empty means all PaymentProviders are allowed. |
icons - [File]
|
The Subscription's icon Files. |
images - [File]
|
The Subscription's image Files. |
posters - [File]
|
The Subscription's poster Files. |
videos - [File]
|
The Subscription's video Files. |
created_at - String
|
The Subscription's creation date (UTC). |
updated_at - String
|
The Subscription's last modification date (UTC). |
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": false,
"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
How discoverable the Subscription is to Users.
Values
| Enum Value | Description |
|---|---|
|
|
Hidden from all listing/browse/search surfaces, but still directly reachable by id or direct link. |
|
|
Discoverable through listing/browse/search surfaces. |
Example
"hidden"
SubscriptionEntitlementScopeEnum
Description
Which Articles the Subscription entitles.
Values
| Enum Value | Description |
|---|---|
|
|
The Subscription entitles all Articles except the individually selected Articles/Categories, which are excluded. |
|
|
The Subscription entitles only the individually selected Articles/Categories. |
|
|
The Subscription entitles all Articles, including those created in the future. |
Example
"partial_exclusive"
SubscriptionListed
Description
A Subscription, as part of a list.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the Subscription. |
project_id - Int!
|
The Project id that owns the Subscription. |
remote_subscription_id - String
|
The Subscription's remote id (e.g. used for in-app purchases), prefixed per the Project's configuration. |
name - String
|
The Subscription's name. |
title - String
|
The Subscription's title. |
description - String
|
The Subscription's description. |
Arguments
|
|
description_short - String
|
The Subscription's short description. |
Arguments
|
|
type - SubscriptionTypeEnum
|
The Subscription's type. |
price - Float
|
The Subscription's initial price (on first payment). |
price_per_installment - Float
|
The Subscription's price per recurring periodic installment. |
time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's recurring periodic installment. |
time_unit_translation - String
|
The translated label of time_unit. |
frequency - Float
|
How often, in units of time_unit, the Subscription's recurring periodic installment repeats. |
currency - String
|
The Subscription's currency code (e.g. "EUR"). |
currency_symbol - String
|
The Subscription's currency symbol (e.g. "€"). |
initial_installment_num - Int
|
The Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the Subscription's initial installment. |
allow_suspend_after_installment_num - Int
|
The number of periodic installments after which a UserSubscription is allowed to be suspended. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for a UserSubscription. |
newsletter_list_id - String
|
The id of the newsletter list a User is added to upon purchasing this Subscription. |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
Which Articles the Subscription entitles. |
is_credit_issuing - Boolean
|
Whether the Subscription periodically issues credits through one of its Products. |
purchase_num - Int
|
The quantity of the Subscription in the context it is being resolved in. Always 1. |
max_purchase_num - Int
|
The maximum quantity that may be purchased of this Subscription. Always 1. |
articles - [ArticleListedAsRelation]
|
The Articles individually selected as part of the Subscription's entitlement_scope. |
categories - [CategoryListedAsRelation]
|
The Categories individually selected as part of the Subscription's entitlement_scope. |
payment_providers - [PaymentProviderListedAsRelation]
|
The PaymentProviders through which this Subscription may be purchased. Empty means all PaymentProviders are allowed. |
icons - [File]
|
The Subscription's icon Files. |
images - [File]
|
The Subscription's image Files. |
posters - [File]
|
The Subscription's poster Files. |
videos - [File]
|
The Subscription's video Files. |
created_at - String
|
The Subscription's creation date (UTC). |
updated_at - String
|
The Subscription's last modification date (UTC). |
is_pricing_highlighted - Boolean
|
Whether the Subscription is highlighted as "recommended" in pricing overviews. |
is_pricing_display_recurring_price - Boolean
|
Whether the Subscription's recurring price 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": true
}
SubscriptionListedAsResource
SubscriptionStatusEnum
Description
The Subscription's publication status.
Values
| Enum Value | Description |
|---|---|
|
|
The Subscription is not published and cannot be purchased. |
|
|
The Subscription is published and can be purchased. |
Example
"inactive"
SubscriptionTimeUnitEnum
Description
The time unit a periodical value is expressed in.
Values
| Enum Value | Description |
|---|---|
|
|
A period of one day. |
|
|
A period of one week. |
|
|
A period of one month. |
|
|
A period of one year. |
Example
"day"
SubscriptionTypeEnum
Description
The Subscription's type.
Values
| Enum Value | Description |
|---|---|
|
|
A standard subscription-video-on-demand Subscription, billed periodically. |
|
|
A trial Subscription. |
Example
"svod"
SubscriptionsListedWithPagination
Description
A paginated list of Subscriptions.
Fields
| Field Name | Description |
|---|---|
items - [SubscriptionListed]
|
The Subscriptions. |
pagination - Pagination
|
The pagination details for this list. |
Example
{
"items": [SubscriptionListed],
"pagination": Pagination
}
Translation
User
Description
A User.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the User. |
project_id - Int
|
The Project id that owns the User. |
name - String
|
The User's name. |
display_name - String
|
The User's display name, typically the User's first name or first part of the e-mail address. |
email - String
|
The User's e-mail address. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
status - UserStatusEnum
|
The User's verification status. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
geo_region_code - String
|
The User's country code. |
phone - String
|
The User's phone number. |
is_phone_verified - UserPhoneStatusEnum
|
The User's phone number verification status. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the User has accepted the terms and conditions. |
is_marked_for_deletion - Boolean
|
Whether the User's account is marked for deletion. |
delete_at - String
|
The date (UTC) at which the User's account will be deleted, when is_marked_for_deletion is true. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for the User. |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the User's current UserSubscription, if any. |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The most recent event of importance generated for the User's current UserSubscription, if any. |
subscription_id - Int
|
The Subscription id the User's current UserSubscription is an instance of, if any. |
favourite_articles - [ArticleRelated]
|
The Articles the User marked as favourite. |
nomadic_articles - [ArticleRelated]
|
The Articles the User has an active (in-progress) nomadic playback position for. |
history_articles - [ArticleRelated]
|
The Articles the User has completed. |
entitled_articles - [ArticleRelated]
|
The complete list of Articles the User is entitled to. |
entitled_root_articles - [ArticleRelated]
|
The root-level Articles the User is entitled to. |
articles - [ArticleRelated]
|
The Articles related to the User (favourite, nomadic, and/or history). |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
The User's latest active nomadic Article. |
consents - [UserConsent]
|
The User's cookie consent records. |
metric_actions - [MetricAction]
|
The MetricActions fulfilled by the User. |
notification_profiles - [UserNotificationProfile]
|
The User's notification delivery profiles. |
notification_topics - [UserNotificationTopic]
|
The NotificationTopics the User is subscribed to. |
user_subscriptions - [UserSubscription]
|
The User's UserSubscriptions. |
user_products - [UserProduct]
|
The User's purchased Products. |
orders - [UserPaymentAccountOrder]
|
The User's UserPaymentAccountOrders, excluding open, cancelled, aborted, and expired ones. |
Arguments
|
|
user_payment_credit_amount - Float
|
The User's available credit amount for the given credit type. |
Arguments
|
|
user_payment_general_credit_amount - Float
|
The User's available general credit amount. |
user_payment_free_article_credit_amount - Float
|
The User's available free-article credit amount. |
user_payment_currency_amount - Float
|
The User's available account balance amount, in the currency indicated by user_payment_currency. |
user_payment_currency_symbol - String
|
The currency symbol paired with user_payment_currency. |
user_payment_currency - String
|
The currency code user_payment_currency_amount is expressed in. |
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": false,
"birthday": "string",
"height": 987.65,
"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,
"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's Article view session.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserArticleSession record. |
user_id - Int
|
The id of the authenticated User that generated this UserArticleSession record (null for an anonymous User, see anonymous_user_id). |
anonymous_user_id - String
|
The anonymous visitor id that generated this UserArticleSession record, for a User without an account (null for an authenticated User, see user_id). |
article_id - Int
|
The id of the Article this UserArticleSession record belongs to. |
asset_id - Int
|
The id of the Asset this UserArticleSession record belongs to. |
linked_type - String
|
The UserArticleSession's Article-Asset linked type. |
time_watched - Int
|
The UserArticleSession's amount of time watched (only meaningful for play-time event types). |
time_delta - Float
|
The UserArticleSession's elapsed time. |
resolution_tag - String
|
The UserArticleSession's displayed resolution. |
protocol - String
|
The UserArticleSession's streaming protocol. |
encryption_type - String
|
The UserArticleSession's encryption type. |
event_type - String
|
The UserArticleSession's event type (play-time event types: "play", "playing", "stop"). |
event_payload - String
|
The UserArticleSession's recorded payload/message. |
is_progress_marker1_completed - Boolean
|
Whether the UserArticleSession fulfilled custom progress marker 1. |
is_progress_marker2_completed - Boolean
|
Whether the UserArticleSession fulfilled custom progress marker 2. |
is_progress_marker3_completed - Boolean
|
Whether the UserArticleSession fulfilled custom progress marker 3. |
is_completed - Boolean
|
Whether the UserArticleSession fulfilled the Asset's completion marker. |
device_type - String
|
The UserArticleSession's detected device type. |
device_brand - String
|
The UserArticleSession's detected device brand. |
device_model - String
|
The UserArticleSession's detected device model. |
telemetry_platform - String
|
The UserArticleSession's detected telemetry platform. |
ip_address - String
|
The UserArticleSession's IP address. |
user_agent - String
|
The User's user agent (browser/app) through which this Article-Asset was last watched. |
geo_region_code - String
|
The UserArticleSession's geo-region code. |
audio_locale - String
|
The UserArticleSession's audio language (ISO 639-1 code). |
subtitle_locale - String
|
The UserArticleSession's subtitle language (ISO 639-1 code). |
started_at - String
|
The UserArticleSession's start date (UTC). |
article_name - String
|
The Article's name. |
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",
"protocol": "string",
"encryption_type": "string",
"event_type": "string",
"event_payload": "string",
"is_progress_marker1_completed": false,
"is_progress_marker2_completed": true,
"is_progress_marker3_completed": false,
"is_completed": true,
"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 id of the User consent property. |
user_id - Int
|
The User id that owns the consent property. |
value - Boolean
|
The User consent property's boolean value. |
type - UserConsentTypeEnum
|
The User consent property's type. |
created_at - String
|
The User consent property's creation date in UTC. |
updated_at - String
|
The User consent property's last modification date in UTC. |
Example
{
"id": 42,
"user_id": 42,
"value": false,
"type": "cookie_analytics",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserConsentInput
Description
A User's cookie consent record.
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
Whether the User has given consent for this type. |
type - UserConsentTypeEnum
|
The cookie consent category this record applies to. |
Example
{"value": false, "type": "cookie_analytics"}
UserConsentTypeEnum
Description
The cookie consent category a User's consent record applies to.
Values
| Enum Value | Description |
|---|---|
|
|
Consent for analytics cookies (e.g. Google Analytics, Google Tag Manager, Facebook Pixel). |
|
|
Consent for marketing/ad-storage cookies (e.g. targeted advertisement). |
|
|
Consent for preference cookies (e.g. storage of the User's preferred language). |
Example
"cookie_analytics"
UserDetails
Description
The current authenticated User's own details.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the User. |
project_id - Int
|
The Project id that owns the User. |
name - String
|
The User's name. |
display_name - String
|
The User's display name, typically the User's first name or first part of the e-mail address. |
email - String
|
The User's e-mail address. |
gender - UserGenderTypeEnum
|
The User's gender. |
locale - String
|
The User's locale (language). |
subtitle_locale - String
|
The User's preferred subtitle locale (language). |
audio_locale - String
|
The User's preferred audio locale (language). |
status - UserStatusEnum
|
The User's verification status. |
address - String
|
The User's address. |
postal_code - String
|
The User's postal code. |
city - String
|
The User's city. |
country - String
|
The User's country. |
geo_region_code - String
|
The User's country code. |
phone - String
|
The User's phone number. |
is_phone_verified - UserPhoneStatusEnum
|
The User's phone number verification status. |
birthday - String
|
The User's birthday. |
height - Float
|
The User's height. |
weight - Float
|
The User's weight. |
custom_data - String
|
Custom data stored for the User. |
is_newsletter_opt_in - Boolean
|
Whether the User has opted in to the newsletter. |
is_terms_and_conditions_opt_in - Boolean
|
Whether the User has accepted the terms and conditions. |
is_marked_for_deletion - Boolean
|
Whether the User's account is marked for deletion. |
delete_at - String
|
The date (UTC) at which the User's account will be deleted, when is_marked_for_deletion is true. |
notifiable - UserNotifiableTypeEnum
|
How the User may be notified. |
max_concurrent_vod_stream_num - Int
|
The maximum number of concurrent VOD streams allowed for the User. |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the User's current UserSubscription, if any. |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The most recent event of importance generated for the User's current UserSubscription, if any. |
subscription_id - Int
|
The Subscription id the User's current UserSubscription is an instance of, if any. |
favourite_articles - [ArticleRelated]
|
The Articles the User marked as favourite. |
nomadic_articles - [ArticleRelated]
|
The Articles the User has an active (in-progress) nomadic playback position for. |
history_articles - [ArticleRelated]
|
The Articles the User has completed. |
entitled_articles - [ArticleRelated]
|
The complete list of Articles the User is entitled to. |
entitled_root_articles - [ArticleRelated]
|
The root-level Articles the User is entitled to. |
articles - [ArticleRelated]
|
The Articles related to the User (favourite, nomadic, and/or history). |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
The User's latest active nomadic Article. |
consents - [UserConsent]
|
The User's cookie consent records. |
metric_actions - [MetricAction]
|
The MetricActions fulfilled by the User. |
notification_profiles - [UserNotificationProfile]
|
The User's notification delivery profiles. |
notification_topics - [UserNotificationTopic]
|
The NotificationTopics the User is subscribed to. |
user_subscriptions - [UserSubscription]
|
The User's UserSubscriptions. |
user_products - [UserProduct]
|
The User's purchased Products. |
orders - [UserPaymentAccountOrder]
|
The User's UserPaymentAccountOrders, excluding open, cancelled, aborted, and expired ones. |
Arguments
|
|
user_payment_credit_amount - Float
|
The User's available credit amount for the given credit type. |
Arguments
|
|
user_payment_general_credit_amount - Float
|
The User's available general credit amount. |
user_payment_free_article_credit_amount - Float
|
The User's available free-article credit amount. |
user_payment_currency_amount - Float
|
The User's available account balance amount, in the currency indicated by user_payment_currency. |
user_payment_currency_symbol - String
|
The currency symbol paired with user_payment_currency. |
user_payment_currency - String
|
The currency code user_payment_currency_amount is expressed in. |
is_terms_and_conditions_renewal_required - Boolean
|
Whether renewed acceptance of the terms and conditions is required from the 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": false,
"birthday": "string",
"height": 987.65,
"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": [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",
"is_terms_and_conditions_renewal_required": false
}
UserGenderTypeEnum
Description
The User's gender.
Values
| Enum Value | Description |
|---|---|
|
|
Male. |
|
|
Female. |
|
|
Non-binary. |
|
|
Unknown or unspecified. |
Example
"male"
UserMetaTranslation
Description
A translated User meta property value.
Example
{
"id": 42,
"user_meta_id": 42,
"value": "string",
"locale": "string"
}
UserNotifiableTypeEnum
Description
How the User may be notified.
Values
| Enum Value | Description |
|---|---|
|
|
The User does not receive notifications. |
|
|
The User receives notifications via SMS. |
Example
"none"
UserNotificationProfile
Description
A User notification profile.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the User notification profile. |
user_id - Int
|
The id of the User who owns this notification profile. |
notification_token - String
|
The device notification token linked to the User. |
device_tag - String
|
The human-readable device tag for this notification profile. |
created_at - String
|
The UTC datetime when the User notification profile was created. |
updated_at - String
|
The UTC datetime when the User notification profile was last updated. |
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
Description
A User notification profile input object.
Example
{
"notification_token": "string",
"device_tag": "string"
}
UserNotificationTopic
Description
A User NotificationTopic subscription.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the NotificationTopic. |
remote_notification_topic_id - String
|
The remote id of the NotificationTopic used by push-notification providers. |
project_id - Int!
|
The Project id that owns the NotificationTopic. |
name - String
|
The NotificationTopic's internal name. |
title - String
|
The NotificationTopic's localized title. |
description - String
|
The NotificationTopic's localized description. |
is_subscribed - Boolean
|
Whether the User is subscribed to this NotificationTopic. |
notify_at - String
|
The preferred UTC time for notifying the User on this NotificationTopic. |
notified_at - String
|
The UTC datetime when the User was last notified on this NotificationTopic. |
created_at - String
|
The UTC datetime when the User NotificationTopic subscription was created. |
updated_at - String
|
The UTC datetime when the User NotificationTopic subscription was last updated. |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string",
"is_subscribed": true,
"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 NotificationTopic subscription input object.
Example
{
"id": 42,
"notify_at": "string",
"is_subscribed": true
}
UserPaymentAccount
Description
A UserPaymentAccount
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserPaymentAccount. |
payment_provider_id - Int
|
The id of the PaymentProvider linked to the UserPaymentAccount. |
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 GeoRegion code from which the UserPaymentAccount creation originated. |
orders - [UserPaymentAccountOrder]
|
The UserPaymentAccountOrders for this account. |
Example
{
"id": 42,
"payment_provider_id": 42,
"amount_balance": 987.65,
"method": "string",
"method_details": "string",
"geo_region_code": "nl",
"orders": [UserPaymentAccountOrder]
}
UserPaymentAccountOrder
Description
A UserPaymentAccountOrder
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserPaymentAccountOrder. |
user_id - Int
|
The id of the User that owns the UserPaymentAccountOrder. |
user_subscription_id - String
|
The id of the UserSubscription related to the UserPaymentAccountOrder. |
payment_syndicate_voucher_id - Int
|
The id of the PaymentSyndicateVoucher attached to the UserPaymentAccountOrder. |
voucher_code - String
|
The Voucher Code attached to the UserPaymentAccountOrder. |
type - String
|
The UserPaymentAccountOrder's type. |
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 UserPaymentAccountOrder's amount. |
status - String
|
The UserPaymentAccountOrder's payment status. |
status_name - String
|
The UserPaymentAccountOrder's translated payment status name. |
description - String
|
The UserPaymentAccountOrder's description. |
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 UserPaymentAccountOrder's currency. |
currency_symbol - String
|
The UserPaymentAccountOrder's currency symbol. |
products - [ProductListedAsRelation]
|
The Products related to the UserPaymentAccountOrder. |
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": 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]
}
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 resulting Subscription's price per recurring periodic installment. |
initial_installment_num - Int
|
The resulting Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the resulting Subscription's initial installment. |
allow_suspend_after_installment_num - Int
|
The number of periodic installments after which the resulting UserSubscription is allowed to be suspended. |
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
UserPaymentCredit type
Values
| Enum Value | Description |
|---|---|
|
|
General-purpose User payment credits. |
|
|
Credits that can fulfil eligible free-article Products. |
Example
"general"
UserPaymentVoucherRedeem
Description
The result of redeeming a PaymentSyndicateVoucher Code.
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 resulting Subscription's price per installment. |
initial_installment_num - Int
|
The resulting Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit in which initial_installment_num is expressed. |
allow_suspend_after_installment_num - Int
|
The number of installments after which the resulting Subscription is allowed to be suspended. |
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's phone number verification status.
Values
| Enum Value | Description |
|---|---|
|
|
The User's phone number has not been verified. |
|
|
The User's phone number has been verified. |
Example
"unverified"
UserProduct
Description
A Product purchased by a User.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the UserProduct. |
product_id - Int
|
The id of the purchased Product. |
user_id - Int
|
The User id that purchased the Product. |
user_payment_account_order_id - Int
|
The UserPaymentAccountOrder id through which the Product was purchased. |
is_fulfilled - Boolean
|
Whether the UserProduct's entitlement has been fulfilled. |
fulfilment_expires_at - String
|
The date (UTC) until which the UserProduct's fulfilled entitlement remains valid. |
order - UserPaymentAccountOrder
|
The UserPaymentAccountOrder through which the Product was purchased. |
product - Product
|
The purchased Product. |
account - UserPaymentAccount
|
The UserPaymentAccount the purchase was made through. |
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
The result of a Product acquisition by a User.
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 Product purchased by a User, as part of a list.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the UserProduct. |
product_id - Int
|
The id of the purchased Product. |
user_id - Int
|
The User id that purchased the Product. |
user_payment_account_order_id - Int
|
The UserPaymentAccountOrder id through which the Product was purchased. |
is_fulfilled - Boolean
|
Whether the UserProduct's entitlement has been fulfilled. |
fulfilment_expires_at - String
|
The date (UTC) until which the UserProduct's fulfilled entitlement remains valid. |
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
A paginated list of Products purchased by a User.
Fields
| Field Name | Description |
|---|---|
items - [UserProductListed]
|
The purchased Products. |
pagination - Pagination
|
The pagination details for this list. |
Example
{
"items": [UserProductListed],
"pagination": Pagination
}
UserPurchaseIntentAcquire
Description
A User purchase-intent acquisition reflecting a cart checkout.
Fields
| Field Name | Description |
|---|---|
operator_context - String
|
The operator context for the purchase intent. |
device_type - String
|
The User's device type. |
user_payment_account_order_id - String
|
The id of the User payment account order issued by AudiencePlayer. |
remote_payment_order_id - String
|
The remote payment order id issued by the payment provider. |
payment_url - String
|
The payment URL to redirect the User to when the payment provider requires a hosted payment flow. |
payment_object - String
|
The payment object a frontend app should use to finalise a transaction for payment providers that require one. |
payment_signature - String
|
The payment signature a frontend app should use to verify a transaction for payment providers that require one. |
description - String
|
The order description, shown in order details and as the "statement descriptor" in external monetary transaction overviews (e.g. a credit card bill). |
price - Float
|
The order price. |
printable_price - String
|
The order price, formatted with the applicable comma/dot separator for the requested locale. |
price_before - Float
|
The order price before applying a Voucher or amount balance. |
price_voucher_diff - Float
|
The order price difference from the applied Voucher (typically a reduction in price). |
price_amount_balance_diff - Float
|
The order price difference from 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
|
Whether the purchase intent was only validated instead of actually executed as a payment transaction. |
is_allow_voucher_usage - Boolean
|
Whether a Voucher code may be used on this purchase-intent stack. |
is_allow_amount_balance_usage - Boolean
|
Whether amount balance may be used on this purchase-intent stack. |
is_allow_combined_amount_balance_voucher_usage - Boolean
|
Whether amount balance may be combined with a Voucher code on this purchase-intent stack. |
voucher_code - String
|
The Voucher code used for this purchase intent. |
purchase_intent_stack - [UserPurchaseIntentStackItem]
|
The Products and Subscriptions initially requested for checkout. |
stacked_subscriptions - [SubscriptionListed]
|
The Subscriptions included in the validated purchase intent. |
stacked_products - [ProductListed]
|
The Products included in the validated purchase intent. |
stacked_vouchers - [PaymentSyndicateVoucherListed]
|
The Vouchers included in the validated purchase intent. |
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]
|
The order items in the validated purchase intent. |
Arguments
|
|
validation_status - Boolean
|
Whether the purchase intent is valid; see validation_messages for the specific warnings/errors when this is false. |
validation_messages - [UserPurchaseIntentValidationMessage]
|
The validation warning and error messages for the purchase intent. |
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": false,
"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
An order item in a validated purchase intent (e.g. a Product, Subscription, applied Voucher, or deducted amount balance).
Fields
| Field Name | Description |
|---|---|
id - String
|
The id of the order item. |
type - String
|
The order item's type. |
title - String
|
The order item's title. |
description - String
|
The order item's description. |
purchase_num - String
|
The order item's quantity. |
price - Float
|
The order item's listed price. |
calculated_price - Float
|
The order item's calculated total price, based on its quantity and any applied discount. |
printable_price - String
|
The order item's listed price, formatted with the applicable comma/dot separator for the requested locale. |
printable_calculated_price - String
|
The order item's calculated total price, formatted with the applicable comma/dot separator for the requested locale. |
currency - String
|
The order item's price currency. |
currency_symbol - String
|
The order item's price currency symbol. |
is_inherited - Boolean
|
Whether this order item was inherited from 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 item marked for checkout.
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the Product or Subscription in the purchase-intent stack. |
resource_type - ResourceTypeEnum
|
The resource type of the purchase-intent stack item. |
currency - String
|
The requested payment currency for the purchase-intent stack item. |
purchase_num - Int
|
The requested quantity for the purchase-intent stack item. |
Example
{"id": 42, "resource_type": "article", "currency": "EUR", "purchase_num": 42}
UserPurchaseIntentStackItemInput
Description
A Subscription or Product marked for checkout, as part of a purchase intent stack.
Fields
| Input Field | Description |
|---|---|
id - Int
|
The id of the Subscription or Product, per resource_type. |
resource_type - ResourceTypeEnum
|
Whether id refers to a Subscription or a Product. |
currency - PaymentProviderCurrencyEnum
|
The currency to use for payment of this item. |
purchase_num - Int
|
The quantity of the Subscription or Product to purchase. |
Example
{"id": 42, "resource_type": "article", "currency": "CREDIT", "purchase_num": 42}
UserPurchaseIntentValidationMessage
Description
A validation warning or error for a purchase intent.
Example
{
"message": "string",
"code": 42,
"value": "string"
}
UserStatusEnum
Description
The User's verification status.
Values
| Enum Value | Description |
|---|---|
|
|
The User has been administratively disabled and can no longer authenticate. |
|
|
The User has registered but has not yet verified their e-mail address. |
|
|
The User has verified their e-mail address. |
Example
"disabled"
UserSubscription
Description
A UserSubscription.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserSubscription. |
user_id - Int!
|
The User id that owns the UserSubscription. |
project_id - Int!
|
The Project id that owns the UserSubscription. |
subscription_id - Int!
|
The Subscription id the UserSubscription is an instance of. |
switch_from_subscription_id - Int
|
The Subscription id the UserSubscription was switched from, when applicable. |
switch_to_subscription_id - Int
|
The Subscription id the UserSubscription is scheduled to switch to at its next renewal, when status is "switch_at_renewal". |
term - Int
|
The UserSubscription's current term number (how many renewals it has completed). |
acquired_at - String
|
The UserSubscription's acquisition date (UTC). |
expires_at - String
|
The UserSubscription's current expiry date (UTC). |
suspendable_at - String
|
The date (UTC) from which the UserSubscription becomes eligible to be suspended. |
suspended_at - String
|
The date (UTC) at which the UserSubscription was suspended. |
invoiced_at - String
|
The UserSubscription's next invoice date (UTC). |
status - UserSubscriptionStatusEnum
|
The UserSubscription's status. |
status_name - String
|
The UserSubscription's status, as an upper-case label. |
is_valid - Boolean
|
Whether the UserSubscription is currently valid. |
is_expired - Boolean
|
Whether the UserSubscription's expires_at date has passed. |
is_suspendable - Boolean
|
Whether the UserSubscription is currently eligible to be suspended. |
is_account_method_changeable - Boolean
|
Whether the UserSubscription's payment account method may currently be changed. |
is_switchable - Boolean
|
Whether the UserSubscription may currently be switched to a different Subscription. |
orders - [UserPaymentAccountOrder]
|
The UserPaymentAccountOrders associated with the UserSubscription. |
Arguments
|
|
subscription - Subscription
|
The Subscription the UserSubscription is an instance of. |
account - UserPaymentAccount
|
The UserPaymentAccount the UserSubscription is billed through. |
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": true,
"orders": [UserPaymentAccountOrder],
"subscription": Subscription,
"account": UserPaymentAccount
}
UserSubscriptionAcquire
Description
The result of acquiring a Subscription for a User.
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 resulting Subscription's price per recurring periodic installment. |
initial_installment_num - Int
|
The resulting Subscription's initial number of installments. |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the resulting Subscription's initial installment. |
allow_suspend_after_installment_num - Int
|
The number of periodic installments after which the resulting UserSubscription is allowed to be suspended. |
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 type of event that affected the UserSubscription.
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. |
|
|
The renewal mandate was present but has been revoked or is no longer valid. |
|
|
A renewal payment order has been generated, but it has not yet been fufilled. |
|
|
The renewal payment was declined by the provider, e.g. due to insufficient funds. |
|
|
When attempting renewal, given voucher code could not be processed. |
Example
"first_payment_error"
UserSubscriptionListed
Description
A UserSubscription, as part of a list.
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the UserSubscription. |
user_id - Int!
|
The User id that owns the UserSubscription. |
project_id - Int!
|
The Project id that owns the UserSubscription. |
subscription_id - Int!
|
The Subscription id the UserSubscription is an instance of. |
switch_from_subscription_id - Int
|
The Subscription id the UserSubscription was switched from, when applicable. |
switch_to_subscription_id - Int
|
The Subscription id the UserSubscription is scheduled to switch to at its next renewal, when status is "switch_at_renewal". |
term - Int
|
The UserSubscription's current term number (how many renewals it has completed). |
acquired_at - String
|
The UserSubscription's acquisition date (UTC). |
expires_at - String
|
The UserSubscription's current expiry date (UTC). |
suspendable_at - String
|
The date (UTC) from which the UserSubscription becomes eligible to be suspended. |
suspended_at - String
|
The date (UTC) at which the UserSubscription was suspended. |
invoiced_at - String
|
The UserSubscription's next invoice date (UTC). |
status - UserSubscriptionStatusEnum
|
The UserSubscription's status. |
status_name - String
|
The UserSubscription's status, as an upper-case label. |
is_valid - Boolean
|
Whether the UserSubscription is currently valid. |
is_expired - Boolean
|
Whether the UserSubscription's expires_at date has passed. |
is_suspendable - Boolean
|
Whether the UserSubscription is currently eligible to be suspended. |
is_account_method_changeable - Boolean
|
Whether the UserSubscription's payment account method may currently be changed. |
is_switchable - Boolean
|
Whether the UserSubscription may currently be switched to a different Subscription. |
orders - [UserPaymentAccountOrder]
|
The UserPaymentAccountOrders associated with the UserSubscription. |
subscription - Subscription
|
The Subscription the UserSubscription is an instance of. |
account - UserPaymentAccount
|
The UserPaymentAccount the UserSubscription is billed through. |
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": true,
"is_suspendable": false,
"is_account_method_changeable": true,
"is_switchable": false,
"orders": [UserPaymentAccountOrder],
"subscription": Subscription,
"account": UserPaymentAccount
}
UserSubscriptionStatusEnum
Description
The UserSubscription's status.
Values
| Enum Value | Description |
|---|---|
|
|
The UserSubscription has been created but not yet activated. |
|
|
The UserSubscription is active and valid. |
|
|
The UserSubscription is temporarily suspended, but still considered valid and eligible for Article playback. |
|
|
The UserSubscription has been administratively disabled and is no longer valid. |
|
|
The UserSubscription was granted for demonstration purposes, without a real purchase, and is considered valid. |
|
|
The UserSubscription is valid, but not currently eligible for Article playback. |
|
|
The UserSubscription has lapsed and is no longer valid. This is a terminal state. |
|
|
The UserSubscription is marked to switch to a different Subscription at its next renewal, and remains valid until then. |
|
|
The UserSubscription is in an error state. |
Example
"initialised"
UserSubscriptionsListedWithPagination
Description
A paginated list of UserSubscriptions.
Fields
| Field Name | Description |
|---|---|
items - [UserSubscriptionListed]
|
The UserSubscriptions. |
pagination - Pagination
|
The pagination details for this list. |
Example
{
"items": [UserSubscriptionListed],
"pagination": Pagination
}