AudiencePlayer API Documentation
ADMIN SCHEMA
You are currently viewing the documentation for the AudiencePlayer GraphQL API USER SCHEMA, version 31.11.4, 2025-11-25 13:41:57 UTC.
☞ View the documentation for the USER SCHEMA
Queries
ActivityLogList
Description
Query list of activity logs with pagination
Response
Returns an AdminActivityLogsListedWithPagination
Arguments
| Name | Description |
|---|---|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "user_id", "created_at", "log_name", "log_level" |
project_id - Int
|
|
search - String
|
Example
Query
query ActivityLogList(
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$project_id: Int,
$search: String
) {
ActivityLogList(
limit: $limit,
offset: $offset,
sort_by: $sort_by,
project_id: $project_id,
search: $search
) {
items {
...AdminActivityLogFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"project_id": 42,
"search": "string"
}
Response
{
"data": {
"ActivityLogList": {
"items": [AdminActivityLog],
"pagination": Pagination
}
}
}
Article
Description
Query article
Response
Returns an AdminArticle
Example
Query
query Article(
$id: Int,
$locale: String
) {
Article(
id: $id,
locale: $locale
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...AdminArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AdminAssetFragment
}
categories {
...AdminCategoryFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...AdminProductFragment
}
upsell_products {
...AdminProductFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
is_auto_generate_recommendations
is_show_in_all_geo_regions
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
canonical_title_translations {
...TranslationFragment
}
upsell_product_call_to_action_tag_translations {
...TranslationFragment
}
ribbon_title_translations {
...TranslationFragment
}
children {
...AdminArticleFragment
}
recommended_articles {
...AdminArticleFragment
}
featured_on_categories {
...AdminCategoryFragment
}
files {
...FileFragment
}
entitling_subscriptions {
...AdminSubscriptionFragment
}
published_from
published_until
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"Article": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": true,
"is_auth_required": false,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": 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"
}
}
}
ArticleList
Description
Query list of articles with pagination
Response
Returns an AdminArticlesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
parent_id - Int
|
|
parent_ids - [Int]
|
|
ancestor_id - Int
|
The article ancestor id the article is a descendant of |
category_id - Int
|
The category id the article belongs to |
category_ids - [Int]
|
The category ids (XOR) the article belongs to |
article_ids - [Int]
|
The article ids to be fetched |
type - ArticleTypeEnum
|
Article type |
types - [ArticleTypeEnum]
|
The types to filter resources on (filter type: "where in") |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "published_at", "published_from", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
list_filter - ArticleListFilterTypeEnum
|
Article list filter type |
project_id - Int
|
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,
$project_id: Int
) {
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,
project_id: $project_id
) {
items {
...AdminArticleFragment
}
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",
"project_id": 42
}
Response
{
"data": {
"ArticleList": {
"items": [AdminArticle],
"pagination": Pagination
}
}
}
Asset
Description
Query video asset
Response
Returns an AdminAsset
Example
Query
query Asset(
$project_id: Int,
$id: Int
) {
Asset(
project_id: $project_id,
id: $id
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{"project_id": 42, "id": 42}
Response
{
"data": {
"Asset": {
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 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",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetList
Description
Query list of video assets with pagination
Response
Returns an AdminAssetsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
project_id - Int
|
|
asset_status_id - Int
|
|
asset_status - AssetStatusEnum
|
|
source_asset_id - String
|
|
streaming_unit_id - String
|
|
source_blob_name - String
|
|
source_blob_md5 - String
|
|
is_published - Boolean
|
|
type - AssetTypeEnum
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "source_blob_name", "asset_status_id", "asset_status", "type", "streaming_unit_id", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query AssetList(
$search: String,
$limit: Int,
$offset: Int,
$project_id: Int,
$asset_status_id: Int,
$asset_status: AssetStatusEnum,
$source_asset_id: String,
$streaming_unit_id: String,
$source_blob_name: String,
$source_blob_md5: String,
$is_published: Boolean,
$type: AssetTypeEnum,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
AssetList(
search: $search,
limit: $limit,
offset: $offset,
project_id: $project_id,
asset_status_id: $asset_status_id,
asset_status: $asset_status,
source_asset_id: $source_asset_id,
streaming_unit_id: $streaming_unit_id,
source_blob_name: $source_blob_name,
source_blob_md5: $source_blob_md5,
is_published: $is_published,
type: $type,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminAssetListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"project_id": 42,
"asset_status_id": 42,
"asset_status": "source_asset_created",
"source_asset_id": "string",
"streaming_unit_id": "string",
"source_blob_name": "string",
"source_blob_md5": "string",
"is_published": true,
"type": "audio",
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"AssetList": {
"items": [AdminAssetListed],
"pagination": Pagination
}
}
}
AssetState
Description
Query video asset state
Response
Returns an AssetState
Example
Query
query AssetState(
$project_id: Int,
$asset_id: Int
) {
AssetState(
project_id: $project_id,
asset_id: $asset_id
) {
current_asset_status_id
current_asset_status_name
calculated_asset_status_id
calculated_asset_status_name
live_remote_asset_id
live_remote_asset_status_name
live_remote_asset_status_description
is_live_remote_asset_source_video_encoding
is_live_remote_asset_encoded_video_packaging
}
}
Variables
{"project_id": 42, "asset_id": 42}
Response
{
"data": {
"AssetState": {
"current_asset_status_id": "string",
"current_asset_status_name": "string",
"calculated_asset_status_id": "string",
"calculated_asset_status_name": "string",
"live_remote_asset_id": "string",
"live_remote_asset_status_name": "string",
"live_remote_asset_status_description": "string",
"is_live_remote_asset_source_video_encoding": true,
"is_live_remote_asset_encoded_video_packaging": true
}
}
}
AuthenticationStatus
Description
Query authentication status
Response
Returns a Boolean
Example
Query
query AuthenticationStatus {
AuthenticationStatus
}
Response
{"data": {"AuthenticationStatus": true}}
Category
Response
Returns an AdminCategory
Example
Query
query Category(
$id: Int,
$locale: String
) {
Category(
id: $id,
locale: $locale
) {
id
project_id
name
url_slug
full_url_slug
canonical_url
type
metas {
...AdminCategoryMetaFragment
}
articles {
...AdminArticleFragment
}
products {
...AdminProductFragment
}
featured_articles {
...AdminArticleFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
videos {
...FileFragment
}
parent_id
child_metas
created_at
updated_at
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
posters {
...FileFragment
}
files {
...FileFragment
}
visibility
status
}
}
Variables
{"id": 42, "locale": "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": [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"
}
}
}
CategoryList
Response
Returns an AdminCategoriesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
parent_id - Int
|
|
parent_ids - [Int]
|
|
category_ids - [Int]
|
The category ids to be fetched |
type - CategoryTypeEnum
|
Category type |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
list_filter - CategoryListFilterTypeEnum
|
Category list filter type |
project_id - Int
|
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,
$project_id: Int
) {
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,
project_id: $project_id
) {
items {
...AdminCategoryFragment
}
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",
"project_id": 42
}
Response
{
"data": {
"CategoryList": {
"items": [AdminCategory],
"pagination": Pagination
}
}
}
Client
Description
Query details of given client
Response
Returns an AdminClient
Example
Query
query Client(
$project_id: Int,
$id: Int,
$password_current: String
) {
Client(
project_id: $project_id,
id: $id,
password_current: $password_current
) {
id
project_id
name
remote_callback_url
remote_callback_crm_contexts
redirect_uris
service_type
is_configurable
authorization_url
token_url
refresh_token_url
user_info_url
scope
client_id
client_secret
}
}
Variables
{
"project_id": 42,
"id": 42,
"password_current": "string"
}
Response
{
"data": {
"Client": {
"id": 42,
"project_id": 42,
"name": "string",
"remote_callback_url": "https://url.example.com",
"remote_callback_crm_contexts": ["user_article"],
"redirect_uris": ["string"],
"service_type": "external_admin",
"is_configurable": true,
"authorization_url": "https://url.example.com",
"token_url": "https://url.example.com",
"refresh_token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"scope": "string",
"client_id": "string",
"client_secret": "string"
}
}
}
ClientList
Response
Returns an AdminClientsListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "key", "platform_context", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query ClientList(
$project_id: Int,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
ClientList(
project_id: $project_id,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminClientListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"ClientList": {
"items": [AdminClientListed],
"pagination": Pagination
}
}
}
Config
Description
Query configuration for admin scope
Response
Returns an AdminConfig
Arguments
| Name | Description |
|---|---|
project_id - Int
|
Example
Query
query Config($project_id: Int) {
Config(project_id: $project_id) {
system_language_tags {
...SystemLanguageTagFragment
}
language_tag_contexts {
...LanguageTagContextFragment
}
locales {
...StructureKeyValueStringPairFragment
}
project {
...AdminConfigProjectFragment
}
roles {
...RoleFragment
}
platform_style_font_families
platform_style_font_allowed_families
resource_map {
...AdminResourceMapFragment
}
type_descendants {
...StructureKeyValueStringArrayPairFragment
}
type_children {
...StructureKeyValueStringArrayPairFragment
}
telemetry_platforms
article_asset_linked_types
article_types
article_discoverability_types
article_metadata_keys
asset_status_types
category_types
category_article_taggable_types
category_product_taggable_types
logic_operators
metric_types
metric_action_types
metric_condition_types
notification_types
notification_delivery_types
notification_topic_types
notification_channel_context_types
page_types
page_component_types
page_component_element_types
payment_syndicate_voucher_types
payment_syndicate_voucher_discount_types
payment_syndicate_voucher_installment_types
payment_syndicate_voucher_user_subscription_status_actions
payment_currency_types {
...StructureKeyValueStringPairFragment
}
product_types
product_recurring_types
product_non_recurring_types
product_status_types
product_discoverability_types
analytics_search_tag_types
subscription_types
subscription_status_types
subscription_entitlement_scope_types
subscription_time_unit_types
subscription_discoverability_types
user_status_types
user_gender_types
user_consent_types
user_notifiable_types
user_phone_status_types
user_subscription_status_types
user_payment_credit_types
role_types
system_notification_message
system_notification_message_ttl
}
}
Variables
{"project_id": 42}
Response
{
"data": {
"Config": {
"system_language_tags": [SystemLanguageTag],
"language_tag_contexts": [LanguageTagContext],
"locales": [StructureKeyValueStringPair],
"project": AdminConfigProject,
"roles": [Role],
"platform_style_font_families": [
"string"
],
"platform_style_font_allowed_families": [
"string"
],
"resource_map": AdminResourceMap,
"type_descendants": [
StructureKeyValueStringArrayPair
],
"type_children": [StructureKeyValueStringArrayPair],
"telemetry_platforms": ["string"],
"article_asset_linked_types": ["film"],
"article_types": ["string"],
"article_discoverability_types": [
"string"
],
"article_metadata_keys": ["string"],
"asset_status_types": ["string"],
"category_types": ["string"],
"category_article_taggable_types": [
"string"
],
"category_product_taggable_types": [
"string"
],
"logic_operators": ["string"],
"metric_types": ["string"],
"metric_action_types": ["string"],
"metric_condition_types": ["string"],
"notification_types": ["string"],
"notification_delivery_types": [
"string"
],
"notification_topic_types": [
"string"
],
"notification_channel_context_types": [
"string"
],
"page_types": ["string"],
"page_component_types": ["string"],
"page_component_element_types": [
"string"
],
"payment_syndicate_voucher_types": [
"string"
],
"payment_syndicate_voucher_discount_types": [
"string"
],
"payment_syndicate_voucher_installment_types": [
"string"
],
"payment_syndicate_voucher_user_subscription_status_actions": ["string"],
"payment_currency_types": ["EUR"],
"product_types": ["string"],
"product_recurring_types": ["string"],
"product_non_recurring_types": [
"string"
],
"product_status_types": ["string"],
"product_discoverability_types": [
"string"
],
"analytics_search_tag_types": [
"string"
],
"subscription_types": ["string"],
"subscription_status_types": ["string"],
"subscription_entitlement_scope_types": [
"string"
],
"subscription_time_unit_types": [
"string"
],
"subscription_discoverability_types": [
"string"
],
"user_status_types": ["string"],
"user_gender_types": ["string"],
"user_consent_types": ["string"],
"user_notifiable_types": ["string"],
"user_phone_status_types": ["string"],
"user_subscription_status_types": ["string"],
"user_payment_credit_types": [
"string"
],
"role_types": ["string"],
"system_notification_message": "string",
"system_notification_message_ttl": 42
}
}
}
File
Description
Query file
Example
Query
query File(
$id: Int,
$locale: String
) {
File(
id: $id,
locale: $locale
) {
id
name
title
type
size
width
height
aspect_ratio_profile
duration
locale
locale_label
base_url
base_path
url
proxy_file_path
proxy_url
file_name
file_path
title_translations {
...TranslationFragment
}
origin_url
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"File": {
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string",
"title_translations": [Translation],
"origin_url": "https://url.example.com"
}
}
}
GeoRegionList
Response
Returns a GeoRegionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "code", "is_country", "name" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query GeoRegionList(
$search: String,
$locale: String,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
GeoRegionList(
search: $search,
locale: $locale,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...GeoRegionListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"GeoRegionList": {
"items": [GeoRegionListed],
"pagination": Pagination
}
}
}
LanguageTagList
Response
Returns an AdminLanguageTagsListedWithPagination
Arguments
| Name | Description |
|---|---|
platform_context - PlatformContextEnum
|
|
language_tag_context - LanguageTagContextEnum
|
|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "key", "platform_context", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query LanguageTagList(
$platform_context: PlatformContextEnum,
$language_tag_context: LanguageTagContextEnum,
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
LanguageTagList(
platform_context: $platform_context,
language_tag_context: $language_tag_context,
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminLanguageTagFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"platform_context": "web",
"language_tag_context": "language_tag_context_login_create_account",
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"LanguageTagList": {
"items": [AdminLanguageTag],
"pagination": Pagination
}
}
}
LocaleRegionList
Response
Returns a LocaleRegionsListedWithPagination
Example
Query
query LocaleRegionList(
$search: String,
$project_id: Int
) {
LocaleRegionList(
search: $search,
project_id: $project_id
) {
items {
...LocaleRegionListedFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"search": "string", "project_id": 42}
Response
{
"data": {
"LocaleRegionList": {
"items": [LocaleRegionListed],
"pagination": Pagination
}
}
}
MailTemplate
Description
Query mail template
Response
Returns an AdminMailTemplate
Example
Query
query MailTemplate(
$id: Int,
$locale: String
) {
MailTemplate(
id: $id,
locale: $locale
) {
id
project_id
name
subject
content
subject_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
status
created_at
updated_at
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"MailTemplate": {
"id": 42,
"project_id": 42,
"name": "string",
"subject": "string",
"content": "string",
"subject_translations": [Translation],
"content_translations": [Translation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File],
"status": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
}
}
MailTemplateList
Response
Returns an AdminMailTemplatesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "subject", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query MailTemplateList(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
MailTemplateList(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminMailTemplateFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"MailTemplateList": {
"items": [AdminMailTemplate],
"pagination": Pagination
}
}
}
Menu
Description
Query menu details
Example
Query
query Menu(
$id: Int,
$locale: String
) {
Menu(
id: $id,
locale: $locale
) {
id
project_id
name
platform_contexts
locale_regions {
...LocaleRegionFragment
}
geo_regions {
...GeoRegionFragment
}
components {
...AdminMenuComponentFragment
}
visibility
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
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": [AdminMenuComponent],
"visibility": "everyone",
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MenuComponent
Description
Query menu component details
Response
Returns an AdminMenuComponent
Example
Query
query MenuComponent(
$id: Int,
$locale: String
) {
MenuComponent(
id: $id,
locale: $locale
) {
id
parent_id
menu_id
page_id
page_full_url_slug
type
title
content
url
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
page {
...AdminPageFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"MenuComponent": {
"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],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"page": AdminPage,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MenuComponentList
Response
Returns an AdminMenuComponentsListedWithPagination
Example
Query
query MenuComponentList(
$locale: String,
$limit: Int,
$offset: Int,
$menu_id: Int
) {
MenuComponentList(
locale: $locale,
limit: $limit,
offset: $offset,
menu_id: $menu_id
) {
items {
...AdminMenuComponentFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"locale": "string",
"limit": 42,
"offset": 42,
"menu_id": 42
}
Response
{
"data": {
"MenuComponentList": {
"items": [AdminMenuComponent],
"pagination": Pagination
}
}
}
MenuList
Response
Returns an AdminMenusListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
project_id - Int
|
|
platform_context - PlatformContextEnum
|
Example
Query
query MenuList(
$locale: String,
$limit: Int,
$offset: Int,
$project_id: Int,
$platform_context: PlatformContextEnum
) {
MenuList(
locale: $locale,
limit: $limit,
offset: $offset,
project_id: $project_id,
platform_context: $platform_context
) {
items {
...AdminMenuFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"locale": "string",
"limit": 42,
"offset": 42,
"project_id": 42,
"platform_context": "web"
}
Response
{
"data": {
"MenuList": {
"items": [AdminMenu],
"pagination": Pagination
}
}
}
Metric
Description
Query metric
Response
Returns an AdminMetric
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query Metric($id: Int) {
Metric(id: $id) {
id
project_id
name
description
time_window
type
published_from
published_until
created_at
updated_at
status
conditions {
...AdminMetricConditionFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
products {
...AdminProductFragment
}
subscriptions {
...AdminSubscriptionFragment
}
eligible_users {
...AdminUserFragment
}
metric_actions {
...AdminMetricActionFragment
}
}
}
Variables
{"id": 42}
Response
{
"data": {
"Metric": {
"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]
}
}
}
MetricAction
Description
Query metricAction
Response
Returns an AdminMetricAction
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query MetricAction($id: Int) {
MetricAction(id: $id) {
id
project_id
name
title
content
icons {
...FileFragment
}
images {
...FileFragment
}
files {
...FileFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
type
status
webhook_url
user_subscription_installment_num
user_subscription_installment_time_unit
created_at
updated_at
products {
...AdminProductListedAsRelationFragment
}
eligible_users {
...AdminUserFragment
}
metrics {
...AdminMetricFragment
}
}
}
Variables
{"id": 42}
Response
{
"data": {
"MetricAction": {
"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]
}
}
}
MetricActionList
Description
Query list of metricActions with pagination
Response
Returns an AdminMetricActionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query MetricActionList(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
MetricActionList(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminMetricActionFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"MetricActionList": {
"items": [AdminMetricAction],
"pagination": Pagination
}
}
}
MetricList
Description
Query list of metrics with pagination
Response
Returns an AdminMetricsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "published_from", "published_until", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query MetricList(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
MetricList(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminMetricFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"MetricList": {
"items": [AdminMetric],
"pagination": Pagination
}
}
}
Notification
Description
Query notification
Response
Returns an AdminNotification
Example
Query
query Notification(
$id: Int,
$locale: String
) {
Notification(
id: $id,
locale: $locale
) {
id
project_id
parent_id
name
title
content
url
delivery_type
type
notification_channel_contexts
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
children {
...AdminNotificationFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
frequency
time_unit
status
schedule_at
delivered_at
created_at
updated_at
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"Notification": {
"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"
}
}
}
NotificationList
Description
Query list of notifications with pagination
Response
Returns an AdminNotificationsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
parent_id - Int
|
|
parent_ids - [Int]
|
|
ancestor_id - Int
|
The notification ancestor id the notification is a descendant of |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "schedule_at", "delivered_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query NotificationList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$parent_id: Int,
$parent_ids: [Int],
$ancestor_id: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
NotificationList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
parent_id: $parent_id,
parent_ids: $parent_ids,
ancestor_id: $ancestor_id,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminNotificationFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"parent_id": 42,
"parent_ids": [42],
"ancestor_id": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"NotificationList": {
"items": [AdminNotification],
"pagination": Pagination
}
}
}
NotificationTopic
Description
Query notification topic
Response
Returns an AdminNotificationTopic
Example
Query
query NotificationTopic(
$id: Int,
$locale: String
) {
NotificationTopic(
id: $id,
locale: $locale
) {
id
remote_notification_topic_id
project_id
name
title
description
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
notifications {
...AdminNotificationFragment
}
type
status
created_at
updated_at
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"NotificationTopic": {
"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"
}
}
}
NotificationTopicList
Description
Query list of notification topics with pagination
Response
Returns an AdminNotificationTopicsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query NotificationTopicList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
NotificationTopicList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminNotificationTopicFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"NotificationTopicList": {
"items": [AdminNotificationTopic],
"pagination": Pagination
}
}
}
OauthProvider
Response
Returns an AdminOauthProvider
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query OauthProvider($id: Int) {
OauthProvider(id: $id) {
id
project_id
call_to_action_tag
name
call_to_action_tag_translations {
...TranslationFragment
}
is_auto_create_user
allowed_origin_domains
client_id
client_secret
redirect_url
status
type
scopes
scope_separator
auth_url
token_url
user_info_url
email_info_url
user_map
custom_data
created_at
updated_at
files {
...FileFragment
}
icons {
...FileFragment
}
}
}
Variables
{"id": 42}
Response
{
"data": {
"OauthProvider": {
"id": 42,
"project_id": 42,
"call_to_action_tag": "string",
"name": "string",
"call_to_action_tag_translations": [Translation],
"is_auto_create_user": true,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"redirect_url": "https://url.example.com",
"status": "string",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "https://url.example.com",
"token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"email_info_url": "foo@example.com",
"user_map": "string",
"custom_data": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"files": [File],
"icons": [File]
}
}
}
OauthProviderList
Response
Returns an AdminOauthProvidersListedWithPagination
Example
Query
query OauthProviderList(
$limit: Int,
$offset: Int,
$project_id: Int
) {
OauthProviderList(
limit: $limit,
offset: $offset,
project_id: $project_id
) {
items {
...AdminOauthProviderFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{"limit": 42, "offset": 42, "project_id": 42}
Response
{
"data": {
"OauthProviderList": {
"items": [AdminOauthProvider],
"pagination": Pagination
}
}
}
Page
Description
Query page details
Response
Returns an AdminPage
Example
Query
query Page(
$id: Int,
$locale: String
) {
Page(
id: $id,
locale: $locale
) {
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 {
...AdminPageMetaFragment
}
components {
...AdminPageComponentFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
visibility
status
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
title_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{"id": 42, "locale": "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": [AdminPageMeta],
"components": [AdminPageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"visibility": "everyone",
"status": "string",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"title_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponent
Description
Query page component details
Response
Returns an AdminPageComponent
Example
Query
query PageComponent(
$id: Int,
$locale: String
) {
PageComponent(
id: $id,
locale: $locale
) {
id
page_id
parent_id
category_id
title
content
url
value
style_type
display_type
type
elements {
...AdminPageComponentElementFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"PageComponent": {
"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": [AdminPageComponentElement],
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentElement
Description
Query page component details
Response
Returns an AdminPageComponentElement
Example
Query
query PageComponentElement(
$id: Int,
$locale: String
) {
PageComponentElement(
id: $id,
locale: $locale
) {
id
page_component_id
parent_id
type
title
content
label
url
value
toggle
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
label_translations {
...TranslationFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"PageComponentElement": {
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"label_translations": [Translation],
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentElementList
Response
Arguments
| Name | Description |
|---|---|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
page_component_id - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query PageComponentElementList(
$locale: String,
$limit: Int,
$offset: Int,
$page_component_id: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
PageComponentElementList(
locale: $locale,
limit: $limit,
offset: $offset,
page_component_id: $page_component_id,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminPageComponentElementFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"locale": "string",
"limit": 42,
"offset": 42,
"page_component_id": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"PageComponentElementList": {
"items": [AdminPageComponentElement],
"pagination": Pagination
}
}
}
PageComponentList
Response
Returns an AdminPageComponentsListedWithPagination
Arguments
| Name | Description |
|---|---|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
page_id - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "created_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
Example
Query
query PageComponentList(
$locale: String,
$limit: Int,
$offset: Int,
$page_id: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
PageComponentList(
locale: $locale,
limit: $limit,
offset: $offset,
page_id: $page_id,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminPageComponentFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"locale": "string",
"limit": 42,
"offset": 42,
"page_id": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"PageComponentList": {
"items": [AdminPageComponent],
"pagination": Pagination
}
}
}
PageList
Response
Returns an AdminPagesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
parent_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
|
platform_context - PlatformContextEnum
|
Example
Query
query PageList(
$search: String,
$locale: String,
$parent_id: Int,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int,
$platform_context: PlatformContextEnum
) {
PageList(
search: $search,
locale: $locale,
parent_id: $parent_id,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id,
platform_context: $platform_context
) {
items {
...AdminPageFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"parent_id": 42,
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42,
"platform_context": "web"
}
Response
{
"data": {
"PageList": {
"items": [AdminPage],
"pagination": Pagination
}
}
}
PaymentProvider
Response
Returns an AdminPaymentProvider
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query PaymentProvider($id: Int) {
PaymentProvider(id: $id) {
id
project_id
name
description
type
status
device_capability
order_description_template
recurring_order_description_template
collection_window_day_num
amount_payment_method_change
default_currency
default_currency_symbol
status_message
connect_status
connect_status_message
remote_profile_status
remote_profile_status_message
is_configurable
is_support_connect_flow
remote_account {
...AdminPaymentProviderRemoteAccountFragment
}
remote_profile_id
remote_organisation_id
}
}
Variables
{"id": 42}
Response
{
"data": {
"PaymentProvider": {
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42,
"order_description_template": "string",
"recurring_order_description_template": "string",
"collection_window_day_num": 42,
"amount_payment_method_change": 987.65,
"default_currency": "EUR",
"default_currency_symbol": "EUR",
"status_message": "string",
"connect_status": "string",
"connect_status_message": "string",
"remote_profile_status": "string",
"remote_profile_status_message": "string",
"is_configurable": true,
"is_support_connect_flow": true,
"remote_account": AdminPaymentProviderRemoteAccount,
"remote_profile_id": "string",
"remote_organisation_id": "string"
}
}
}
PaymentProviderList
Response
Returns an AdminPaymentProvidersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s). |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query PaymentProviderList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
PaymentProviderList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminPaymentProviderFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"PaymentProviderList": {
"items": [AdminPaymentProvider],
"pagination": Pagination
}
}
}
PaymentSyndicate
Description
Query syndicate details
Response
Returns an AdminPaymentSyndicate
Example
Query
query PaymentSyndicate(
$id: Int,
$locale: String
) {
PaymentSyndicate(
id: $id,
locale: $locale
) {
id
project_id
name
type
created_at
updated_at
vouchers {
...AdminPaymentSyndicateVoucherFragment
}
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"PaymentSyndicate": {
"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]
}
}
}
PaymentSyndicateList
Response
Returns an AdminPaymentSyndicatesListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "created_at", "updated_at" |
project_id - Int
|
Example
Query
query PaymentSyndicateList(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$project_id: Int
) {
PaymentSyndicateList(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
project_id: $project_id
) {
items {
...AdminPaymentSyndicateFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"project_id": 42
}
Response
{
"data": {
"PaymentSyndicateList": {
"items": [AdminPaymentSyndicate],
"pagination": Pagination
}
}
}
PaymentSyndicateVoucher
Description
Query voucher details
Response
Returns an AdminPaymentSyndicateVoucher
Example
Query
query PaymentSyndicateVoucher(
$id: Int,
$locale: String
) {
PaymentSyndicateVoucher(
id: $id,
locale: $locale
) {
id
project_id
description
name
payment_syndicate_id
subscription_id
description_translations {
...TranslationFragment
}
currency
currency_symbol
amount
installment_num
max_claimed_num
max_claimed_per_user_num
claimed_num
is_allow_on_valid_subscription
user_subscription_status_action
newsletter_list_id
time_unit
discount_type
installment_type
type
issue_installments_until
installed_at
expires_at
created_at
updated_at
syndicate {
...AdminPaymentSyndicateFragment
}
batches {
...AdminPaymentSyndicateVoucherCodeBatchFragment
}
scoped_products {
...AdminProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
subscription {
...AdminSubscriptionFragment
}
eligible_email_addresses
}
}
Variables
{"id": 42, "locale": "string"}
Response
{
"data": {
"PaymentSyndicateVoucher": {
"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"]
}
}
}
PaymentSyndicateVoucherList
Response
Returns an AdminPaymentSyndicateVouchersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "installed_at", "expires_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query PaymentSyndicateVoucherList(
$search: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
PaymentSyndicateVoucherList(
search: $search,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminPaymentSyndicateVoucherFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"PaymentSyndicateVoucherList": {
"items": [AdminPaymentSyndicateVoucher],
"pagination": Pagination
}
}
}
Product
Description
Query product
Response
Returns an AdminProduct
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 {
...AdminArticleFragment
}
categories {
...CategoryListedAsRelationFragment
}
period_renewal_day
is_sync_installments
frequency
time_unit
recurring_entitlement_expires_in_time_unit_midnight_offset
recurring_entitlement_expires_in_time_unit_num
recurring_entitlement_expires_in
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
call_to_action_tag_translations {
...TranslationFragment
}
discoverability
status
published_from
published_until
newsletter_list_id
issuable_vouchers {
...AdminPaymentSyndicateVoucherFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
files {
...FileFragment
}
}
}
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": [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]
}
}
}
ProductList
Response
Returns an AdminProductsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
category_id - Int
|
The category id the product belongs to |
type - ProductTypeEnum
|
|
types - [ProductTypeEnum]
|
The types to filter resources on (filter type: "where in") |
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "status", "expires_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
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],
$project_id: Int
) {
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,
project_id: $project_id
) {
items {
...AdminProductFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"category_id": 42,
"type": "article",
"types": ["article"],
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"ProductList": {
"items": [AdminProduct],
"pagination": Pagination
}
}
}
ProjectConfig
Description
Query projectConfig
Response
Returns an AdminProjectConfig
Example
Query
query ProjectConfig(
$project_id: Int,
$id: Int,
$password_current: String
) {
ProjectConfig(
project_id: $project_id,
id: $id,
password_current: $password_current
) {
id
project_id
key
value
default_value
label
type
is_read_only
is_auth_only
related_file_type
created_at
updated_at
}
}
Variables
{
"project_id": 42,
"id": 42,
"password_current": "string"
}
Response
{
"data": {
"ProjectConfig": {
"id": 42,
"project_id": 42,
"key": "string",
"value": "string",
"default_value": "string",
"label": "string",
"type": "string",
"is_read_only": false,
"is_auth_only": true,
"related_file_type": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
}
}
ProjectConfigList
Description
Query list of project configs with pagination
Response
Returns an AdminProjectConfigsListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
search - String
|
|
type - ProjectConfigTypeEnum
|
|
project_config_context - ProjectConfigContextEnum
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "key", "value", "type", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
password_current - String
|
Example
Query
query ProjectConfigList(
$project_id: Int,
$search: String,
$type: ProjectConfigTypeEnum,
$project_config_context: ProjectConfigContextEnum,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$password_current: String
) {
ProjectConfigList(
project_id: $project_id,
search: $search,
type: $type,
project_config_context: $project_config_context,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
password_current: $password_current
) {
items {
...AdminProjectConfigFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"search": "string",
"type": "array",
"project_config_context": "branding_web_custom_css",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"password_current": "string"
}
Response
{
"data": {
"ProjectConfigList": {
"items": [AdminProjectConfig],
"pagination": Pagination
}
}
}
ProjectConfigListValidate
Description
Query projectConfig
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
project_config_context - ProjectConfigContextEnum
|
|
items - [ProjectConfigInput]
|
Example
Query
query ProjectConfigListValidate(
$project_id: Int,
$project_config_context: ProjectConfigContextEnum,
$items: [ProjectConfigInput]
) {
ProjectConfigListValidate(
project_id: $project_id,
project_config_context: $project_config_context,
items: $items
)
}
Variables
{
"project_id": 42,
"project_config_context": "branding_web_custom_css",
"items": [ProjectConfigInput]
}
Response
{"data": {"ProjectConfigListValidate": false}}
RemoteAssetFileList
Description
Query list of remote asset files provided by the MediaProvider.
Response
Returns an AdminRemoteAssetFilesWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
The project id. |
limit - Int
|
The pagination limit. |
offset - Int
|
The pagination offset. |
context - RemoteAssetFileContextEnum
|
The remote file context (default "bulk_upload"). |
sort_by - [SortByInput]
|
Sort and order by field(s): "file", "file_id", "file_size", "file_extension", "created_at" |
Example
Query
query RemoteAssetFileList(
$project_id: Int,
$limit: Int,
$offset: Int,
$context: RemoteAssetFileContextEnum,
$sort_by: [SortByInput]
) {
RemoteAssetFileList(
project_id: $project_id,
limit: $limit,
offset: $offset,
context: $context,
sort_by: $sort_by
) {
items {
...AdminRemoteAssetFileFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"limit": 42,
"offset": 42,
"context": "bulk_upload",
"sort_by": [SortByInput]
}
Response
{
"data": {
"RemoteAssetFileList": {
"items": [AdminRemoteAssetFile],
"pagination": Pagination
}
}
}
Subscription
Description
Query subscription
Response
Returns an AdminSubscription
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 {
...AdminPaymentProviderListedAsRelationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
created_at
updated_at
user_subscription_status_action
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
discoverability
status
products {
...AdminProductListedAsRelationFragment
}
entitleable_articles {
...ArticleListedAsRelationFragment
}
files {
...FileFragment
}
}
}
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": [
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]
}
}
}
SubscriptionList
Response
Returns an AdminSubscriptionsListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
type - SubscriptionTypeEnum
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "type", "price_per_installment", "time_unit", "position", "status", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
Example
Query
query SubscriptionList(
$search: String,
$type: SubscriptionTypeEnum,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int
) {
SubscriptionList(
search: $search,
type: $type,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id
) {
items {
...AdminSubscriptionFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"type": "svod",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42
}
Response
{
"data": {
"SubscriptionList": {
"items": [AdminSubscription],
"pagination": Pagination
}
}
}
TelemetryGeoRegionSessionDay
Description
Telemetry on daily geo region viewing sessions
Response
Returns an AdminTelemetryGeoRegionSessionDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
is_group_by_geo_region_code - Boolean
|
Group the result by geo region within given date range. If set, the returned row properties "observed_at" and "julian_day" are lost. Default = true |
Example
Query
query TelemetryGeoRegionSessionDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$is_group_by_geo_region_code: Boolean
) {
TelemetryGeoRegionSessionDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
is_group_by_geo_region_code: $is_group_by_geo_region_code
) {
items {
...AdminTelemetryGeoRegionSessionDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true,
"is_group_by_geo_region_code": true
}
Response
{
"data": {
"TelemetryGeoRegionSessionDay": {
"items": [AdminTelemetryGeoRegionSessionDay],
"pagination": Pagination
}
}
}
TelemetryPaymentSyndicateVoucherDay
Description
Telemetry on daily payment syndicate vouchers mutations
Response
Returns an AdminTelemetryPaymentSyndicateVoucherDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
payment_syndicate_voucher_id - Int
|
Default = 0 |
purchase_origin - UserPaymentAccountOrderPurchaseOriginEnum
|
Example
Query
query TelemetryPaymentSyndicateVoucherDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$payment_syndicate_voucher_id: Int,
$purchase_origin: UserPaymentAccountOrderPurchaseOriginEnum
) {
TelemetryPaymentSyndicateVoucherDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
payment_syndicate_voucher_id: $payment_syndicate_voucher_id,
purchase_origin: $purchase_origin
) {
items {
...AdminTelemetryPaymentSyndicateVoucherDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true,
"payment_syndicate_voucher_id": 0,
"purchase_origin": "currency"
}
Response
{
"data": {
"TelemetryPaymentSyndicateVoucherDay": {
"items": [AdminTelemetryPaymentSyndicateVoucherDay],
"pagination": Pagination
}
}
}
TelemetryPlatformSessionDay
Description
Telemetry on daily platform viewing sessions
Response
Returns an AdminTelemetryPlatformSessionDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
is_group_by_telemetry_platform - Boolean
|
Group the result by telemetry platform within given date range. If set, the returned row properties "observed_at" and "julian_day" are lost. Default = true |
Example
Query
query TelemetryPlatformSessionDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$is_group_by_telemetry_platform: Boolean
) {
TelemetryPlatformSessionDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
is_group_by_telemetry_platform: $is_group_by_telemetry_platform
) {
items {
...AdminTelemetryPlatformSessionDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true,
"is_group_by_telemetry_platform": true
}
Response
{
"data": {
"TelemetryPlatformSessionDay": {
"items": [AdminTelemetryPlatformSessionDay],
"pagination": Pagination
}
}
}
TelemetryRealTimeData
Description
Telemetry on actual real-time data
Response
Returns an AdminTelemetryRealTimeData
Example
Query
query TelemetryRealTimeData(
$project_id: Int,
$is_mock: Boolean
) {
TelemetryRealTimeData(
project_id: $project_id,
is_mock: $is_mock
) {
concurrent_stream_num
active_user_num
published_article_num
}
}
Variables
{"project_id": 42, "is_mock": false}
Response
{
"data": {
"TelemetryRealTimeData": {
"concurrent_stream_num": 42,
"active_user_num": 42,
"published_article_num": 42
}
}
}
TelemetrySearchTerms
Description
Telemetry on recent searched terms
Response
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
sort_by - [SortByInput]
|
Sort and order by field(s) |
search_tag - AnalyticsSearchTagTypeEnum
|
Example
Query
query TelemetrySearchTerms(
$project_id: Int,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$sort_by: [SortByInput],
$search_tag: AnalyticsSearchTagTypeEnum
) {
TelemetrySearchTerms(
project_id: $project_id,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
sort_by: $sort_by,
search_tag: $search_tag
) {
items {
...StructureKeyValueIntegerPairFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true,
"sort_by": [SortByInput],
"search_tag": "article"
}
Response
{
"data": {
"TelemetrySearchTerms": {
"items": [StructureKeyValueIntegerPair],
"pagination": Pagination
}
}
}
TelemetryUserActivityDay
Description
Telemetry on daily active users
Response
Returns an AdminTelemetryUserActivityDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
product_id - Int
|
Default = 0 |
purchase_origin - UserPaymentAccountOrderPurchaseOriginEnum
|
Example
Query
query TelemetryUserActivityDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$product_id: Int,
$purchase_origin: UserPaymentAccountOrderPurchaseOriginEnum
) {
TelemetryUserActivityDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
product_id: $product_id,
purchase_origin: $purchase_origin
) {
items {
...AdminTelemetryUserActivityDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true,
"product_id": 0,
"purchase_origin": "currency"
}
Response
{
"data": {
"TelemetryUserActivityDay": {
"items": [AdminTelemetryUserActivityDay],
"pagination": Pagination
}
}
}
TelemetryUserActivityMonth
Description
Telemetry on daily active users
Response
Returns an AdminTelemetryUserActivityMonthsListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
Start date (only year and month are used) |
end_date - String
|
End date (only year and month are used) |
date_range - DateRangeInput
|
Date range (only year and month values are used) |
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryUserActivityMonth(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryUserActivityMonth(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryUserActivityMonthFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryUserActivityMonth": {
"items": [AdminTelemetryUserActivityMonth],
"pagination": Pagination
}
}
}
TelemetryUserArticleViewTimeSessionDay
Description
Telemetry on daily user article view time consumption
Response
Returns an AdminTelemetryUserArticleViewTimeSessionDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
sort_by - [SortByInput]
|
Sort and order by field(s) |
entitlement_origin - ArticleEntitlementOriginEnum
|
The origin which entitled this play mutation (omit to select all). This can be a resource, like a "product" or a "subscription", or for example an authenticated "user" |
entitlement_resource_id - Int
|
The id of the resource ("product" or "subscription") that entitled this play mutation (omit or leave zero to select all) |
is_group_by_article_asset - Boolean
|
Group the result by Article and Assets within given date range. If set, the returned row properties "observed_at" and "julian_day" are lost. Default = true |
Example
Query
query TelemetryUserArticleViewTimeSessionDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$sort_by: [SortByInput],
$entitlement_origin: ArticleEntitlementOriginEnum,
$entitlement_resource_id: Int,
$is_group_by_article_asset: Boolean
) {
TelemetryUserArticleViewTimeSessionDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
sort_by: $sort_by,
entitlement_origin: $entitlement_origin,
entitlement_resource_id: $entitlement_resource_id,
is_group_by_article_asset: $is_group_by_article_asset
) {
items {
...AdminTelemetryUserArticleViewTimeSessionDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true,
"sort_by": [SortByInput],
"entitlement_origin": "subscription",
"entitlement_resource_id": 42,
"is_group_by_article_asset": true
}
Response
{
"data": {
"TelemetryUserArticleViewTimeSessionDay": {
"items": [
AdminTelemetryUserArticleViewTimeSessionDay
],
"pagination": Pagination
}
}
}
TelemetryUserPaymentOrderDay
Description
Telemetry on daily user payment order mutations
Response
Returns an AdminTelemetryUserPaymentOrderDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryUserPaymentOrderDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryUserPaymentOrderDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryUserPaymentOrderDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryUserPaymentOrderDay": {
"items": [AdminTelemetryUserPaymentOrderDay],
"pagination": Pagination
}
}
}
TelemetryUserProductDay
Description
Telemetry on daily user product mutations
Response
Returns an AdminTelemetryUserProductDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
product_id - Int
|
The product id for which to filter data (default 0, which aggregates over all products). |
purchase_origin - UserPaymentAccountOrderPurchaseOriginEnum
|
The purchase origin for which to filter data (default "0", which aggregates over all purchase origins). |
is_group_by_product_id - Boolean
|
Group the result by product id within given date range. If set, the returned row properties "purchase_origin", "observed_at" and "julian_day" are lost. |
Example
Query
query TelemetryUserProductDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$product_id: Int,
$purchase_origin: UserPaymentAccountOrderPurchaseOriginEnum,
$is_group_by_product_id: Boolean
) {
TelemetryUserProductDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
product_id: $product_id,
purchase_origin: $purchase_origin,
is_group_by_product_id: $is_group_by_product_id
) {
items {
...AdminTelemetryUserProductDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true,
"product_id": 42,
"purchase_origin": "currency",
"is_group_by_product_id": true
}
Response
{
"data": {
"TelemetryUserProductDay": {
"items": [AdminTelemetryUserProductDay],
"pagination": Pagination
}
}
}
TelemetryUserSubscriptionDay
Description
Telemetry on daily user subscription mutations
Response
Returns an AdminTelemetryUserSubscriptionDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
subscription_id - Int
|
The subscription id for which to filter data (default 0, which aggregates over all subscriptions). |
purchase_origin - UserPaymentAccountOrderPurchaseOriginEnum
|
The purchase origin for which to filter data (default "0", which aggregates over all purchase origins). |
is_group_by_subscription_id - Boolean
|
Group the result by subscription id within given date range. If set, the returned row properties "aggregate", "purchase_origin", "observed_at" and "julian_day" are lost. |
Example
Query
query TelemetryUserSubscriptionDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean,
$subscription_id: Int,
$purchase_origin: UserPaymentAccountOrderPurchaseOriginEnum,
$is_group_by_subscription_id: Boolean
) {
TelemetryUserSubscriptionDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock,
subscription_id: $subscription_id,
purchase_origin: $purchase_origin,
is_group_by_subscription_id: $is_group_by_subscription_id
) {
items {
...AdminTelemetryUserSubscriptionDayFragment
}
aggregate {
...AdminTelemetryUserSubscriptionDayAggregateFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true,
"subscription_id": 42,
"purchase_origin": "currency",
"is_group_by_subscription_id": true
}
Response
{
"data": {
"TelemetryUserSubscriptionDay": {
"items": [AdminTelemetryUserSubscriptionDay],
"aggregate": AdminTelemetryUserSubscriptionDayAggregate,
"pagination": Pagination
}
}
}
TelemetryVodEncodingDay
Description
Telemetry on daily VOD encoding
Response
Returns an AdminTelemetryVodEncodingDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodEncodingDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodEncodingDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodEncodingDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodEncodingDay": {
"items": [AdminTelemetryVodEncodingDay],
"pagination": Pagination
}
}
}
TelemetryVodStorageDay
Description
Telemetry on daily VOD streaming
Response
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodStorageDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodStorageDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodStorageDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodStorageDay": {
"items": [AdminTelemetryVodStorageDay],
"pagination": Pagination
}
}
}
TelemetryVodStreamingDay
Description
Telemetry on daily VOD streaming
Response
Returns an AdminTelemetryVodStreamingDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodStreamingDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodStreamingDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodStreamingDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodStreamingDay": {
"items": [AdminTelemetryVodStreamingDay],
"pagination": Pagination
}
}
}
TelemetryVodStreamingMinute
Description
Telemetry on daily VOD streaming
Response
Returns an AdminTelemetryVodStreamingMinutesListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodStreamingMinute(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodStreamingMinute(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodStreamingMinuteFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodStreamingMinute": {
"items": [AdminTelemetryVodStreamingMinute],
"pagination": Pagination
}
}
}
TelemetryVodStreamingUnitDay
Description
Telemetry on daily VOD streaming
Response
Returns an AdminTelemetryVodStreamingUnitDaysListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodStreamingUnitDay(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodStreamingUnitDay(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodStreamingUnitDayFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": false,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodStreamingUnitDay": {
"items": [AdminTelemetryVodStreamingUnitDay],
"pagination": Pagination
}
}
}
TelemetryVodStreamingUnitMinute
Description
Telemetry on daily VOD streaming
Response
Returns an AdminTelemetryVodStreamingUnitMinutesListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
start_date - String
|
|
end_date - String
|
|
date_range - DateRangeInput
|
|
limit - Int
|
|
offset - Int
|
|
is_normalise - Boolean
|
Normalise telemetry data by creating a continuous timeline with "zero" values where necessary, pagination data is lost. |
is_mock - Boolean
|
Fill telemetry response with mock data. Default = true |
Example
Query
query TelemetryVodStreamingUnitMinute(
$project_id: Int,
$start_date: String,
$end_date: String,
$date_range: DateRangeInput,
$limit: Int,
$offset: Int,
$is_normalise: Boolean,
$is_mock: Boolean
) {
TelemetryVodStreamingUnitMinute(
project_id: $project_id,
start_date: $start_date,
end_date: $end_date,
date_range: $date_range,
limit: $limit,
offset: $offset,
is_normalise: $is_normalise,
is_mock: $is_mock
) {
items {
...AdminTelemetryVodStreamingUnitMinuteFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"start_date": "string",
"end_date": "string",
"date_range": DateRangeInput,
"limit": 42,
"offset": 42,
"is_normalise": true,
"is_mock": true
}
Response
{
"data": {
"TelemetryVodStreamingUnitMinute": {
"items": [AdminTelemetryVodStreamingUnitMinute],
"pagination": Pagination
}
}
}
User
Description
Query user details of given user
Response
Returns an AdminUser
Arguments
| Name | Description |
|---|---|
currency - PaymentProviderCurrencyEnum
|
The desired currency on which to base displayed properties such as "user_payment_currency" and "user_payment_currency_symbol" |
id - Int
|
|
is_administrator - Boolean
|
Update an admin user |
Example
Query
query User(
$currency: PaymentProviderCurrencyEnum,
$id: Int,
$is_administrator: Boolean
) {
User(
currency: $currency,
id: $id,
is_administrator: $is_administrator
) {
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
{"currency": "CREDIT", "id": 42, "is_administrator": true}
Response
{
"data": {
"User": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": false,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [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]
}
}
}
UserArticleList
Description
Query the list of UserArticle records, which represent the nomadic state per User, per Article, per Asset
Response
Returns an AdminUserArticlesListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "user_id", "article_id", "asset_id", "device_type", "entitlement_origin", "entitlement_resource_id", "is_favourite", "is_continue", "rating_value", "is_progress_marker1_completed", "is_progress_marker2_completed", "is_progress_marker3_completed", "completed_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s). Allowed fields: "id", "user_id", "article_id", "asset_id", "device_type", "entitlement_origin", "entitlement_resource_id", "is_favourite", "is_continue", "rating_value", "is_progress_marker1_completed", "is_progress_marker2_completed", "is_progress_marker3_completed", "completed_at", "created_at", "updated_at" |
Example
Query
query UserArticleList(
$project_id: Int,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
UserArticleList(
project_id: $project_id,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminUserArticleFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"UserArticleList": {
"items": [AdminUserArticle],
"pagination": Pagination
}
}
}
UserArticleSessionList
Description
Query the list of UserArticleSession records, which represent the nomadic state per User, per Article, per Asset
Response
Returns an AdminUserArticleSessionsListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "user_id", "article_id", "asset_id", "device_type", "telemetry_platform", "started_at", "completed_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s). Allowed fields: "id", "user_id", "article_id", "asset_id", "device_type", "telemetry_platform", "started_at", "completed_at", "created_at", "updated_at" |
Example
Query
query UserArticleSessionList(
$project_id: Int,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput]
) {
UserArticleSessionList(
project_id: $project_id,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by
) {
items {
...AdminUserArticleSessionFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput]
}
Response
{
"data": {
"UserArticleSessionList": {
"items": [AdminUserArticleSession],
"pagination": Pagination
}
}
}
UserDetails
Description
Query user details of current authenticated user
Response
Returns an AdminUserDetails
Example
Query
query UserDetails {
UserDetails {
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
metas {
...AdminUserMetaFragment
}
managed_projects {
...AdminProjectFragment
}
managed_roles {
...RoleFragment
}
recent_project {
...AdminProjectFragment
}
roles {
...RoleFragment
}
}
}
Response
{
"data": {
"UserDetails": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 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",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"managed_roles": [Role],
"recent_project": AdminProject,
"roles": [Role]
}
}
}
UserList
Description
Query list of users with pagination
Response
Returns an AdminUsersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
user_ids - [Int]
|
The user ids to be fetched |
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "name", "email", "active_at", "created_at", "updated_at", "subscription_id", "user_subscription_status", "user_subscription_last_event_type" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
|
roles - [Int]
|
The roles to be filtered on (OR query) |
is_administrator - Boolean
|
Filter on admin users only |
user_subscription_status - UserSubscriptionStatusEnum
|
Example
Query
query UserList(
$search: String,
$locale: String,
$limit: Int,
$offset: Int,
$user_ids: [Int],
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int,
$roles: [Int],
$is_administrator: Boolean,
$user_subscription_status: UserSubscriptionStatusEnum
) {
UserList(
search: $search,
locale: $locale,
limit: $limit,
offset: $offset,
user_ids: $user_ids,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id,
roles: $roles,
is_administrator: $is_administrator,
user_subscription_status: $user_subscription_status
) {
items {
...AdminUserFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"locale": "string",
"limit": 42,
"offset": 42,
"user_ids": [42],
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42,
"roles": [42],
"is_administrator": true,
"user_subscription_status": "initialised"
}
Response
{
"data": {
"UserList": {
"items": [AdminUser],
"pagination": Pagination
}
}
}
UserPaymentAccountOrder
Response
Returns an AdminUserPaymentAccountOrder
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
query UserPaymentAccountOrder($id: Int) {
UserPaymentAccountOrder(id: $id) {
id
user_id
user_subscription_id
payment_syndicate_voucher_id
voucher_code
type
recurring_type
discount_type
payment_provider_type
amount
status
status_name
description
installed_at
paid_at
cancelled_at
refunded_at
created_at
updated_at
installments {
...AdminUserPaymentAccountOrderInstallmentFragment
}
currency
currency_symbol
user {
...AdminUserFragment
}
user_payment_account_id
remote_payment_order_id
remote_payment_user_id
amount_balance_mutation
amount_remote_mutation
payment_url
method
method_details
ip_address
geo_region_code
origin
purchase_origin
server_origin
is_refundable
metadata
receipt_data
invoice_data
account {
...AdminUserPaymentAccountFragment
}
user_subscription {
...AdminUserSubscriptionFragment
}
products {
...AdminProductListedAsRelationFragment
}
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
categories {
...AdminCategoryFragment
}
}
}
Variables
{"id": 42}
Response
{
"data": {
"UserPaymentAccountOrder": {
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 123.45,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [
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]
}
}
}
UserPaymentAccountOrderList
Response
Returns an AdminUserPaymentAccountOrdersListedWithPagination
Arguments
| Name | Description |
|---|---|
search - String
|
|
type - UserPaymentAccountOrderTypeEnum
|
|
status - UserPaymentAccountOrderStatusEnum
|
|
purchase_origin - UserPaymentAccountOrderPurchaseOriginEnum
|
|
locale - String
|
|
limit - Int
|
|
offset - Int
|
|
sort_by - [SortByInput]
|
Sort and order by field(s): "id", "user_id", "amount", "amount_balance_mutation", "currency", "type", "recurring_type", "method", "status", "purchase_origin", "installed_at", "cancelled_at", "paid_at", "refunded_at", "created_at", "updated_at" |
filter_by - [FilterByInput]
|
Filter by field(s) |
project_id - Int
|
|
user_id - Int
|
Example
Query
query UserPaymentAccountOrderList(
$search: String,
$type: UserPaymentAccountOrderTypeEnum,
$status: UserPaymentAccountOrderStatusEnum,
$purchase_origin: UserPaymentAccountOrderPurchaseOriginEnum,
$locale: String,
$limit: Int,
$offset: Int,
$sort_by: [SortByInput],
$filter_by: [FilterByInput],
$project_id: Int,
$user_id: Int
) {
UserPaymentAccountOrderList(
search: $search,
type: $type,
status: $status,
purchase_origin: $purchase_origin,
locale: $locale,
limit: $limit,
offset: $offset,
sort_by: $sort_by,
filter_by: $filter_by,
project_id: $project_id,
user_id: $user_id
) {
items {
...AdminUserPaymentAccountOrderFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"search": "string",
"type": "svod",
"status": "open",
"purchase_origin": "currency",
"locale": "string",
"limit": 42,
"offset": 42,
"sort_by": [SortByInput],
"filter_by": [FilterByInput],
"project_id": 42,
"user_id": 42
}
Response
{
"data": {
"UserPaymentAccountOrderList": {
"items": [AdminUserPaymentAccountOrder],
"pagination": Pagination
}
}
}
Mutations
ArticleArticleSort
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
recommended_article_id - Int
|
|
pivot_id - Int
|
|
pivot_action - SortPivotActionEnum
|
Example
Query
mutation ArticleArticleSort(
$id: Int,
$recommended_article_id: Int,
$pivot_id: Int,
$pivot_action: SortPivotActionEnum
) {
ArticleArticleSort(
id: $id,
recommended_article_id: $recommended_article_id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{
"id": 42,
"recommended_article_id": 42,
"pivot_id": 42,
"pivot_action": "before"
}
Response
{"data": {"ArticleArticleSort": false}}
ArticleAssetPlay
Description
Create a play-out entitlement for a given article asset
Response
Returns an AdminArticleAssetPlay
Arguments
| Name | Description |
|---|---|
article_id - Int
|
The article id for which to create a play configuration |
asset_id - Int
|
The asset id for which to create a play configuration |
protocols - [ArticlePlayProtocolEnum]
|
The streaming protocols to be included in the play configuration |
resolution - ArticlePlayResolutionEnum
|
Force a given video resolution in the play configuration to create a single-bitrate stream (i.e. non-adaptive stream with single-bitrate/resolution) |
resolution_max - ArticlePlayResolutionEnum
|
Configure a maximum video resolution for the play configuration (i.e. adaptive stream with maximum bitrate/resolution) |
audio_quality_max - ArticlePlayAudioQualityEnum
|
Configure a maximum audio quality for the play configuration |
is_proxy_hls_manifest - Boolean
|
Force the manifest to be proxied e.g. in order to inject a subtitle track (only enforced for non-live streams) |
is_include_subtitles_in_manifest - Boolean
|
Force the inclusion of subtitle tracks in the manifest (only enforced if "is_proxy_hls_manifest" is true). Default = true |
is_offline_download - Boolean
|
Request a play configuration for off-line playback (i.e. in-app download, only available for non-live streams). Default = false |
manifest_audio_track_filter - String
|
Configure a specific audio filter for the play configuration. Default = "" |
platform_context - PlatformContextEnum
|
Define the appropriate platform context for the play configuration (default WEB). Default = web |
device_model_context - DeviceModelContextEnum
|
Define the appropriate device model context for the play configuration |
Example
Query
mutation ArticleAssetPlay(
$article_id: Int,
$asset_id: Int,
$protocols: [ArticlePlayProtocolEnum],
$resolution: ArticlePlayResolutionEnum,
$resolution_max: ArticlePlayResolutionEnum,
$audio_quality_max: ArticlePlayAudioQualityEnum,
$is_proxy_hls_manifest: Boolean,
$is_include_subtitles_in_manifest: Boolean,
$is_offline_download: Boolean,
$manifest_audio_track_filter: String,
$platform_context: PlatformContextEnum,
$device_model_context: DeviceModelContextEnum
) {
ArticleAssetPlay(
article_id: $article_id,
asset_id: $asset_id,
protocols: $protocols,
resolution: $resolution,
resolution_max: $resolution_max,
audio_quality_max: $audio_quality_max,
is_proxy_hls_manifest: $is_proxy_hls_manifest,
is_include_subtitles_in_manifest: $is_include_subtitles_in_manifest,
is_offline_download: $is_offline_download,
manifest_audio_track_filter: $manifest_audio_track_filter,
platform_context: $platform_context,
device_model_context: $device_model_context
) {
article_id
asset_id
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
linked_type
subtitles {
...FileFragment
}
entitlements {
...ArticleAssetPlayEntitlementFragment
}
upsell_products {
...ProductListedAsRelationFragment
}
appa
appr
pulse_updated_at
pulse_token
concurrent_user_num
fairplay_certificate_url
user_subtitle_locale
user_audio_locale
issued_at
}
}
Variables
{
"article_id": 42,
"asset_id": 42,
"protocols": ["mss"],
"resolution": "w3840_h2160",
"resolution_max": "w3840_h2160",
"audio_quality_max": "audio_512kb",
"is_proxy_hls_manifest": false,
"is_include_subtitles_in_manifest": true,
"is_offline_download": false,
"manifest_audio_track_filter": "",
"platform_context": "web",
"device_model_context": "chromecast_legacy"
}
Response
{
"data": {
"ArticleAssetPlay": {
"article_id": 42,
"asset_id": 42,
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 123.45,
"time_marker_end": 987.65,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"linked_type": "film",
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"upsell_products": [ProductListedAsRelation],
"appa": 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"
}
}
}
ArticleClone
Description
Clone a given article
Response
Returns an AdminArticle
Arguments
| Name | Description |
|---|---|
id - Int
|
The id of the Article which should be cloned. |
name - String
|
The new, unique name for the cloned Article. |
parent_id - Int
|
The optional id of the Article under which the cloned Article should be placed (its type will automatically be adjusted, e.g. under a "season" each Article should have type "episode"). |
Example
Query
mutation ArticleClone(
$id: Int,
$name: String,
$parent_id: Int
) {
ArticleClone(
id: $id,
name: $name,
parent_id: $parent_id
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...AdminArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AdminAssetFragment
}
categories {
...AdminCategoryFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...AdminProductFragment
}
upsell_products {
...AdminProductFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
is_auto_generate_recommendations
is_show_in_all_geo_regions
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
canonical_title_translations {
...TranslationFragment
}
upsell_product_call_to_action_tag_translations {
...TranslationFragment
}
ribbon_title_translations {
...TranslationFragment
}
children {
...AdminArticleFragment
}
recommended_articles {
...AdminArticleFragment
}
featured_on_categories {
...AdminCategoryFragment
}
files {
...FileFragment
}
entitling_subscriptions {
...AdminSubscriptionFragment
}
published_from
published_until
}
}
Variables
{
"id": 42,
"name": "string",
"parent_id": 42
}
Response
{
"data": {
"ArticleClone": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": false,
"generic_url": "https://url.example.com",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"canonical_title_translations": [Translation],
"upsell_product_call_to_action_tag_translations": [
Translation
],
"ribbon_title_translations": [Translation],
"children": [AdminArticle],
"recommended_articles": [AdminArticle],
"featured_on_categories": [AdminCategory],
"files": [File],
"entitling_subscriptions": [AdminSubscription],
"published_from": "string",
"published_until": "string"
}
}
}
ArticleCreate
Description
Create a new article
Response
Returns an AdminArticle
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
type - ArticleTypeEnum
|
Default = video |
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
canonical_title - [TranslationInput]
|
|
upsell_product_call_to_action_tag - [TranslationInput]
|
|
ribbon_title - [TranslationInput]
|
|
ribbon_settings - String
|
|
locale - String
|
|
metas - [ArticleMetaInput]
|
|
assets - [ArticleAssetInput]
|
|
categories - [Int]
|
|
recommended_articles - [Int]
|
|
geo_regions - [Int]
|
|
locale_regions - [Int]
|
|
products - [Int]
|
|
upsell_products - [Int]
|
|
visibility - ResourceVisibilityEnum
|
Default = everyone |
discoverability - ArticleDiscoverabilityEnum
|
|
is_downloadable - Boolean
|
|
is_auto_generate_recommendations - Boolean
|
Auto-generate recommended articles for this article, or alternatively manually moderate the recommended articles |
is_show_in_all_geo_regions - Boolean
|
Show article in all geo-regions, whether it is geo-restricted or not (default: true). Default = true |
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended, default: true). Default = true |
status - Int
|
|
published_from - String
|
|
published_until - String
|
|
project_id - Int
|
Example
Query
mutation ArticleCreate(
$name: String,
$parent_id: Int,
$type: ArticleTypeEnum,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$canonical_title: [TranslationInput],
$upsell_product_call_to_action_tag: [TranslationInput],
$ribbon_title: [TranslationInput],
$ribbon_settings: String,
$locale: String,
$metas: [ArticleMetaInput],
$assets: [ArticleAssetInput],
$categories: [Int],
$recommended_articles: [Int],
$geo_regions: [Int],
$locale_regions: [Int],
$products: [Int],
$upsell_products: [Int],
$visibility: ResourceVisibilityEnum,
$discoverability: ArticleDiscoverabilityEnum,
$is_downloadable: Boolean,
$is_auto_generate_recommendations: Boolean,
$is_show_in_all_geo_regions: Boolean,
$is_enforce_lowercase_urls: Boolean,
$status: Int,
$published_from: String,
$published_until: String,
$project_id: Int
) {
ArticleCreate(
name: $name,
parent_id: $parent_id,
type: $type,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
canonical_title: $canonical_title,
upsell_product_call_to_action_tag: $upsell_product_call_to_action_tag,
ribbon_title: $ribbon_title,
ribbon_settings: $ribbon_settings,
locale: $locale,
metas: $metas,
assets: $assets,
categories: $categories,
recommended_articles: $recommended_articles,
geo_regions: $geo_regions,
locale_regions: $locale_regions,
products: $products,
upsell_products: $upsell_products,
visibility: $visibility,
discoverability: $discoverability,
is_downloadable: $is_downloadable,
is_auto_generate_recommendations: $is_auto_generate_recommendations,
is_show_in_all_geo_regions: $is_show_in_all_geo_regions,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
status: $status,
published_from: $published_from,
published_until: $published_until,
project_id: $project_id
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...AdminArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AdminAssetFragment
}
categories {
...AdminCategoryFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...AdminProductFragment
}
upsell_products {
...AdminProductFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
is_auto_generate_recommendations
is_show_in_all_geo_regions
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
canonical_title_translations {
...TranslationFragment
}
upsell_product_call_to_action_tag_translations {
...TranslationFragment
}
ribbon_title_translations {
...TranslationFragment
}
children {
...AdminArticleFragment
}
recommended_articles {
...AdminArticleFragment
}
featured_on_categories {
...AdminCategoryFragment
}
files {
...FileFragment
}
entitling_subscriptions {
...AdminSubscriptionFragment
}
published_from
published_until
}
}
Variables
{
"name": "string",
"parent_id": 42,
"type": "video",
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"canonical_title": [TranslationInput],
"upsell_product_call_to_action_tag": [TranslationInput],
"ribbon_title": [TranslationInput],
"ribbon_settings": "string",
"locale": "string",
"metas": [ArticleMetaInput],
"assets": [ArticleAssetInput],
"categories": [42],
"recommended_articles": [42],
"geo_regions": [42],
"locale_regions": [42],
"products": [42],
"upsell_products": [42],
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": true,
"is_enforce_lowercase_urls": true,
"status": 42,
"published_from": "string",
"published_until": "string",
"project_id": 42
}
Response
{
"data": {
"ArticleCreate": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": true,
"is_auth_required": 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"
}
}
}
ArticleDelete
Description
Delete an existing article
ArticleFileDelete
Description
Delete a file for a given article
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
article_id - Int
|
Example
Query
mutation ArticleFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$article_id: Int
) {
ArticleFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
article_id: $article_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"article_id": 42
}
Response
{"data": {"ArticleFileDelete": false}}
ArticleMetaDelete
Description
Delete a metadata property for a given article
Example
Query
mutation ArticleMetaDelete(
$article_id: Int,
$key: String
) {
ArticleMetaDelete(
article_id: $article_id,
key: $key
)
}
Variables
{"article_id": 42, "key": "string"}
Response
{"data": {"ArticleMetaDelete": true}}
ArticleNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation ArticleNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
ArticleNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"ArticleNodeUpdate": true}}
ArticleUpdate
Description
Update given article
Response
Returns an AdminArticle
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
type - ArticleTypeEnum
|
|
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
canonical_title - [TranslationInput]
|
|
upsell_product_call_to_action_tag - [TranslationInput]
|
|
ribbon_title - [TranslationInput]
|
|
ribbon_settings - String
|
|
locale - String
|
|
files - [ArticleFileInput]
|
|
metas - [ArticleMetaInput]
|
|
assets - [ArticleAssetInput]
|
|
categories - [Int]
|
|
recommended_articles - [Int]
|
|
geo_regions - [Int]
|
|
locale_regions - [Int]
|
|
products - [Int]
|
|
upsell_products - [Int]
|
|
visibility - ResourceVisibilityEnum
|
|
discoverability - ArticleDiscoverabilityEnum
|
|
is_downloadable - Boolean
|
|
is_auto_generate_recommendations - Boolean
|
Auto-generate recommended articles for this article, or alternatively manually moderate the recommended articles |
is_show_in_all_geo_regions - Boolean
|
Show article in all geo-regions, whether it is geo-restricted or not (default: true). Default = true |
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended, default: true). Default = true |
status - Int
|
|
published_from - String
|
|
published_until - String
|
|
id - Int
|
Example
Query
mutation ArticleUpdate(
$name: String,
$parent_id: Int,
$type: ArticleTypeEnum,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$canonical_title: [TranslationInput],
$upsell_product_call_to_action_tag: [TranslationInput],
$ribbon_title: [TranslationInput],
$ribbon_settings: String,
$locale: String,
$files: [ArticleFileInput],
$metas: [ArticleMetaInput],
$assets: [ArticleAssetInput],
$categories: [Int],
$recommended_articles: [Int],
$geo_regions: [Int],
$locale_regions: [Int],
$products: [Int],
$upsell_products: [Int],
$visibility: ResourceVisibilityEnum,
$discoverability: ArticleDiscoverabilityEnum,
$is_downloadable: Boolean,
$is_auto_generate_recommendations: Boolean,
$is_show_in_all_geo_regions: Boolean,
$is_enforce_lowercase_urls: Boolean,
$status: Int,
$published_from: String,
$published_until: String,
$id: Int
) {
ArticleUpdate(
name: $name,
parent_id: $parent_id,
type: $type,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
canonical_title: $canonical_title,
upsell_product_call_to_action_tag: $upsell_product_call_to_action_tag,
ribbon_title: $ribbon_title,
ribbon_settings: $ribbon_settings,
locale: $locale,
files: $files,
metas: $metas,
assets: $assets,
categories: $categories,
recommended_articles: $recommended_articles,
geo_regions: $geo_regions,
locale_regions: $locale_regions,
products: $products,
upsell_products: $upsell_products,
visibility: $visibility,
discoverability: $discoverability,
is_downloadable: $is_downloadable,
is_auto_generate_recommendations: $is_auto_generate_recommendations,
is_show_in_all_geo_regions: $is_show_in_all_geo_regions,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
status: $status,
published_from: $published_from,
published_until: $published_until,
id: $id
) {
id
project_id
parent_id
name
url_slug
full_url_slug
canonical_url
canonical_title
upsell_product_call_to_action_tag
ribbon_title
ribbon_settings
type
metas {
...AdminArticleMetaFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
assets {
...AdminAssetFragment
}
categories {
...AdminCategoryFragment
}
geo_regions {
...GeoRegionFragment
}
locale_regions {
...LocaleRegionFragment
}
products {
...AdminProductFragment
}
upsell_products {
...AdminProductFragment
}
created_at
updated_at
popularity_index
visibility
discoverability
is_downloadable
is_auth_required
published_at
linked_asset_playable_from
status
is_auto_generate_recommendations
is_show_in_all_geo_regions
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
canonical_title_translations {
...TranslationFragment
}
upsell_product_call_to_action_tag_translations {
...TranslationFragment
}
ribbon_title_translations {
...TranslationFragment
}
children {
...AdminArticleFragment
}
recommended_articles {
...AdminArticleFragment
}
featured_on_categories {
...AdminCategoryFragment
}
files {
...FileFragment
}
entitling_subscriptions {
...AdminSubscriptionFragment
}
published_from
published_until
}
}
Variables
{
"name": "string",
"parent_id": 42,
"type": "episode",
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"canonical_title": [TranslationInput],
"upsell_product_call_to_action_tag": [TranslationInput],
"ribbon_title": [TranslationInput],
"ribbon_settings": "string",
"locale": "string",
"files": [ArticleFileInput],
"metas": [ArticleMetaInput],
"assets": [ArticleAssetInput],
"categories": [42],
"recommended_articles": [42],
"geo_regions": [42],
"locale_regions": [42],
"products": [42],
"upsell_products": [42],
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": true,
"is_enforce_lowercase_urls": true,
"status": 42,
"published_from": "string",
"published_until": "string",
"id": 42
}
Response
{
"data": {
"ArticleUpdate": {
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": true,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": 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"
}
}
}
AssetContentReplace
Description
Replace the video content (optionally include images/subtitles) of given Asset with that of a replacement Asset
Response
Returns an AdminAsset
Example
Query
mutation AssetContentReplace(
$id: Int,
$replacement_asset_id: Int,
$project_id: Int,
$is_migrate_related_files: Boolean
) {
AssetContentReplace(
id: $id,
replacement_asset_id: $replacement_asset_id,
project_id: $project_id,
is_migrate_related_files: $is_migrate_related_files
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{
"id": 42,
"replacement_asset_id": 42,
"project_id": 42,
"is_migrate_related_files": false
}
Response
{
"data": {
"AssetContentReplace": {
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 987.65,
"time_marker_end": 123.45,
"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",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetFileDelete
Description
Delete a file for a given asset
AssetFileUpdate
Description
Update a file for a given asset
Response
Returns a File
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
asset_id - Int
|
Example
Query
mutation AssetFileUpdate(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$asset_id: Int
) {
AssetFileUpdate(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
asset_id: $asset_id
) {
id
name
title
type
size
width
height
aspect_ratio_profile
duration
locale
locale_label
base_url
base_path
url
proxy_file_path
proxy_url
file_name
file_path
}
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"asset_id": 42
}
Response
{
"data": {
"AssetFileUpdate": {
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string"
}
}
}
AssetLiveCreate
Description
Create a new Asset of type "live_video".
Response
Returns an AdminAsset
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
external_asset_id - String
|
|
time_marker_intro_end - Float
|
|
time_marker_end - Float
|
|
playable_from - String
|
The date-time (UTC) at which the asset is playable, typically used to indicate the start date-time of a live-stream event. |
playable_until - String
|
The date-time (UTC) util which the asset is playable, typically used to indicate the end date-time of a live-stream event. |
published_from - String
|
|
published_until - String
|
|
encryption_profile_name - AssetEncryptionProfileNameEnum
|
Default = none |
source_blob_name - String
|
|
media_provider - AssetMediaProviderNameEnum
|
Example
Query
mutation AssetLiveCreate(
$project_id: Int,
$external_asset_id: String,
$time_marker_intro_end: Float,
$time_marker_end: Float,
$playable_from: String,
$playable_until: String,
$published_from: String,
$published_until: String,
$encryption_profile_name: AssetEncryptionProfileNameEnum,
$source_blob_name: String,
$media_provider: AssetMediaProviderNameEnum
) {
AssetLiveCreate(
project_id: $project_id,
external_asset_id: $external_asset_id,
time_marker_intro_end: $time_marker_intro_end,
time_marker_end: $time_marker_end,
playable_from: $playable_from,
playable_until: $playable_until,
published_from: $published_from,
published_until: $published_until,
encryption_profile_name: $encryption_profile_name,
source_blob_name: $source_blob_name,
media_provider: $media_provider
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{
"project_id": 42,
"external_asset_id": "string",
"time_marker_intro_end": 123.45,
"time_marker_end": 987.65,
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"encryption_profile_name": "none",
"source_blob_name": "string",
"media_provider": "mock"
}
Response
{
"data": {
"AssetLiveCreate": {
"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": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetLiveStart
Description
Start live asset event channel
Response
Returns an AdminAsset
Example
Query
mutation AssetLiveStart(
$id: Int,
$project_id: Int
) {
AssetLiveStart(
id: $id,
project_id: $project_id
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{"id": 42, "project_id": 42}
Response
{
"data": {
"AssetLiveStart": {
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 987.65,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetLiveStop
Description
Stop live asset event channel
Response
Returns an AdminAsset
Example
Query
mutation AssetLiveStop(
$id: Int,
$project_id: Int
) {
AssetLiveStop(
id: $id,
project_id: $project_id
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{"id": 42, "project_id": 42}
Response
{
"data": {
"AssetLiveStop": {
"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": 987.65,
"time_marker_intro_end": 123.45,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetPlay
Description
Create a play-out entitlement for a given asset
Response
Returns an AdminAssetPlay
Arguments
| Name | Description |
|---|---|
asset_id - Int
|
The asset id for which to create a play configuration |
protocols - [ArticlePlayProtocolEnum]
|
The streaming protocols to be included in the play configuration |
resolution - ArticlePlayResolutionEnum
|
Force a given video resolution in the play configuration to create a single-bitrate stream (i.e. non-adaptive stream with single-bitrate/resolution) |
resolution_max - ArticlePlayResolutionEnum
|
Configure a maximum video resolution for the play configuration (i.e. adaptive stream with maximum bitrate/resolution) |
audio_quality_max - ArticlePlayAudioQualityEnum
|
Configure a maximum audio quality for the play configuration |
is_proxy_hls_manifest - Boolean
|
Force the manifest to be proxied e.g. in order to inject a subtitle track (only enforced for non-live streams) |
is_include_subtitles_in_manifest - Boolean
|
Force the inclusion of subtitle tracks in the manifest (only enforced if "is_proxy_hls_manifest" is true). Default = true |
is_offline_download - Boolean
|
Request a play configuration for off-line playback (i.e. in-app download, only available for non-live streams). Default = false |
manifest_audio_track_filter - String
|
Configure a specific audio filter for the play configuration. Default = "" |
platform_context - PlatformContextEnum
|
Define the appropriate platform context for the play configuration (default WEB). Default = web |
device_model_context - DeviceModelContextEnum
|
Define the appropriate device model context for the play configuration |
Example
Query
mutation AssetPlay(
$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
) {
AssetPlay(
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
) {
asset_id
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
entitlements {
...ArticleAssetPlayEntitlementFragment
}
pulse_updated_at
pulse_token
fairplay_certificate_url
user_subtitle_locale
user_audio_locale
issued_at
}
}
Variables
{
"asset_id": 42,
"protocols": ["mss"],
"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": "chromecast_legacy"
}
Response
{
"data": {
"AssetPlay": {
"asset_id": 42,
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 987.65,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"pulse_updated_at": "2000-12-31T12:34:56.000Z",
"pulse_token": "string",
"fairplay_certificate_url": "https://url.example.com",
"user_subtitle_locale": "string",
"user_audio_locale": "string",
"issued_at": "2000-12-31T12:34:56.000Z"
}
}
}
AssetUpdate
Description
Update an existing asset
Response
Returns an AdminAsset
Arguments
| Name | Description |
|---|---|
id - Int
|
|
project_id - Int
|
|
external_asset_id - String
|
|
asset_status_id - Int
|
|
asset_status - AssetStatusEnum
|
|
time_marker_intro_start - Float
|
|
time_marker_intro_end - Float
|
|
time_marker_end - Float
|
|
playable_from - String
|
The date-time (UTC) at which the asset is playable, typically used to indicate the start date-time of a live-stream event. |
playable_until - String
|
The date-time (UTC) util which the asset is playable, typically used to indicate the end date-time of a live-stream event. |
published_from - String
|
|
published_until - String
|
|
encryption_profile_name - AssetEncryptionProfileNameEnum
|
|
files - [AssetFileInput]
|
|
is_force - Boolean
|
Force an update action if possible (e.g. unpublishing an Asset even if it is still linked to other Articles). Default = false |
Example
Query
mutation AssetUpdate(
$id: Int,
$project_id: Int,
$external_asset_id: String,
$asset_status_id: Int,
$asset_status: AssetStatusEnum,
$time_marker_intro_start: Float,
$time_marker_intro_end: Float,
$time_marker_end: Float,
$playable_from: String,
$playable_until: String,
$published_from: String,
$published_until: String,
$encryption_profile_name: AssetEncryptionProfileNameEnum,
$files: [AssetFileInput],
$is_force: Boolean
) {
AssetUpdate(
id: $id,
project_id: $project_id,
external_asset_id: $external_asset_id,
asset_status_id: $asset_status_id,
asset_status: $asset_status,
time_marker_intro_start: $time_marker_intro_start,
time_marker_intro_end: $time_marker_intro_end,
time_marker_end: $time_marker_end,
playable_from: $playable_from,
playable_until: $playable_until,
published_from: $published_from,
published_until: $published_until,
encryption_profile_name: $encryption_profile_name,
files: $files,
is_force: $is_force
) {
id
project_id
source_blob_name
thumbnail_asset_id
is_live
type
linked_type
accessibility
time_marker_intro_start
time_marker_intro_end
time_marker_end
duration
aspect_ratio
aspect_ratio_fraction
subtitles {
...FileFragment
}
screenshots {
...FileFragment
}
playable_from
playable_until
published_from
published_until
created_at
updated_at
project {
...AdminProjectFragment
}
media_provider
encoding_profile_name
encryption_profile_name
source_blob_md5
source_asset_id
encoded_asset_name
encoded_asset_id
streaming_unit_id
origin
streaming_endpoint
asset_status_id
asset_status
ingestion_status
ingestion_status_description
external_asset_id
files {
...FileFragment
}
download_urls {
...StructureKeyValueStringPairFragment
}
activity_logs {
...AdminActivityLogFragment
}
player_embed_code_iframe
ingestion_endpoints
streaming_credentials {
...StructureKeyValueStringPairFragment
}
}
}
Variables
{
"id": 42,
"project_id": 42,
"external_asset_id": "string",
"asset_status_id": 42,
"asset_status": "source_asset_created",
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 123.45,
"time_marker_end": 123.45,
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"encryption_profile_name": "none",
"files": [AssetFileInput],
"is_force": false
}
Response
{
"data": {
"AssetUpdate": {
"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": 987.65,
"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",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [
StructureKeyValueStringPair
]
}
}
}
AssetUploadTokenFetch
Description
Fetch a SAS-token for a file upload
Response
Returns an AdminAssetUploadToken
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
source_blob_name - String
|
|
encoding_profile_name - AssetEncodingProfileNameEnum
|
|
encryption_profile_name - AssetEncryptionProfileNameEnum
|
|
media_provider - AssetMediaProviderNameEnum
|
Example
Query
mutation AssetUploadTokenFetch(
$project_id: Int,
$source_blob_name: String,
$encoding_profile_name: AssetEncodingProfileNameEnum,
$encryption_profile_name: AssetEncryptionProfileNameEnum,
$media_provider: AssetMediaProviderNameEnum
) {
AssetUploadTokenFetch(
project_id: $project_id,
source_blob_name: $source_blob_name,
encoding_profile_name: $encoding_profile_name,
encryption_profile_name: $encryption_profile_name,
media_provider: $media_provider
) {
project_id
asset_id
token
token_type
credential_string
expires_in
source_blob_name
account_name
folder_name
encoding_profile_name
encryption_profile_name
}
}
Variables
{
"project_id": 42,
"source_blob_name": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"media_provider": "mock"
}
Response
{
"data": {
"AssetUploadTokenFetch": {
"project_id": 42,
"asset_id": 42,
"token": "string",
"token_type": "string",
"credential_string": "string",
"expires_in": 86400,
"source_blob_name": "string",
"account_name": "string",
"folder_name": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none"
}
}
}
CategoryArticleSort
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - SortPivotActionEnum
|
|
article_id - Int
|
Example
Query
mutation CategoryArticleSort(
$id: Int,
$pivot_id: Int,
$pivot_action: SortPivotActionEnum,
$article_id: Int
) {
CategoryArticleSort(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action,
article_id: $article_id
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "before", "article_id": 42}
Response
{"data": {"CategoryArticleSort": false}}
CategoryCreate
Response
Returns an AdminCategory
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
type - CategoryTypeEnum
|
|
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
locale - String
|
|
metas - [CategoryMetaInput]
|
|
featured_articles - [Int]
|
|
visibility - ResourceVisibilityEnum
|
Default = everyone |
status - Int
|
|
child_metas - [String]
|
|
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended). Default = true |
project_id - Int
|
Example
Query
mutation CategoryCreate(
$name: String,
$parent_id: Int,
$type: CategoryTypeEnum,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$locale: String,
$metas: [CategoryMetaInput],
$featured_articles: [Int],
$visibility: ResourceVisibilityEnum,
$status: Int,
$child_metas: [String],
$is_enforce_lowercase_urls: Boolean,
$project_id: Int
) {
CategoryCreate(
name: $name,
parent_id: $parent_id,
type: $type,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
locale: $locale,
metas: $metas,
featured_articles: $featured_articles,
visibility: $visibility,
status: $status,
child_metas: $child_metas,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
project_id: $project_id
) {
id
project_id
name
url_slug
full_url_slug
canonical_url
type
metas {
...AdminCategoryMetaFragment
}
articles {
...AdminArticleFragment
}
products {
...AdminProductFragment
}
featured_articles {
...AdminArticleFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
videos {
...FileFragment
}
parent_id
child_metas
created_at
updated_at
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
posters {
...FileFragment
}
files {
...FileFragment
}
visibility
status
}
}
Variables
{
"name": "string",
"parent_id": 42,
"type": "article_label",
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"locale": "string",
"metas": [CategoryMetaInput],
"featured_articles": [42],
"visibility": "everyone",
"status": 42,
"child_metas": ["string"],
"is_enforce_lowercase_urls": true,
"project_id": 42
}
Response
{
"data": {
"CategoryCreate": {
"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"
}
}
}
CategoryDelete
CategoryFeaturedArticleSort
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - SortPivotActionEnum
|
|
article_id - Int
|
Example
Query
mutation CategoryFeaturedArticleSort(
$id: Int,
$pivot_id: Int,
$pivot_action: SortPivotActionEnum,
$article_id: Int
) {
CategoryFeaturedArticleSort(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action,
article_id: $article_id
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "before", "article_id": 42}
Response
{"data": {"CategoryFeaturedArticleSort": true}}
CategoryFileDelete
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
category_id - Int
|
Example
Query
mutation CategoryFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$category_id: Int
) {
CategoryFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
category_id: $category_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"category_id": 42
}
Response
{"data": {"CategoryFileDelete": false}}
CategoryMetaDelete
Example
Query
mutation CategoryMetaDelete(
$category_id: Int,
$key: String
) {
CategoryMetaDelete(
category_id: $category_id,
key: $key
)
}
Variables
{"category_id": 42, "key": "string"}
Response
{"data": {"CategoryMetaDelete": false}}
CategoryNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation CategoryNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
CategoryNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"CategoryNodeUpdate": false}}
CategoryProductSort
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - SortPivotActionEnum
|
|
product_id - Int
|
Example
Query
mutation CategoryProductSort(
$id: Int,
$pivot_id: Int,
$pivot_action: SortPivotActionEnum,
$product_id: Int
) {
CategoryProductSort(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action,
product_id: $product_id
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "before", "product_id": 42}
Response
{"data": {"CategoryProductSort": true}}
CategoryUpdate
Response
Returns an AdminCategory
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
type - CategoryTypeEnum
|
|
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
locale - String
|
|
files - [CategoryFileInput]
|
|
metas - [CategoryMetaInput]
|
|
featured_articles - [Int]
|
|
visibility - ResourceVisibilityEnum
|
|
status - Int
|
|
child_metas - [String]
|
|
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended). Default = true |
id - Int
|
Example
Query
mutation CategoryUpdate(
$name: String,
$parent_id: Int,
$type: CategoryTypeEnum,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$locale: String,
$files: [CategoryFileInput],
$metas: [CategoryMetaInput],
$featured_articles: [Int],
$visibility: ResourceVisibilityEnum,
$status: Int,
$child_metas: [String],
$is_enforce_lowercase_urls: Boolean,
$id: Int
) {
CategoryUpdate(
name: $name,
parent_id: $parent_id,
type: $type,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
locale: $locale,
files: $files,
metas: $metas,
featured_articles: $featured_articles,
visibility: $visibility,
status: $status,
child_metas: $child_metas,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
id: $id
) {
id
project_id
name
url_slug
full_url_slug
canonical_url
type
metas {
...AdminCategoryMetaFragment
}
articles {
...AdminArticleFragment
}
products {
...AdminProductFragment
}
featured_articles {
...AdminArticleFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
videos {
...FileFragment
}
parent_id
child_metas
created_at
updated_at
generic_url
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
posters {
...FileFragment
}
files {
...FileFragment
}
visibility
status
}
}
Variables
{
"name": "string",
"parent_id": 42,
"type": "article_label",
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"locale": "string",
"files": [CategoryFileInput],
"metas": [CategoryMetaInput],
"featured_articles": [42],
"visibility": "everyone",
"status": 42,
"child_metas": ["string"],
"is_enforce_lowercase_urls": true,
"id": 42
}
Response
{
"data": {
"CategoryUpdate": {
"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"
}
}
}
ClientAuthenticate
Description
Initiate an authenticated session and request new tokens for given admin oauth-client
Response
Returns an Authenticate
Example
Query
mutation ClientAuthenticate(
$client_id: String,
$client_secret: String,
$project_id: Int
) {
ClientAuthenticate(
client_id: $client_id,
client_secret: $client_secret,
project_id: $project_id
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"client_id": "string",
"client_secret": "string",
"project_id": 42
}
Response
{
"data": {
"ClientAuthenticate": {
"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"
}
}
}
ClientUpdate
Response
Returns an AdminClient
Arguments
| Name | Description |
|---|---|
id - Int
|
|
project_id - Int
|
|
is_generate_new_secret - Boolean
|
Generate a new secret for given OAuth2 client. Default = false |
redirect_uris - [String]
|
A list of allowed redirect uri values, which should consist of valid https urls |
remote_callback_url - String
|
Remote callback URL that is called |
remote_callback_crm_contexts - [CrmSyncContextEnum]
|
The CRM synchronisation contexts to which given client integration must trigger |
password_current - String
|
Example
Query
mutation ClientUpdate(
$id: Int,
$project_id: Int,
$is_generate_new_secret: Boolean,
$redirect_uris: [String],
$remote_callback_url: String,
$remote_callback_crm_contexts: [CrmSyncContextEnum],
$password_current: String
) {
ClientUpdate(
id: $id,
project_id: $project_id,
is_generate_new_secret: $is_generate_new_secret,
redirect_uris: $redirect_uris,
remote_callback_url: $remote_callback_url,
remote_callback_crm_contexts: $remote_callback_crm_contexts,
password_current: $password_current
) {
id
project_id
name
remote_callback_url
remote_callback_crm_contexts
redirect_uris
service_type
is_configurable
authorization_url
token_url
refresh_token_url
user_info_url
scope
client_id
client_secret
}
}
Variables
{
"id": 42,
"project_id": 42,
"is_generate_new_secret": false,
"redirect_uris": ["string"],
"remote_callback_url": "string",
"remote_callback_crm_contexts": ["user_article"],
"password_current": "string"
}
Response
{
"data": {
"ClientUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"remote_callback_url": "https://url.example.com",
"remote_callback_crm_contexts": ["user_article"],
"redirect_uris": ["string"],
"service_type": "external_admin",
"is_configurable": true,
"authorization_url": "https://url.example.com",
"token_url": "https://url.example.com",
"refresh_token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"scope": "string",
"client_id": "string",
"client_secret": "string"
}
}
}
FileUpdate
Description
Update a file
Response
Returns an AdminFile
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
title - [TranslationInput]
|
Example
Query
mutation FileUpdate(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$title: [TranslationInput]
) {
FileUpdate(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
title: $title
) {
id
name
title
type
size
width
height
aspect_ratio_profile
duration
locale
locale_label
base_url
base_path
url
proxy_file_path
proxy_url
file_name
file_path
title_translations {
...TranslationFragment
}
origin_url
}
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"title": [TranslationInput]
}
Response
{
"data": {
"FileUpdate": {
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string",
"title_translations": [Translation],
"origin_url": "https://url.example.com"
}
}
}
LanguageTagUpdate
Response
Returns an AdminLanguageTag
Arguments
| Name | Description |
|---|---|
locale - String
|
|
value - [TranslationInput]
|
|
id - Int
|
Example
Query
mutation LanguageTagUpdate(
$locale: String,
$value: [TranslationInput],
$id: Int
) {
LanguageTagUpdate(
locale: $locale,
value: $value,
id: $id
) {
key
value
format
id
project_id
platform_context
value_translations {
...TranslationFragment
}
}
}
Variables
{
"locale": "string",
"value": [TranslationInput],
"id": 42
}
Response
{
"data": {
"LanguageTagUpdate": {
"key": "string",
"value": "string",
"format": "date",
"id": 42,
"project_id": 42,
"platform_context": "string",
"value_translations": [Translation]
}
}
}
MailTemplateFileDelete
Description
Delete a file for a given mail template
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
mail_template_id - Int
|
Example
Query
mutation MailTemplateFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$mail_template_id: Int
) {
MailTemplateFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
mail_template_id: $mail_template_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"mail_template_id": 42
}
Response
{"data": {"MailTemplateFileDelete": true}}
MailTemplateSendTest
Description
Test the mail template by sending it to given email address (with optional given locale).
Example
Query
mutation MailTemplateSendTest(
$id: Int,
$email: String,
$locale: String
) {
MailTemplateSendTest(
id: $id,
email: $email,
locale: $locale
)
}
Variables
{
"id": 42,
"email": "string",
"locale": "string"
}
Response
{"data": {"MailTemplateSendTest": false}}
MailTemplateUpdate
Response
Returns an AdminMailTemplate
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
subject - [TranslationInput]
|
|
content - [TranslationInput]
|
|
status - Int
|
|
files - [MailTemplateFileInput]
|
|
id - Int
|
Example
Query
mutation MailTemplateUpdate(
$locale: String,
$name: String,
$subject: [TranslationInput],
$content: [TranslationInput],
$status: Int,
$files: [MailTemplateFileInput],
$id: Int
) {
MailTemplateUpdate(
locale: $locale,
name: $name,
subject: $subject,
content: $content,
status: $status,
files: $files,
id: $id
) {
id
project_id
name
subject
content
subject_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
status
created_at
updated_at
}
}
Variables
{
"locale": "string",
"name": "string",
"subject": [TranslationInput],
"content": [TranslationInput],
"status": 42,
"files": [MailTemplateFileInput],
"id": 42
}
Response
{
"data": {
"MailTemplateUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"subject": "string",
"content": "string",
"subject_translations": [Translation],
"content_translations": [Translation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File],
"status": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
}
}
MenuComponentCreate
Response
Returns an AdminMenuComponent
Arguments
| Name | Description |
|---|---|
page_id - Int
|
|
locale - String
|
|
url - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
visibility - ResourceVisibilityEnum
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
menu_id - Int
|
|
type - MenuComponentTypeEnum
|
Example
Query
mutation MenuComponentCreate(
$page_id: Int,
$locale: String,
$url: String,
$title: [TranslationInput],
$content: [TranslationInput],
$visibility: ResourceVisibilityEnum,
$subscriptions: [Int],
$products: [Int],
$menu_id: Int,
$type: MenuComponentTypeEnum
) {
MenuComponentCreate(
page_id: $page_id,
locale: $locale,
url: $url,
title: $title,
content: $content,
visibility: $visibility,
subscriptions: $subscriptions,
products: $products,
menu_id: $menu_id,
type: $type
) {
id
parent_id
menu_id
page_id
page_full_url_slug
type
title
content
url
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
page {
...AdminPageFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"page_id": 42,
"locale": "string",
"url": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"visibility": "everyone",
"subscriptions": [42],
"products": [42],
"menu_id": 42,
"type": "button_url_link"
}
Response
{
"data": {
"MenuComponentCreate": {
"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],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"page": AdminPage,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MenuComponentDelete
MenuComponentFileDelete
Description
Delete a file for a given menu component
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
menu_component_id - Int
|
Example
Query
mutation MenuComponentFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$menu_component_id: Int
) {
MenuComponentFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
menu_component_id: $menu_component_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"menu_component_id": 42
}
Response
{"data": {"MenuComponentFileDelete": true}}
MenuComponentNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation MenuComponentNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
MenuComponentNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"MenuComponentNodeUpdate": false}}
MenuComponentUpdate
Response
Returns an AdminMenuComponent
Arguments
| Name | Description |
|---|---|
page_id - Int
|
|
locale - String
|
|
url - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
visibility - ResourceVisibilityEnum
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
files - [MenuComponentFileInput]
|
|
id - Int
|
Example
Query
mutation MenuComponentUpdate(
$page_id: Int,
$locale: String,
$url: String,
$title: [TranslationInput],
$content: [TranslationInput],
$visibility: ResourceVisibilityEnum,
$subscriptions: [Int],
$products: [Int],
$files: [MenuComponentFileInput],
$id: Int
) {
MenuComponentUpdate(
page_id: $page_id,
locale: $locale,
url: $url,
title: $title,
content: $content,
visibility: $visibility,
subscriptions: $subscriptions,
products: $products,
files: $files,
id: $id
) {
id
parent_id
menu_id
page_id
page_full_url_slug
type
title
content
url
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
page {
...AdminPageFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"page_id": 42,
"locale": "string",
"url": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"visibility": "everyone",
"subscriptions": [42],
"products": [42],
"files": [MenuComponentFileInput],
"id": 42
}
Response
{
"data": {
"MenuComponentUpdate": {
"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],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"page": AdminPage,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MenuCreate
Response
Returns an AdminMenu
Arguments
| Name | Description |
|---|---|
name - String
|
|
visibility - ResourceVisibilityEnum
|
|
platform_contexts - [PlatformContextEnum]
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
locale_regions - [Int]
|
|
geo_regions - [Int]
|
|
project_id - Int
|
Example
Query
mutation MenuCreate(
$name: String,
$visibility: ResourceVisibilityEnum,
$platform_contexts: [PlatformContextEnum],
$subscriptions: [Int],
$products: [Int],
$locale_regions: [Int],
$geo_regions: [Int],
$project_id: Int
) {
MenuCreate(
name: $name,
visibility: $visibility,
platform_contexts: $platform_contexts,
subscriptions: $subscriptions,
products: $products,
locale_regions: $locale_regions,
geo_regions: $geo_regions,
project_id: $project_id
) {
id
project_id
name
platform_contexts
locale_regions {
...LocaleRegionFragment
}
geo_regions {
...GeoRegionFragment
}
components {
...AdminMenuComponentFragment
}
visibility
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"name": "string",
"visibility": "everyone",
"platform_contexts": ["web"],
"subscriptions": [42],
"products": [42],
"locale_regions": [42],
"geo_regions": [42],
"project_id": 42
}
Response
{
"data": {
"MenuCreate": {
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [AdminMenuComponent],
"visibility": "everyone",
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MenuDelete
MenuUpdate
Response
Returns an AdminMenu
Arguments
| Name | Description |
|---|---|
name - String
|
|
visibility - ResourceVisibilityEnum
|
|
platform_contexts - [PlatformContextEnum]
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
locale_regions - [Int]
|
|
geo_regions - [Int]
|
|
id - Int
|
Example
Query
mutation MenuUpdate(
$name: String,
$visibility: ResourceVisibilityEnum,
$platform_contexts: [PlatformContextEnum],
$subscriptions: [Int],
$products: [Int],
$locale_regions: [Int],
$geo_regions: [Int],
$id: Int
) {
MenuUpdate(
name: $name,
visibility: $visibility,
platform_contexts: $platform_contexts,
subscriptions: $subscriptions,
products: $products,
locale_regions: $locale_regions,
geo_regions: $geo_regions,
id: $id
) {
id
project_id
name
platform_contexts
locale_regions {
...LocaleRegionFragment
}
geo_regions {
...GeoRegionFragment
}
components {
...AdminMenuComponentFragment
}
visibility
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"name": "string",
"visibility": "everyone",
"platform_contexts": ["web"],
"subscriptions": [42],
"products": [42],
"locale_regions": [42],
"geo_regions": [42],
"id": 42
}
Response
{
"data": {
"MenuUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [AdminMenuComponent],
"visibility": "everyone",
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
MetricActionCreate
Description
Create a metric action
Response
Returns an AdminMetricAction
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
type - MetricActionTypeEnum
|
|
status - MetricActionStatusEnum
|
|
webhook_url - String
|
The webhook url to which metric action fulfilment event is pushed |
user_subscription_installment_num - Int
|
The number of entitled user subscription installments of the metric action |
user_subscription_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the entitled user subscription installments of the metric action |
products - [ProductStackInput]
|
|
eligible_users - [Int]
|
|
metrics - [Int]
|
|
files - [MetricActionFileInput]
|
|
project_id - Int
|
Example
Query
mutation MetricActionCreate(
$locale: String,
$name: String,
$title: [TranslationInput],
$content: [TranslationInput],
$type: MetricActionTypeEnum,
$status: MetricActionStatusEnum,
$webhook_url: String,
$user_subscription_installment_num: Int,
$user_subscription_installment_time_unit: SubscriptionTimeUnitEnum,
$products: [ProductStackInput],
$eligible_users: [Int],
$metrics: [Int],
$files: [MetricActionFileInput],
$project_id: Int
) {
MetricActionCreate(
locale: $locale,
name: $name,
title: $title,
content: $content,
type: $type,
status: $status,
webhook_url: $webhook_url,
user_subscription_installment_num: $user_subscription_installment_num,
user_subscription_installment_time_unit: $user_subscription_installment_time_unit,
products: $products,
eligible_users: $eligible_users,
metrics: $metrics,
files: $files,
project_id: $project_id
) {
id
project_id
name
title
content
icons {
...FileFragment
}
images {
...FileFragment
}
files {
...FileFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
type
status
webhook_url
user_subscription_installment_num
user_subscription_installment_time_unit
created_at
updated_at
products {
...AdminProductListedAsRelationFragment
}
eligible_users {
...AdminUserFragment
}
metrics {
...AdminMetricFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"type": "user_entitlement",
"status": "inactive",
"webhook_url": "string",
"user_subscription_installment_num": 42,
"user_subscription_installment_time_unit": "day",
"products": [ProductStackInput],
"eligible_users": [42],
"metrics": [42],
"files": [MetricActionFileInput],
"project_id": 42
}
Response
{
"data": {
"MetricActionCreate": {
"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]
}
}
}
MetricActionDelete
Description
Delete an existing metric
MetricActionFileDelete
Description
Delete a file for a given menu component
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
metric_action_id - Int
|
Example
Query
mutation MetricActionFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$metric_action_id: Int
) {
MetricActionFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
metric_action_id: $metric_action_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"metric_action_id": 42
}
Response
{"data": {"MetricActionFileDelete": false}}
MetricActionUpdate
Description
Update given metric action
Response
Returns an AdminMetricAction
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
type - MetricActionTypeEnum
|
|
status - MetricActionStatusEnum
|
|
webhook_url - String
|
The webhook url to which metric action fulfilment event is pushed |
user_subscription_installment_num - Int
|
The number of entitled user subscription installments of the metric action |
user_subscription_installment_time_unit - SubscriptionTimeUnitEnum
|
The time unit of the entitled user subscription installments of the metric action |
products - [ProductStackInput]
|
|
eligible_users - [Int]
|
|
metrics - [Int]
|
|
files - [MetricActionFileInput]
|
|
id - Int
|
Example
Query
mutation MetricActionUpdate(
$locale: String,
$name: String,
$title: [TranslationInput],
$content: [TranslationInput],
$type: MetricActionTypeEnum,
$status: MetricActionStatusEnum,
$webhook_url: String,
$user_subscription_installment_num: Int,
$user_subscription_installment_time_unit: SubscriptionTimeUnitEnum,
$products: [ProductStackInput],
$eligible_users: [Int],
$metrics: [Int],
$files: [MetricActionFileInput],
$id: Int
) {
MetricActionUpdate(
locale: $locale,
name: $name,
title: $title,
content: $content,
type: $type,
status: $status,
webhook_url: $webhook_url,
user_subscription_installment_num: $user_subscription_installment_num,
user_subscription_installment_time_unit: $user_subscription_installment_time_unit,
products: $products,
eligible_users: $eligible_users,
metrics: $metrics,
files: $files,
id: $id
) {
id
project_id
name
title
content
icons {
...FileFragment
}
images {
...FileFragment
}
files {
...FileFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
type
status
webhook_url
user_subscription_installment_num
user_subscription_installment_time_unit
created_at
updated_at
products {
...AdminProductListedAsRelationFragment
}
eligible_users {
...AdminUserFragment
}
metrics {
...AdminMetricFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"type": "user_entitlement",
"status": "inactive",
"webhook_url": "string",
"user_subscription_installment_num": 42,
"user_subscription_installment_time_unit": "day",
"products": [ProductStackInput],
"eligible_users": [42],
"metrics": [42],
"files": [MetricActionFileInput],
"id": 42
}
Response
{
"data": {
"MetricActionUpdate": {
"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]
}
}
}
MetricConditionCreate
Response
Returns an AdminMetricCondition
Arguments
| Name | Description |
|---|---|
type - MetricConditionTypeEnum
|
|
logic_operator - LogicOperatorEnum
|
|
value - String
|
|
metric_id - Int
|
Example
Query
mutation MetricConditionCreate(
$type: MetricConditionTypeEnum,
$logic_operator: LogicOperatorEnum,
$value: String,
$metric_id: Int
) {
MetricConditionCreate(
type: $type,
logic_operator: $logic_operator,
value: $value,
metric_id: $metric_id
) {
id
metric_id
type
logic_operator
value
created_at
updated_at
}
}
Variables
{
"type": "appa",
"logic_operator": "equals",
"value": "string",
"metric_id": 42
}
Response
{
"data": {
"MetricConditionCreate": {
"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"
}
}
}
MetricConditionDelete
Description
Delete an existing metric condition
MetricConditionUpdate
Description
Update given metric
Response
Returns an AdminMetricCondition
Arguments
| Name | Description |
|---|---|
type - MetricConditionTypeEnum
|
|
logic_operator - LogicOperatorEnum
|
|
value - String
|
|
id - Int
|
Example
Query
mutation MetricConditionUpdate(
$type: MetricConditionTypeEnum,
$logic_operator: LogicOperatorEnum,
$value: String,
$id: Int
) {
MetricConditionUpdate(
type: $type,
logic_operator: $logic_operator,
value: $value,
id: $id
) {
id
metric_id
type
logic_operator
value
created_at
updated_at
}
}
Variables
{
"type": "appa",
"logic_operator": "equals",
"value": "string",
"id": 42
}
Response
{
"data": {
"MetricConditionUpdate": {
"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"
}
}
}
MetricCreate
Description
Create a metric
Response
Returns an AdminMetric
Arguments
| Name | Description |
|---|---|
name - String
|
|
description - String
|
|
type - MetricTypeEnum
|
|
status - MetricStatusEnum
|
|
time_window - Int
|
|
published_from - String
|
|
published_until - String
|
|
categories - [Int]
|
|
articles - [Int]
|
|
products - [Int]
|
|
subscriptions - [Int]
|
|
eligible_users - [Int]
|
|
metric_actions - [Int]
|
|
project_id - Int
|
Example
Query
mutation MetricCreate(
$name: String,
$description: String,
$type: MetricTypeEnum,
$status: MetricStatusEnum,
$time_window: Int,
$published_from: String,
$published_until: String,
$categories: [Int],
$articles: [Int],
$products: [Int],
$subscriptions: [Int],
$eligible_users: [Int],
$metric_actions: [Int],
$project_id: Int
) {
MetricCreate(
name: $name,
description: $description,
type: $type,
status: $status,
time_window: $time_window,
published_from: $published_from,
published_until: $published_until,
categories: $categories,
articles: $articles,
products: $products,
subscriptions: $subscriptions,
eligible_users: $eligible_users,
metric_actions: $metric_actions,
project_id: $project_id
) {
id
project_id
name
description
time_window
type
published_from
published_until
created_at
updated_at
status
conditions {
...AdminMetricConditionFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
products {
...AdminProductFragment
}
subscriptions {
...AdminSubscriptionFragment
}
eligible_users {
...AdminUserFragment
}
metric_actions {
...AdminMetricActionFragment
}
}
}
Variables
{
"name": "string",
"description": "string",
"type": "article",
"status": "inactive",
"time_window": 42,
"published_from": "string",
"published_until": "string",
"categories": [42],
"articles": [42],
"products": [42],
"subscriptions": [42],
"eligible_users": [42],
"metric_actions": [42],
"project_id": 42
}
Response
{
"data": {
"MetricCreate": {
"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]
}
}
}
MetricDelete
Description
Delete an existing metric
MetricEvaluateMutation
Description
Evaluate given metric
MetricUpdate
Description
Update given metric
Response
Returns an AdminMetric
Arguments
| Name | Description |
|---|---|
name - String
|
|
description - String
|
|
type - MetricTypeEnum
|
|
status - MetricStatusEnum
|
|
time_window - Int
|
|
published_from - String
|
|
published_until - String
|
|
categories - [Int]
|
|
articles - [Int]
|
|
products - [Int]
|
|
subscriptions - [Int]
|
|
eligible_users - [Int]
|
|
conditions - [Int]
|
|
metric_actions - [Int]
|
|
id - Int
|
Example
Query
mutation MetricUpdate(
$name: String,
$description: String,
$type: MetricTypeEnum,
$status: MetricStatusEnum,
$time_window: Int,
$published_from: String,
$published_until: String,
$categories: [Int],
$articles: [Int],
$products: [Int],
$subscriptions: [Int],
$eligible_users: [Int],
$conditions: [Int],
$metric_actions: [Int],
$id: Int
) {
MetricUpdate(
name: $name,
description: $description,
type: $type,
status: $status,
time_window: $time_window,
published_from: $published_from,
published_until: $published_until,
categories: $categories,
articles: $articles,
products: $products,
subscriptions: $subscriptions,
eligible_users: $eligible_users,
conditions: $conditions,
metric_actions: $metric_actions,
id: $id
) {
id
project_id
name
description
time_window
type
published_from
published_until
created_at
updated_at
status
conditions {
...AdminMetricConditionFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
products {
...AdminProductFragment
}
subscriptions {
...AdminSubscriptionFragment
}
eligible_users {
...AdminUserFragment
}
metric_actions {
...AdminMetricActionFragment
}
}
}
Variables
{
"name": "string",
"description": "string",
"type": "article",
"status": "inactive",
"time_window": 42,
"published_from": "string",
"published_until": "string",
"categories": [42],
"articles": [42],
"products": [42],
"subscriptions": [42],
"eligible_users": [42],
"conditions": [42],
"metric_actions": [42],
"id": 42
}
Response
{
"data": {
"MetricUpdate": {
"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]
}
}
}
NotificationCreate
Response
Returns an AdminNotification
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
locale - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
url - String
|
The url/link belonging to the notification |
delivery_type - NotificationDeliveryTypeEnum
|
Default = personalised_users_on_topic |
type - NotificationTypeEnum
|
|
status - Int
|
|
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the notification |
frequency - Float
|
The notification frequency per time unit |
schedule_at - String
|
|
articles - [Int]
|
|
categories - [Int]
|
|
notification_topics - [Int]
|
|
notification_channel_contexts - [NotificationChannelContextEnum]
|
Default = [push] |
project_id - Int
|
Example
Query
mutation NotificationCreate(
$name: String,
$parent_id: Int,
$locale: String,
$title: [TranslationInput],
$content: [TranslationInput],
$url: String,
$delivery_type: NotificationDeliveryTypeEnum,
$type: NotificationTypeEnum,
$status: Int,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$schedule_at: String,
$articles: [Int],
$categories: [Int],
$notification_topics: [Int],
$notification_channel_contexts: [NotificationChannelContextEnum],
$project_id: Int
) {
NotificationCreate(
name: $name,
parent_id: $parent_id,
locale: $locale,
title: $title,
content: $content,
url: $url,
delivery_type: $delivery_type,
type: $type,
status: $status,
time_unit: $time_unit,
frequency: $frequency,
schedule_at: $schedule_at,
articles: $articles,
categories: $categories,
notification_topics: $notification_topics,
notification_channel_contexts: $notification_channel_contexts,
project_id: $project_id
) {
id
project_id
parent_id
name
title
content
url
delivery_type
type
notification_channel_contexts
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
children {
...AdminNotificationFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
frequency
time_unit
status
schedule_at
delivered_at
created_at
updated_at
}
}
Variables
{
"name": "string",
"parent_id": 42,
"locale": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"url": "string",
"delivery_type": "personalised_users_on_topic",
"type": "single",
"status": 42,
"time_unit": "day",
"frequency": 987.65,
"schedule_at": "string",
"articles": [42],
"categories": [42],
"notification_topics": [42],
"notification_channel_contexts": ["push"],
"project_id": 42
}
Response
{
"data": {
"NotificationCreate": {
"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"
}
}
}
NotificationDelete
Description
Delete an existing notification
NotificationFileDelete
Description
Delete a file for a given notification
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
notification_id - Int
|
Example
Query
mutation NotificationFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$notification_id: Int
) {
NotificationFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
notification_id: $notification_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"notification_id": 42
}
Response
{"data": {"NotificationFileDelete": false}}
NotificationNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation NotificationNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
NotificationNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"NotificationNodeUpdate": true}}
NotificationTopicCreate
Response
Returns an AdminNotificationTopic
Arguments
| Name | Description |
|---|---|
name - String
|
|
locale - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
type - NotificationTopicTypeEnum
|
|
status - Int
|
|
notifications - [Int]
|
|
project_id - Int
|
Example
Query
mutation NotificationTopicCreate(
$name: String,
$locale: String,
$title: [TranslationInput],
$description: [TranslationInput],
$type: NotificationTopicTypeEnum,
$status: Int,
$notifications: [Int],
$project_id: Int
) {
NotificationTopicCreate(
name: $name,
locale: $locale,
title: $title,
description: $description,
type: $type,
status: $status,
notifications: $notifications,
project_id: $project_id
) {
id
remote_notification_topic_id
project_id
name
title
description
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
notifications {
...AdminNotificationFragment
}
type
status
created_at
updated_at
}
}
Variables
{
"name": "string",
"locale": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"type": "general",
"status": 42,
"notifications": [42],
"project_id": 42
}
Response
{
"data": {
"NotificationTopicCreate": {
"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"
}
}
}
NotificationTopicDelete
Description
Delete an existing notification topic
NotificationTopicUpdate
Description
Update given notification topic
Response
Returns an AdminNotificationTopic
Arguments
| Name | Description |
|---|---|
name - String
|
|
locale - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
type - NotificationTopicTypeEnum
|
|
status - Int
|
|
notifications - [Int]
|
|
id - Int
|
Example
Query
mutation NotificationTopicUpdate(
$name: String,
$locale: String,
$title: [TranslationInput],
$description: [TranslationInput],
$type: NotificationTopicTypeEnum,
$status: Int,
$notifications: [Int],
$id: Int
) {
NotificationTopicUpdate(
name: $name,
locale: $locale,
title: $title,
description: $description,
type: $type,
status: $status,
notifications: $notifications,
id: $id
) {
id
remote_notification_topic_id
project_id
name
title
description
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
notifications {
...AdminNotificationFragment
}
type
status
created_at
updated_at
}
}
Variables
{
"name": "string",
"locale": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"type": "general",
"status": 42,
"notifications": [42],
"id": 42
}
Response
{
"data": {
"NotificationTopicUpdate": {
"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"
}
}
}
NotificationUpdate
Description
Update given notification
Response
Returns an AdminNotification
Arguments
| Name | Description |
|---|---|
name - String
|
|
parent_id - Int
|
|
locale - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
url - String
|
The url/link belonging to the notification |
delivery_type - NotificationDeliveryTypeEnum
|
|
type - NotificationTypeEnum
|
|
status - Int
|
|
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the notification |
frequency - Float
|
The notification frequency per time unit |
schedule_at - String
|
|
articles - [Int]
|
|
categories - [Int]
|
|
notification_topics - [Int]
|
|
notification_channel_contexts - [NotificationChannelContextEnum]
|
|
files - [NotificationFileInput]
|
|
id - Int
|
Example
Query
mutation NotificationUpdate(
$name: String,
$parent_id: Int,
$locale: String,
$title: [TranslationInput],
$content: [TranslationInput],
$url: String,
$delivery_type: NotificationDeliveryTypeEnum,
$type: NotificationTypeEnum,
$status: Int,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$schedule_at: String,
$articles: [Int],
$categories: [Int],
$notification_topics: [Int],
$notification_channel_contexts: [NotificationChannelContextEnum],
$files: [NotificationFileInput],
$id: Int
) {
NotificationUpdate(
name: $name,
parent_id: $parent_id,
locale: $locale,
title: $title,
content: $content,
url: $url,
delivery_type: $delivery_type,
type: $type,
status: $status,
time_unit: $time_unit,
frequency: $frequency,
schedule_at: $schedule_at,
articles: $articles,
categories: $categories,
notification_topics: $notification_topics,
notification_channel_contexts: $notification_channel_contexts,
files: $files,
id: $id
) {
id
project_id
parent_id
name
title
content
url
delivery_type
type
notification_channel_contexts
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
files {
...FileFragment
}
children {
...AdminNotificationFragment
}
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
articles {
...AdminArticleFragment
}
categories {
...AdminCategoryFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
frequency
time_unit
status
schedule_at
delivered_at
created_at
updated_at
}
}
Variables
{
"name": "string",
"parent_id": 42,
"locale": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"url": "string",
"delivery_type": "generic_users_on_topic",
"type": "single",
"status": 42,
"time_unit": "day",
"frequency": 123.45,
"schedule_at": "string",
"articles": [42],
"categories": [42],
"notification_topics": [42],
"notification_channel_contexts": ["sms"],
"files": [NotificationFileInput],
"id": 42
}
Response
{
"data": {
"NotificationUpdate": {
"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"
}
}
}
OauthProviderCreate
Description
Create an OauthProvider
Response
Returns an AdminOauthProvider
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
call_to_action_tag - [TranslationInput]
|
|
is_auto_create_user - Boolean
|
If a local User account does not yet exists for the remote OAuth2 Users e-mail address, automatically create a local User account and authenticate a session (alternatively, a User will be redirected to the originating frontend url for further processing). Default = false |
allowed_origin_domains - [String]
|
A list of allowed domain names and/or urls, from which an OAuth2 authentication request may be initiated (configured WEB-template domain is always whitelisted). |
client_id - String
|
|
client_secret - String
|
|
status - OauthProviderStatusEnum
|
|
type - OauthProviderTypeEnum
|
|
scopes - [String]
|
|
scope_separator - String
|
|
auth_url - String
|
|
token_url - String
|
|
user_info_url - String
|
|
email_info_url - String
|
|
user_map - String
|
|
custom_data - String
|
|
project_id - Int
|
Example
Query
mutation OauthProviderCreate(
$locale: String,
$name: String,
$call_to_action_tag: [TranslationInput],
$is_auto_create_user: Boolean,
$allowed_origin_domains: [String],
$client_id: String,
$client_secret: String,
$status: OauthProviderStatusEnum,
$type: OauthProviderTypeEnum,
$scopes: [String],
$scope_separator: String,
$auth_url: String,
$token_url: String,
$user_info_url: String,
$email_info_url: String,
$user_map: String,
$custom_data: String,
$project_id: Int
) {
OauthProviderCreate(
locale: $locale,
name: $name,
call_to_action_tag: $call_to_action_tag,
is_auto_create_user: $is_auto_create_user,
allowed_origin_domains: $allowed_origin_domains,
client_id: $client_id,
client_secret: $client_secret,
status: $status,
type: $type,
scopes: $scopes,
scope_separator: $scope_separator,
auth_url: $auth_url,
token_url: $token_url,
user_info_url: $user_info_url,
email_info_url: $email_info_url,
user_map: $user_map,
custom_data: $custom_data,
project_id: $project_id
) {
id
project_id
call_to_action_tag
name
call_to_action_tag_translations {
...TranslationFragment
}
is_auto_create_user
allowed_origin_domains
client_id
client_secret
redirect_url
status
type
scopes
scope_separator
auth_url
token_url
user_info_url
email_info_url
user_map
custom_data
created_at
updated_at
files {
...FileFragment
}
icons {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"call_to_action_tag": [TranslationInput],
"is_auto_create_user": false,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"status": "inactive",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "string",
"token_url": "string",
"user_info_url": "string",
"email_info_url": "string",
"user_map": "string",
"custom_data": "string",
"project_id": 42
}
Response
{
"data": {
"OauthProviderCreate": {
"id": 42,
"project_id": 42,
"call_to_action_tag": "string",
"name": "string",
"call_to_action_tag_translations": [Translation],
"is_auto_create_user": false,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"redirect_url": "https://url.example.com",
"status": "string",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "https://url.example.com",
"token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"email_info_url": "foo@example.com",
"user_map": "string",
"custom_data": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"files": [File],
"icons": [File]
}
}
}
OauthProviderDelete
Description
Delete an OauthProvider
OauthProviderFileDelete
Description
Delete a file for given OAuth2 Provider
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
oauth_provider_id - Int
|
Example
Query
mutation OauthProviderFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$oauth_provider_id: Int
) {
OauthProviderFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
oauth_provider_id: $oauth_provider_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"oauth_provider_id": 42
}
Response
{"data": {"OauthProviderFileDelete": false}}
OauthProviderNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation OauthProviderNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
OauthProviderNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"OauthProviderNodeUpdate": false}}
OauthProviderUpdate
Description
Update an OauthProvider
Response
Returns an AdminOauthProvider
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
call_to_action_tag - [TranslationInput]
|
|
is_auto_create_user - Boolean
|
If a local User account does not yet exists for the remote OAuth2 Users e-mail address, automatically create a local User account and authenticate a session (alternatively, a User will be redirected to the originating frontend url for further processing). Default = false |
allowed_origin_domains - [String]
|
A list of allowed domain names and/or urls, from which an OAuth2 authentication request may be initiated (configured WEB-template domain is always whitelisted). |
client_id - String
|
|
client_secret - String
|
|
status - OauthProviderStatusEnum
|
|
type - OauthProviderTypeEnum
|
|
scopes - [String]
|
|
scope_separator - String
|
|
auth_url - String
|
|
token_url - String
|
|
user_info_url - String
|
|
email_info_url - String
|
|
user_map - String
|
|
custom_data - String
|
|
id - Int
|
|
project_id - Int
|
Example
Query
mutation OauthProviderUpdate(
$locale: String,
$name: String,
$call_to_action_tag: [TranslationInput],
$is_auto_create_user: Boolean,
$allowed_origin_domains: [String],
$client_id: String,
$client_secret: String,
$status: OauthProviderStatusEnum,
$type: OauthProviderTypeEnum,
$scopes: [String],
$scope_separator: String,
$auth_url: String,
$token_url: String,
$user_info_url: String,
$email_info_url: String,
$user_map: String,
$custom_data: String,
$id: Int,
$project_id: Int
) {
OauthProviderUpdate(
locale: $locale,
name: $name,
call_to_action_tag: $call_to_action_tag,
is_auto_create_user: $is_auto_create_user,
allowed_origin_domains: $allowed_origin_domains,
client_id: $client_id,
client_secret: $client_secret,
status: $status,
type: $type,
scopes: $scopes,
scope_separator: $scope_separator,
auth_url: $auth_url,
token_url: $token_url,
user_info_url: $user_info_url,
email_info_url: $email_info_url,
user_map: $user_map,
custom_data: $custom_data,
id: $id,
project_id: $project_id
) {
id
project_id
call_to_action_tag
name
call_to_action_tag_translations {
...TranslationFragment
}
is_auto_create_user
allowed_origin_domains
client_id
client_secret
redirect_url
status
type
scopes
scope_separator
auth_url
token_url
user_info_url
email_info_url
user_map
custom_data
created_at
updated_at
files {
...FileFragment
}
icons {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"call_to_action_tag": [TranslationInput],
"is_auto_create_user": false,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"status": "inactive",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "string",
"token_url": "string",
"user_info_url": "string",
"email_info_url": "string",
"user_map": "string",
"custom_data": "string",
"id": 42,
"project_id": 42
}
Response
{
"data": {
"OauthProviderUpdate": {
"id": 42,
"project_id": 42,
"call_to_action_tag": "string",
"name": "string",
"call_to_action_tag_translations": [Translation],
"is_auto_create_user": false,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"redirect_url": "https://url.example.com",
"status": "string",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "https://url.example.com",
"token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"email_info_url": "foo@example.com",
"user_map": "string",
"custom_data": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"files": [File],
"icons": [File]
}
}
}
PageClone
Description
Clone a given page
Response
Returns an AdminPage
Example
Query
mutation PageClone(
$id: Int,
$name: String
) {
PageClone(
id: $id,
name: $name
) {
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 {
...AdminPageMetaFragment
}
components {
...AdminPageComponentFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
visibility
status
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
title_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{"id": 42, "name": "string"}
Response
{
"data": {
"PageClone": {
"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": [AdminPageMeta],
"components": [AdminPageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"visibility": "everyone",
"status": "string",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"title_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentCreate
Response
Returns an AdminPageComponent
Arguments
| Name | Description |
|---|---|
locale - String
|
|
category_id - Int
|
|
url - String
|
|
value - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
visibility - ResourceVisibilityEnum
|
|
style_type - String
|
|
display_type - PageComponentDisplayTypeEnum
|
|
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
resource_articles - [Int]
|
|
resource_categories - [Int]
|
|
resource_pages - [Int]
|
|
resource_products - [Int]
|
|
resource_subscriptions - [Int]
|
|
page_id - Int
|
|
type - PageComponentTypeEnum
|
Example
Query
mutation PageComponentCreate(
$locale: String,
$category_id: Int,
$url: String,
$value: String,
$title: [TranslationInput],
$content: [TranslationInput],
$visibility: ResourceVisibilityEnum,
$style_type: String,
$display_type: PageComponentDisplayTypeEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$resource_articles: [Int],
$resource_categories: [Int],
$resource_pages: [Int],
$resource_products: [Int],
$resource_subscriptions: [Int],
$page_id: Int,
$type: PageComponentTypeEnum
) {
PageComponentCreate(
locale: $locale,
category_id: $category_id,
url: $url,
value: $value,
title: $title,
content: $content,
visibility: $visibility,
style_type: $style_type,
display_type: $display_type,
status: $status,
subscriptions: $subscriptions,
products: $products,
resource_articles: $resource_articles,
resource_categories: $resource_categories,
resource_pages: $resource_pages,
resource_products: $resource_products,
resource_subscriptions: $resource_subscriptions,
page_id: $page_id,
type: $type
) {
id
page_id
parent_id
category_id
title
content
url
value
style_type
display_type
type
elements {
...AdminPageComponentElementFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"locale": "string",
"category_id": 42,
"url": "string",
"value": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"visibility": "everyone",
"style_type": "string",
"display_type": "sliding_carousel",
"status": 42,
"subscriptions": [42],
"products": [42],
"resource_articles": [42],
"resource_categories": [42],
"resource_pages": [42],
"resource_products": [42],
"resource_subscriptions": [42],
"page_id": 42,
"type": "account_create"
}
Response
{
"data": {
"PageComponentCreate": {
"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": [AdminPageComponentElement],
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentDelete
PageComponentElementCreate
Response
Returns an AdminPageComponentElement
Arguments
| Name | Description |
|---|---|
locale - String
|
|
url - String
|
|
value - String
|
|
toggle - Boolean
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
label - [TranslationInput]
|
|
visibility - ResourceVisibilityEnum
|
|
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
resource_articles - [Int]
|
|
resource_categories - [Int]
|
|
resource_pages - [Int]
|
|
resource_products - [Int]
|
|
resource_subscriptions - [Int]
|
|
page_component_id - Int
|
|
type - PageComponentElementTypeEnum
|
Example
Query
mutation PageComponentElementCreate(
$locale: String,
$url: String,
$value: String,
$toggle: Boolean,
$title: [TranslationInput],
$content: [TranslationInput],
$label: [TranslationInput],
$visibility: ResourceVisibilityEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$resource_articles: [Int],
$resource_categories: [Int],
$resource_pages: [Int],
$resource_products: [Int],
$resource_subscriptions: [Int],
$page_component_id: Int,
$type: PageComponentElementTypeEnum
) {
PageComponentElementCreate(
locale: $locale,
url: $url,
value: $value,
toggle: $toggle,
title: $title,
content: $content,
label: $label,
visibility: $visibility,
status: $status,
subscriptions: $subscriptions,
products: $products,
resource_articles: $resource_articles,
resource_categories: $resource_categories,
resource_pages: $resource_pages,
resource_products: $resource_products,
resource_subscriptions: $resource_subscriptions,
page_component_id: $page_component_id,
type: $type
) {
id
page_component_id
parent_id
type
title
content
label
url
value
toggle
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
label_translations {
...TranslationFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"locale": "string",
"url": "string",
"value": "string",
"toggle": false,
"title": [TranslationInput],
"content": [TranslationInput],
"label": [TranslationInput],
"visibility": "everyone",
"status": 42,
"subscriptions": [42],
"products": [42],
"resource_articles": [42],
"resource_categories": [42],
"resource_pages": [42],
"resource_products": [42],
"resource_subscriptions": [42],
"page_component_id": 42,
"type": "button_account_create"
}
Response
{
"data": {
"PageComponentElementCreate": {
"id": 42,
"page_component_id": 42,
"parent_id": 42,
"type": "string",
"title": "string",
"content": "string",
"label": "string",
"url": "https://url.example.com",
"value": "string",
"toggle": true,
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"resource_articles": [ArticleListedAsResource],
"resource_categories": [CategoryListedAsResource],
"resource_pages": [PageListedAsResource],
"resource_products": [ProductListedAsResource],
"resource_subscriptions": [
SubscriptionListedAsResource
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"label_translations": [Translation],
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentElementDelete
PageComponentElementFileDelete
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
page_component_element_id - Int
|
Example
Query
mutation PageComponentElementFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$page_component_element_id: Int
) {
PageComponentElementFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
page_component_element_id: $page_component_element_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_component_element_id": 42
}
Response
{"data": {"PageComponentElementFileDelete": false}}
PageComponentElementNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation PageComponentElementNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
PageComponentElementNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"PageComponentElementNodeUpdate": true}}
PageComponentElementUpdate
Response
Returns an AdminPageComponentElement
Arguments
| Name | Description |
|---|---|
locale - String
|
|
url - String
|
|
value - String
|
|
toggle - Boolean
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
label - [TranslationInput]
|
|
files - [PageComponentElementFileInput]
|
|
visibility - ResourceVisibilityEnum
|
|
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
resource_articles - [Int]
|
|
resource_categories - [Int]
|
|
resource_pages - [Int]
|
|
resource_products - [Int]
|
|
resource_subscriptions - [Int]
|
|
id - Int
|
Example
Query
mutation PageComponentElementUpdate(
$locale: String,
$url: String,
$value: String,
$toggle: Boolean,
$title: [TranslationInput],
$content: [TranslationInput],
$label: [TranslationInput],
$files: [PageComponentElementFileInput],
$visibility: ResourceVisibilityEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$resource_articles: [Int],
$resource_categories: [Int],
$resource_pages: [Int],
$resource_products: [Int],
$resource_subscriptions: [Int],
$id: Int
) {
PageComponentElementUpdate(
locale: $locale,
url: $url,
value: $value,
toggle: $toggle,
title: $title,
content: $content,
label: $label,
files: $files,
visibility: $visibility,
status: $status,
subscriptions: $subscriptions,
products: $products,
resource_articles: $resource_articles,
resource_categories: $resource_categories,
resource_pages: $resource_pages,
resource_products: $resource_products,
resource_subscriptions: $resource_subscriptions,
id: $id
) {
id
page_component_id
parent_id
type
title
content
label
url
value
toggle
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
label_translations {
...TranslationFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"locale": "string",
"url": "string",
"value": "string",
"toggle": false,
"title": [TranslationInput],
"content": [TranslationInput],
"label": [TranslationInput],
"files": [PageComponentElementFileInput],
"visibility": "everyone",
"status": 42,
"subscriptions": [42],
"products": [42],
"resource_articles": [42],
"resource_categories": [42],
"resource_pages": [42],
"resource_products": [42],
"resource_subscriptions": [42],
"id": 42
}
Response
{
"data": {
"PageComponentElementUpdate": {
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"label_translations": [Translation],
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageComponentFileDelete
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
page_component_id - Int
|
Example
Query
mutation PageComponentFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$page_component_id: Int
) {
PageComponentFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
page_component_id: $page_component_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_component_id": 42
}
Response
{"data": {"PageComponentFileDelete": true}}
PageComponentNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation PageComponentNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
PageComponentNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"PageComponentNodeUpdate": false}}
PageComponentUpdate
Response
Returns an AdminPageComponent
Arguments
| Name | Description |
|---|---|
locale - String
|
|
category_id - Int
|
|
url - String
|
|
value - String
|
|
title - [TranslationInput]
|
|
content - [TranslationInput]
|
|
files - [PageComponentFileInput]
|
|
visibility - ResourceVisibilityEnum
|
|
style_type - String
|
|
display_type - PageComponentDisplayTypeEnum
|
|
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
resource_articles - [Int]
|
|
resource_categories - [Int]
|
|
resource_pages - [Int]
|
|
resource_products - [Int]
|
|
resource_subscriptions - [Int]
|
|
id - Int
|
Example
Query
mutation PageComponentUpdate(
$locale: String,
$category_id: Int,
$url: String,
$value: String,
$title: [TranslationInput],
$content: [TranslationInput],
$files: [PageComponentFileInput],
$visibility: ResourceVisibilityEnum,
$style_type: String,
$display_type: PageComponentDisplayTypeEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$resource_articles: [Int],
$resource_categories: [Int],
$resource_pages: [Int],
$resource_products: [Int],
$resource_subscriptions: [Int],
$id: Int
) {
PageComponentUpdate(
locale: $locale,
category_id: $category_id,
url: $url,
value: $value,
title: $title,
content: $content,
files: $files,
visibility: $visibility,
style_type: $style_type,
display_type: $display_type,
status: $status,
subscriptions: $subscriptions,
products: $products,
resource_articles: $resource_articles,
resource_categories: $resource_categories,
resource_pages: $resource_pages,
resource_products: $resource_products,
resource_subscriptions: $resource_subscriptions,
id: $id
) {
id
page_id
parent_id
category_id
title
content
url
value
style_type
display_type
type
elements {
...AdminPageComponentElementFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
resource_articles {
...ArticleListedAsResourceFragment
}
resource_categories {
...CategoryListedAsResourceFragment
}
resource_pages {
...PageListedAsResourceFragment
}
resource_products {
...ProductListedAsResourceFragment
}
resource_subscriptions {
...SubscriptionListedAsResourceFragment
}
visibility
title_translations {
...TranslationFragment
}
content_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"locale": "string",
"category_id": 42,
"url": "string",
"value": "string",
"title": [TranslationInput],
"content": [TranslationInput],
"files": [PageComponentFileInput],
"visibility": "everyone",
"style_type": "string",
"display_type": "sliding_carousel",
"status": 42,
"subscriptions": [42],
"products": [42],
"resource_articles": [42],
"resource_categories": [42],
"resource_pages": [42],
"resource_products": [42],
"resource_subscriptions": [42],
"id": 42
}
Response
{
"data": {
"PageComponentUpdate": {
"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": [AdminPageComponentElement],
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageCreate
Response
Returns an AdminPage
Arguments
| Name | Description |
|---|---|
name - String
|
|
locale - String
|
|
category_id - Int
|
|
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
title - [TranslationInput]
|
|
metas - [PageMetaInput]
|
|
platform_contexts - [PlatformContextEnum]
|
|
visibility - ResourceVisibilityEnum
|
Default = everyone |
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
locale_regions - [Int]
|
|
geo_regions - [Int]
|
|
is_in_sitemap - Boolean
|
|
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended). Default = true |
project_id - Int
|
|
type - PageTypeEnum
|
Example
Query
mutation PageCreate(
$name: String,
$locale: String,
$category_id: Int,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$title: [TranslationInput],
$metas: [PageMetaInput],
$platform_contexts: [PlatformContextEnum],
$visibility: ResourceVisibilityEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$locale_regions: [Int],
$geo_regions: [Int],
$is_in_sitemap: Boolean,
$is_enforce_lowercase_urls: Boolean,
$project_id: Int,
$type: PageTypeEnum
) {
PageCreate(
name: $name,
locale: $locale,
category_id: $category_id,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
title: $title,
metas: $metas,
platform_contexts: $platform_contexts,
visibility: $visibility,
status: $status,
subscriptions: $subscriptions,
products: $products,
locale_regions: $locale_regions,
geo_regions: $geo_regions,
is_in_sitemap: $is_in_sitemap,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
project_id: $project_id,
type: $type
) {
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 {
...AdminPageMetaFragment
}
components {
...AdminPageComponentFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
visibility
status
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
title_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"name": "string",
"locale": "string",
"category_id": 42,
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"title": [TranslationInput],
"metas": [PageMetaInput],
"platform_contexts": ["web"],
"visibility": "everyone",
"status": 42,
"subscriptions": [42],
"products": [42],
"locale_regions": [42],
"geo_regions": [42],
"is_in_sitemap": false,
"is_enforce_lowercase_urls": true,
"project_id": 42,
"type": "account_delete"
}
Response
{
"data": {
"PageCreate": {
"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": [AdminPageMeta],
"components": [AdminPageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"visibility": "everyone",
"status": "string",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"title_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PageDelete
PageFileDelete
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
page_id - Int
|
Example
Query
mutation PageFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$page_id: Int
) {
PageFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
page_id: $page_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_id": 42
}
Response
{"data": {"PageFileDelete": false}}
PageNodeUpdate
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
pivot_id - Int
|
|
pivot_action - NodePivotActionEnum
|
Example
Query
mutation PageNodeUpdate(
$id: Int,
$pivot_id: Int,
$pivot_action: NodePivotActionEnum
) {
PageNodeUpdate(
id: $id,
pivot_id: $pivot_id,
pivot_action: $pivot_action
)
}
Variables
{"id": 42, "pivot_id": 42, "pivot_action": "after"}
Response
{"data": {"PageNodeUpdate": true}}
PageUpdate
Response
Returns an AdminPage
Arguments
| Name | Description |
|---|---|
name - String
|
|
locale - String
|
|
category_id - Int
|
|
url_slug - [TranslationInput]
|
|
full_url_slug - [TranslationInput]
|
|
canonical_url - [TranslationInput]
|
|
title - [TranslationInput]
|
|
files - [PageFileInput]
|
|
metas - [PageMetaInput]
|
|
platform_contexts - [PlatformContextEnum]
|
|
visibility - ResourceVisibilityEnum
|
|
status - Int
|
|
subscriptions - [Int]
|
|
products - [Int]
|
|
locale_regions - [Int]
|
|
geo_regions - [Int]
|
|
is_in_sitemap - Boolean
|
|
is_enforce_lowercase_urls - Boolean
|
Enforce all url and slug values in the mutation to be processed in lowercase (recommended). Default = true |
id - Int
|
Example
Query
mutation PageUpdate(
$name: String,
$locale: String,
$category_id: Int,
$url_slug: [TranslationInput],
$full_url_slug: [TranslationInput],
$canonical_url: [TranslationInput],
$title: [TranslationInput],
$files: [PageFileInput],
$metas: [PageMetaInput],
$platform_contexts: [PlatformContextEnum],
$visibility: ResourceVisibilityEnum,
$status: Int,
$subscriptions: [Int],
$products: [Int],
$locale_regions: [Int],
$geo_regions: [Int],
$is_in_sitemap: Boolean,
$is_enforce_lowercase_urls: Boolean,
$id: Int
) {
PageUpdate(
name: $name,
locale: $locale,
category_id: $category_id,
url_slug: $url_slug,
full_url_slug: $full_url_slug,
canonical_url: $canonical_url,
title: $title,
files: $files,
metas: $metas,
platform_contexts: $platform_contexts,
visibility: $visibility,
status: $status,
subscriptions: $subscriptions,
products: $products,
locale_regions: $locale_regions,
geo_regions: $geo_regions,
is_in_sitemap: $is_in_sitemap,
is_enforce_lowercase_urls: $is_enforce_lowercase_urls,
id: $id
) {
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 {
...AdminPageMetaFragment
}
components {
...AdminPageComponentFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
documents {
...FileFragment
}
files {
...FileFragment
}
visibility
status
url_slug_translations {
...TranslationFragment
}
full_url_slug_translations {
...TranslationFragment
}
canonical_url_translations {
...TranslationFragment
}
title_translations {
...TranslationFragment
}
category {
...AdminCategoryFragment
}
subscriptions {
...AdminSubscriptionFragment
}
products {
...AdminProductFragment
}
}
}
Variables
{
"name": "string",
"locale": "string",
"category_id": 42,
"url_slug": [TranslationInput],
"full_url_slug": [TranslationInput],
"canonical_url": [TranslationInput],
"title": [TranslationInput],
"files": [PageFileInput],
"metas": [PageMetaInput],
"platform_contexts": ["web"],
"visibility": "everyone",
"status": 42,
"subscriptions": [42],
"products": [42],
"locale_regions": [42],
"geo_regions": [42],
"is_in_sitemap": false,
"is_enforce_lowercase_urls": true,
"id": 42
}
Response
{
"data": {
"PageUpdate": {
"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": [AdminPageMeta],
"components": [AdminPageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"visibility": "everyone",
"status": "string",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"title_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
}
}
PaymentProviderActivate
Response
Returns an AdminPaymentProvider
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation PaymentProviderActivate($id: Int) {
PaymentProviderActivate(id: $id) {
id
project_id
name
description
type
status
device_capability
order_description_template
recurring_order_description_template
collection_window_day_num
amount_payment_method_change
default_currency
default_currency_symbol
status_message
connect_status
connect_status_message
remote_profile_status
remote_profile_status_message
is_configurable
is_support_connect_flow
remote_account {
...AdminPaymentProviderRemoteAccountFragment
}
remote_profile_id
remote_organisation_id
}
}
Variables
{"id": 42}
Response
{
"data": {
"PaymentProviderActivate": {
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42,
"order_description_template": "string",
"recurring_order_description_template": "string",
"collection_window_day_num": 42,
"amount_payment_method_change": 123.45,
"default_currency": "EUR",
"default_currency_symbol": "EUR",
"status_message": "string",
"connect_status": "string",
"connect_status_message": "string",
"remote_profile_status": "string",
"remote_profile_status_message": "string",
"is_configurable": true,
"is_support_connect_flow": true,
"remote_account": AdminPaymentProviderRemoteAccount,
"remote_profile_id": "string",
"remote_organisation_id": "string"
}
}
}
PaymentProviderConnectRequest
Response
Returns an AdminPaymentProviderConnectRequest
Example
Query
mutation PaymentProviderConnectRequest(
$id: Int,
$redirect_url: String
) {
PaymentProviderConnectRequest(
id: $id,
redirect_url: $redirect_url
) {
project_id
state_parameter
authorization_url
redirect_url
}
}
Variables
{"id": 42, "redirect_url": "string"}
Response
{
"data": {
"PaymentProviderConnectRequest": {
"project_id": 42,
"state_parameter": "string",
"authorization_url": "https://url.example.com",
"redirect_url": "https://url.example.com"
}
}
}
PaymentProviderDisconnectRequest
Example
Query
mutation PaymentProviderDisconnectRequest(
$id: Int,
$password: String
) {
PaymentProviderDisconnectRequest(
id: $id,
password: $password
)
}
Variables
{"id": 42, "password": "string"}
Response
{"data": {"PaymentProviderDisconnectRequest": false}}
PaymentProviderUpdate
Response
Returns an AdminPaymentProvider
Arguments
| Name | Description |
|---|---|
id - Int
|
|
order_description_template - String
|
Template for a short order description (i.e. the descriptor visible in the bank transaction) |
recurring_order_description_template - String
|
Template for a short recurring order description (i.e. the descriptor visible in the bank transaction) |
collection_window_day_num - Int
|
The number of days before a subscription expiry, at which date a recurring payment order (renewal) is issued |
amount_payment_method_change - Float
|
The amount charged for changing a (recurring) payment method, equal or greater than 1 smallest currency unit (e.g. €0.01) |
default_currency - String
|
3-letter currency code used by default when no specific currency is configured |
default_currency_symbol - String
|
ISO currency symbol related to the default_currency |
remote_profile_id - String
|
The profile id to be configured for the remote account (currently applicable for provider "Mollie") |
Example
Query
mutation PaymentProviderUpdate(
$id: Int,
$order_description_template: String,
$recurring_order_description_template: String,
$collection_window_day_num: Int,
$amount_payment_method_change: Float,
$default_currency: String,
$default_currency_symbol: String,
$remote_profile_id: String
) {
PaymentProviderUpdate(
id: $id,
order_description_template: $order_description_template,
recurring_order_description_template: $recurring_order_description_template,
collection_window_day_num: $collection_window_day_num,
amount_payment_method_change: $amount_payment_method_change,
default_currency: $default_currency,
default_currency_symbol: $default_currency_symbol,
remote_profile_id: $remote_profile_id
) {
id
project_id
name
description
type
status
device_capability
order_description_template
recurring_order_description_template
collection_window_day_num
amount_payment_method_change
default_currency
default_currency_symbol
status_message
connect_status
connect_status_message
remote_profile_status
remote_profile_status_message
is_configurable
is_support_connect_flow
remote_account {
...AdminPaymentProviderRemoteAccountFragment
}
remote_profile_id
remote_organisation_id
}
}
Variables
{
"id": 42,
"order_description_template": "string",
"recurring_order_description_template": "string",
"collection_window_day_num": 42,
"amount_payment_method_change": 123.45,
"default_currency": "string",
"default_currency_symbol": "string",
"remote_profile_id": "string"
}
Response
{
"data": {
"PaymentProviderUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42,
"order_description_template": "string",
"recurring_order_description_template": "string",
"collection_window_day_num": 42,
"amount_payment_method_change": 123.45,
"default_currency": "EUR",
"default_currency_symbol": "EUR",
"status_message": "string",
"connect_status": "string",
"connect_status_message": "string",
"remote_profile_status": "string",
"remote_profile_status_message": "string",
"is_configurable": true,
"is_support_connect_flow": true,
"remote_account": AdminPaymentProviderRemoteAccount,
"remote_profile_id": "string",
"remote_organisation_id": "string"
}
}
}
PaymentSyndicateCreate
Response
Returns an AdminPaymentSyndicate
Arguments
| Name | Description |
|---|---|
name - String
|
|
type - PaymentSyndicateTypeEnum
|
|
project_id - Int
|
Example
Query
mutation PaymentSyndicateCreate(
$name: String,
$type: PaymentSyndicateTypeEnum,
$project_id: Int
) {
PaymentSyndicateCreate(
name: $name,
type: $type,
project_id: $project_id
) {
id
project_id
name
type
created_at
updated_at
vouchers {
...AdminPaymentSyndicateVoucherFragment
}
}
}
Variables
{
"name": "string",
"type": "internal",
"project_id": 42
}
Response
{
"data": {
"PaymentSyndicateCreate": {
"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]
}
}
}
PaymentSyndicateDelete
PaymentSyndicateUpdate
Response
Returns an AdminPaymentSyndicate
Arguments
| Name | Description |
|---|---|
name - String
|
|
type - PaymentSyndicateTypeEnum
|
|
id - Int
|
Example
Query
mutation PaymentSyndicateUpdate(
$name: String,
$type: PaymentSyndicateTypeEnum,
$id: Int
) {
PaymentSyndicateUpdate(
name: $name,
type: $type,
id: $id
) {
id
project_id
name
type
created_at
updated_at
vouchers {
...AdminPaymentSyndicateVoucherFragment
}
}
}
Variables
{
"name": "string",
"type": "internal",
"id": 42
}
Response
{
"data": {
"PaymentSyndicateUpdate": {
"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]
}
}
}
PaymentSyndicateVoucherCodeBatchCreate
Response
Returns an AdminPaymentSyndicateVoucherCodeBatch
Example
Query
mutation PaymentSyndicateVoucherCodeBatchCreate(
$payment_syndicate_voucher_id: Int,
$codes: [String],
$code_num: Int
) {
PaymentSyndicateVoucherCodeBatchCreate(
payment_syndicate_voucher_id: $payment_syndicate_voucher_id,
codes: $codes,
code_num: $code_num
) {
id
payment_syndicate_voucher_id
installment
created_at
updated_at
codes {
...AdminPaymentSyndicateVoucherCodesListedWithPaginationFragment
}
code_num
claimed_num
}
}
Variables
{
"payment_syndicate_voucher_id": 42,
"codes": ["string"],
"code_num": 42
}
Response
{
"data": {
"PaymentSyndicateVoucherCodeBatchCreate": {
"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
}
}
}
PaymentSyndicateVoucherCodeBatchDelete
PaymentSyndicateVoucherCreate
Response
Returns an AdminPaymentSyndicateVoucher
Arguments
| Name | Description |
|---|---|
locale - String
|
|
subscription_id - Int
|
|
payment_syndicate_id - Int
|
|
name - String
|
|
description - [TranslationInput]
|
|
amount - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
installment_num - Int
|
|
max_claimed_num - Int
|
|
max_claimed_per_user_num - Int
|
|
user_subscription_status_action - PaymentSyndicateVoucherUserSubscriptionStatusActionEnum
|
Default = activate |
is_allow_on_valid_subscription - Boolean
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
newsletter_list_id - String
|
|
discount_type - PaymentSyndicateVoucherDiscountTypeEnum
|
|
installment_type - PaymentSyndicateVoucherInstallmentTypeEnum
|
|
type - PaymentSyndicateVoucherTypeEnum
|
|
issue_installments_until - String
|
|
installed_at - String
|
|
expires_at - String
|
|
products - [ProductStackInput]
|
|
scoped_products - [Int]
|
|
eligible_email_addresses - [String]
|
|
project_id - Int
|
Example
Query
mutation PaymentSyndicateVoucherCreate(
$locale: String,
$subscription_id: Int,
$payment_syndicate_id: Int,
$name: String,
$description: [TranslationInput],
$amount: Float,
$currency: String,
$currency_symbol: String,
$installment_num: Int,
$max_claimed_num: Int,
$max_claimed_per_user_num: Int,
$user_subscription_status_action: PaymentSyndicateVoucherUserSubscriptionStatusActionEnum,
$is_allow_on_valid_subscription: Boolean,
$time_unit: SubscriptionTimeUnitEnum,
$newsletter_list_id: String,
$discount_type: PaymentSyndicateVoucherDiscountTypeEnum,
$installment_type: PaymentSyndicateVoucherInstallmentTypeEnum,
$type: PaymentSyndicateVoucherTypeEnum,
$issue_installments_until: String,
$installed_at: String,
$expires_at: String,
$products: [ProductStackInput],
$scoped_products: [Int],
$eligible_email_addresses: [String],
$project_id: Int
) {
PaymentSyndicateVoucherCreate(
locale: $locale,
subscription_id: $subscription_id,
payment_syndicate_id: $payment_syndicate_id,
name: $name,
description: $description,
amount: $amount,
currency: $currency,
currency_symbol: $currency_symbol,
installment_num: $installment_num,
max_claimed_num: $max_claimed_num,
max_claimed_per_user_num: $max_claimed_per_user_num,
user_subscription_status_action: $user_subscription_status_action,
is_allow_on_valid_subscription: $is_allow_on_valid_subscription,
time_unit: $time_unit,
newsletter_list_id: $newsletter_list_id,
discount_type: $discount_type,
installment_type: $installment_type,
type: $type,
issue_installments_until: $issue_installments_until,
installed_at: $installed_at,
expires_at: $expires_at,
products: $products,
scoped_products: $scoped_products,
eligible_email_addresses: $eligible_email_addresses,
project_id: $project_id
) {
id
project_id
description
name
payment_syndicate_id
subscription_id
description_translations {
...TranslationFragment
}
currency
currency_symbol
amount
installment_num
max_claimed_num
max_claimed_per_user_num
claimed_num
is_allow_on_valid_subscription
user_subscription_status_action
newsletter_list_id
time_unit
discount_type
installment_type
type
issue_installments_until
installed_at
expires_at
created_at
updated_at
syndicate {
...AdminPaymentSyndicateFragment
}
batches {
...AdminPaymentSyndicateVoucherCodeBatchFragment
}
scoped_products {
...AdminProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
subscription {
...AdminSubscriptionFragment
}
eligible_email_addresses
}
}
Variables
{
"locale": "string",
"subscription_id": 42,
"payment_syndicate_id": 42,
"name": "string",
"description": [TranslationInput],
"amount": 123.45,
"currency": "string",
"currency_symbol": "string",
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"user_subscription_status_action": "activate",
"is_allow_on_valid_subscription": true,
"time_unit": "day",
"newsletter_list_id": "string",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "string",
"expires_at": "string",
"products": [ProductStackInput],
"scoped_products": [42],
"eligible_email_addresses": ["string"],
"project_id": 42
}
Response
{
"data": {
"PaymentSyndicateVoucherCreate": {
"id": 42,
"project_id": 42,
"description": "string",
"name": "string",
"payment_syndicate_id": 42,
"subscription_id": 42,
"description_translations": [Translation],
"currency": "EUR",
"currency_symbol": "EUR",
"amount": 123.45,
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"claimed_num": 42,
"is_allow_on_valid_subscription": false,
"user_subscription_status_action": "string",
"newsletter_list_id": "string",
"time_unit": "day",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"syndicate": AdminPaymentSyndicate,
"batches": [AdminPaymentSyndicateVoucherCodeBatch],
"scoped_products": [AdminProduct],
"products": [AdminProductListedAsRelation],
"subscription": AdminSubscription,
"eligible_email_addresses": ["foo@example.com"]
}
}
}
PaymentSyndicateVoucherDelete
PaymentSyndicateVoucherUpdate
Response
Returns an AdminPaymentSyndicateVoucher
Arguments
| Name | Description |
|---|---|
locale - String
|
|
subscription_id - Int
|
|
payment_syndicate_id - Int
|
|
name - String
|
|
description - [TranslationInput]
|
|
amount - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
installment_num - Int
|
|
max_claimed_num - Int
|
|
max_claimed_per_user_num - Int
|
|
user_subscription_status_action - PaymentSyndicateVoucherUserSubscriptionStatusActionEnum
|
|
is_allow_on_valid_subscription - Boolean
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
newsletter_list_id - String
|
|
discount_type - PaymentSyndicateVoucherDiscountTypeEnum
|
|
installment_type - PaymentSyndicateVoucherInstallmentTypeEnum
|
|
type - PaymentSyndicateVoucherTypeEnum
|
|
issue_installments_until - String
|
|
installed_at - String
|
|
expires_at - String
|
|
products - [ProductStackInput]
|
|
scoped_products - [Int]
|
|
eligible_email_addresses - [String]
|
|
id - Int
|
Example
Query
mutation PaymentSyndicateVoucherUpdate(
$locale: String,
$subscription_id: Int,
$payment_syndicate_id: Int,
$name: String,
$description: [TranslationInput],
$amount: Float,
$currency: String,
$currency_symbol: String,
$installment_num: Int,
$max_claimed_num: Int,
$max_claimed_per_user_num: Int,
$user_subscription_status_action: PaymentSyndicateVoucherUserSubscriptionStatusActionEnum,
$is_allow_on_valid_subscription: Boolean,
$time_unit: SubscriptionTimeUnitEnum,
$newsletter_list_id: String,
$discount_type: PaymentSyndicateVoucherDiscountTypeEnum,
$installment_type: PaymentSyndicateVoucherInstallmentTypeEnum,
$type: PaymentSyndicateVoucherTypeEnum,
$issue_installments_until: String,
$installed_at: String,
$expires_at: String,
$products: [ProductStackInput],
$scoped_products: [Int],
$eligible_email_addresses: [String],
$id: Int
) {
PaymentSyndicateVoucherUpdate(
locale: $locale,
subscription_id: $subscription_id,
payment_syndicate_id: $payment_syndicate_id,
name: $name,
description: $description,
amount: $amount,
currency: $currency,
currency_symbol: $currency_symbol,
installment_num: $installment_num,
max_claimed_num: $max_claimed_num,
max_claimed_per_user_num: $max_claimed_per_user_num,
user_subscription_status_action: $user_subscription_status_action,
is_allow_on_valid_subscription: $is_allow_on_valid_subscription,
time_unit: $time_unit,
newsletter_list_id: $newsletter_list_id,
discount_type: $discount_type,
installment_type: $installment_type,
type: $type,
issue_installments_until: $issue_installments_until,
installed_at: $installed_at,
expires_at: $expires_at,
products: $products,
scoped_products: $scoped_products,
eligible_email_addresses: $eligible_email_addresses,
id: $id
) {
id
project_id
description
name
payment_syndicate_id
subscription_id
description_translations {
...TranslationFragment
}
currency
currency_symbol
amount
installment_num
max_claimed_num
max_claimed_per_user_num
claimed_num
is_allow_on_valid_subscription
user_subscription_status_action
newsletter_list_id
time_unit
discount_type
installment_type
type
issue_installments_until
installed_at
expires_at
created_at
updated_at
syndicate {
...AdminPaymentSyndicateFragment
}
batches {
...AdminPaymentSyndicateVoucherCodeBatchFragment
}
scoped_products {
...AdminProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
subscription {
...AdminSubscriptionFragment
}
eligible_email_addresses
}
}
Variables
{
"locale": "string",
"subscription_id": 42,
"payment_syndicate_id": 42,
"name": "string",
"description": [TranslationInput],
"amount": 987.65,
"currency": "string",
"currency_symbol": "string",
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"user_subscription_status_action": "none",
"is_allow_on_valid_subscription": false,
"time_unit": "day",
"newsletter_list_id": "string",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "string",
"expires_at": "string",
"products": [ProductStackInput],
"scoped_products": [42],
"eligible_email_addresses": ["string"],
"id": 42
}
Response
{
"data": {
"PaymentSyndicateVoucherUpdate": {
"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": false,
"user_subscription_status_action": "string",
"newsletter_list_id": "string",
"time_unit": "day",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"syndicate": AdminPaymentSyndicate,
"batches": [AdminPaymentSyndicateVoucherCodeBatch],
"scoped_products": [AdminProduct],
"products": [AdminProductListedAsRelation],
"subscription": AdminSubscription,
"eligible_email_addresses": ["foo@example.com"]
}
}
}
ProductCreate
Response
Returns an AdminProduct
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
description_short - [TranslationInput]
|
|
call_to_action_tag - [TranslationInput]
|
|
newsletter_list_id - String
|
|
discoverability - ProductDiscoverabilityEnum
|
|
type - ProductTypeEnum
|
|
credit_type - UserPaymentCreditTypeEnum
|
|
amount_balance - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
price - Float
|
|
credit_price - Float
|
|
credit_amount - Float
|
|
max_purchase_num - Int
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
frequency - Float
|
|
period_renewal_day - Int
|
|
is_sync_installments - Boolean
|
|
status - ProductStatusEnum
|
Default = unpublished |
recurring_entitlement_expires_in - Int
|
|
recurring_entitlement_expires_in_time_unit_num - Int
|
|
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
|
expires_in - Int
|
|
expires_at - String
|
|
published_from - String
|
|
published_until - String
|
|
articles - [Int]
|
|
categories - [Int]
|
|
issuable_vouchers - [Int]
|
|
notification_topics - [Int]
|
|
files - [ProductFileInput]
|
|
project_id - Int
|
Example
Query
mutation ProductCreate(
$locale: String,
$name: String,
$title: [TranslationInput],
$description: [TranslationInput],
$description_short: [TranslationInput],
$call_to_action_tag: [TranslationInput],
$newsletter_list_id: String,
$discoverability: ProductDiscoverabilityEnum,
$type: ProductTypeEnum,
$credit_type: UserPaymentCreditTypeEnum,
$amount_balance: Float,
$currency: String,
$currency_symbol: String,
$price: Float,
$credit_price: Float,
$credit_amount: Float,
$max_purchase_num: Int,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$period_renewal_day: Int,
$is_sync_installments: Boolean,
$status: ProductStatusEnum,
$recurring_entitlement_expires_in: Int,
$recurring_entitlement_expires_in_time_unit_num: Int,
$recurring_entitlement_expires_in_time_unit_midnight_offset: Int,
$expires_in: Int,
$expires_at: String,
$published_from: String,
$published_until: String,
$articles: [Int],
$categories: [Int],
$issuable_vouchers: [Int],
$notification_topics: [Int],
$files: [ProductFileInput],
$project_id: Int
) {
ProductCreate(
locale: $locale,
name: $name,
title: $title,
description: $description,
description_short: $description_short,
call_to_action_tag: $call_to_action_tag,
newsletter_list_id: $newsletter_list_id,
discoverability: $discoverability,
type: $type,
credit_type: $credit_type,
amount_balance: $amount_balance,
currency: $currency,
currency_symbol: $currency_symbol,
price: $price,
credit_price: $credit_price,
credit_amount: $credit_amount,
max_purchase_num: $max_purchase_num,
time_unit: $time_unit,
frequency: $frequency,
period_renewal_day: $period_renewal_day,
is_sync_installments: $is_sync_installments,
status: $status,
recurring_entitlement_expires_in: $recurring_entitlement_expires_in,
recurring_entitlement_expires_in_time_unit_num: $recurring_entitlement_expires_in_time_unit_num,
recurring_entitlement_expires_in_time_unit_midnight_offset: $recurring_entitlement_expires_in_time_unit_midnight_offset,
expires_in: $expires_in,
expires_at: $expires_at,
published_from: $published_from,
published_until: $published_until,
articles: $articles,
categories: $categories,
issuable_vouchers: $issuable_vouchers,
notification_topics: $notification_topics,
files: $files,
project_id: $project_id
) {
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 {
...AdminArticleFragment
}
categories {
...CategoryListedAsRelationFragment
}
period_renewal_day
is_sync_installments
frequency
time_unit
recurring_entitlement_expires_in_time_unit_midnight_offset
recurring_entitlement_expires_in_time_unit_num
recurring_entitlement_expires_in
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
call_to_action_tag_translations {
...TranslationFragment
}
discoverability
status
published_from
published_until
newsletter_list_id
issuable_vouchers {
...AdminPaymentSyndicateVoucherFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
files {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"description_short": [TranslationInput],
"call_to_action_tag": [TranslationInput],
"newsletter_list_id": "string",
"discoverability": "hidden",
"type": "article",
"credit_type": "general",
"amount_balance": 123.45,
"currency": "string",
"currency_symbol": "string",
"price": 123.45,
"credit_price": 123.45,
"credit_amount": 987.65,
"max_purchase_num": 42,
"time_unit": "day",
"frequency": 987.65,
"period_renewal_day": 42,
"is_sync_installments": false,
"status": "unpublished",
"recurring_entitlement_expires_in": 42,
"recurring_entitlement_expires_in_time_unit_num": 42,
"recurring_entitlement_expires_in_time_unit_midnight_offset": 42,
"expires_in": 42,
"expires_at": "string",
"published_from": "string",
"published_until": "string",
"articles": [42],
"categories": [42],
"issuable_vouchers": [42],
"notification_topics": [42],
"files": [ProductFileInput],
"project_id": 42
}
Response
{
"data": {
"ProductCreate": {
"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]
}
}
}
ProductDelete
ProductFileDelete
Description
Delete a file for a given product
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
product_id - Int
|
Example
Query
mutation ProductFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$product_id: Int
) {
ProductFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
product_id: $product_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"product_id": 42
}
Response
{"data": {"ProductFileDelete": true}}
ProductUpdate
Response
Returns an AdminProduct
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
description_short - [TranslationInput]
|
|
call_to_action_tag - [TranslationInput]
|
|
newsletter_list_id - String
|
|
discoverability - ProductDiscoverabilityEnum
|
|
type - ProductTypeEnum
|
|
credit_type - UserPaymentCreditTypeEnum
|
|
amount_balance - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
price - Float
|
|
credit_price - Float
|
|
credit_amount - Float
|
|
max_purchase_num - Int
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
frequency - Float
|
|
period_renewal_day - Int
|
|
is_sync_installments - Boolean
|
|
status - ProductStatusEnum
|
|
recurring_entitlement_expires_in - Int
|
|
recurring_entitlement_expires_in_time_unit_num - Int
|
|
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
|
expires_in - Int
|
|
expires_at - String
|
|
published_from - String
|
|
published_until - String
|
|
articles - [Int]
|
|
categories - [Int]
|
|
issuable_vouchers - [Int]
|
|
notification_topics - [Int]
|
|
files - [ProductFileInput]
|
|
id - Int
|
Example
Query
mutation ProductUpdate(
$locale: String,
$name: String,
$title: [TranslationInput],
$description: [TranslationInput],
$description_short: [TranslationInput],
$call_to_action_tag: [TranslationInput],
$newsletter_list_id: String,
$discoverability: ProductDiscoverabilityEnum,
$type: ProductTypeEnum,
$credit_type: UserPaymentCreditTypeEnum,
$amount_balance: Float,
$currency: String,
$currency_symbol: String,
$price: Float,
$credit_price: Float,
$credit_amount: Float,
$max_purchase_num: Int,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$period_renewal_day: Int,
$is_sync_installments: Boolean,
$status: ProductStatusEnum,
$recurring_entitlement_expires_in: Int,
$recurring_entitlement_expires_in_time_unit_num: Int,
$recurring_entitlement_expires_in_time_unit_midnight_offset: Int,
$expires_in: Int,
$expires_at: String,
$published_from: String,
$published_until: String,
$articles: [Int],
$categories: [Int],
$issuable_vouchers: [Int],
$notification_topics: [Int],
$files: [ProductFileInput],
$id: Int
) {
ProductUpdate(
locale: $locale,
name: $name,
title: $title,
description: $description,
description_short: $description_short,
call_to_action_tag: $call_to_action_tag,
newsletter_list_id: $newsletter_list_id,
discoverability: $discoverability,
type: $type,
credit_type: $credit_type,
amount_balance: $amount_balance,
currency: $currency,
currency_symbol: $currency_symbol,
price: $price,
credit_price: $credit_price,
credit_amount: $credit_amount,
max_purchase_num: $max_purchase_num,
time_unit: $time_unit,
frequency: $frequency,
period_renewal_day: $period_renewal_day,
is_sync_installments: $is_sync_installments,
status: $status,
recurring_entitlement_expires_in: $recurring_entitlement_expires_in,
recurring_entitlement_expires_in_time_unit_num: $recurring_entitlement_expires_in_time_unit_num,
recurring_entitlement_expires_in_time_unit_midnight_offset: $recurring_entitlement_expires_in_time_unit_midnight_offset,
expires_in: $expires_in,
expires_at: $expires_at,
published_from: $published_from,
published_until: $published_until,
articles: $articles,
categories: $categories,
issuable_vouchers: $issuable_vouchers,
notification_topics: $notification_topics,
files: $files,
id: $id
) {
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 {
...AdminArticleFragment
}
categories {
...CategoryListedAsRelationFragment
}
period_renewal_day
is_sync_installments
frequency
time_unit
recurring_entitlement_expires_in_time_unit_midnight_offset
recurring_entitlement_expires_in_time_unit_num
recurring_entitlement_expires_in
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
call_to_action_tag_translations {
...TranslationFragment
}
discoverability
status
published_from
published_until
newsletter_list_id
issuable_vouchers {
...AdminPaymentSyndicateVoucherFragment
}
notification_topics {
...AdminNotificationTopicFragment
}
files {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"description_short": [TranslationInput],
"call_to_action_tag": [TranslationInput],
"newsletter_list_id": "string",
"discoverability": "hidden",
"type": "article",
"credit_type": "general",
"amount_balance": 123.45,
"currency": "string",
"currency_symbol": "string",
"price": 123.45,
"credit_price": 123.45,
"credit_amount": 123.45,
"max_purchase_num": 42,
"time_unit": "day",
"frequency": 987.65,
"period_renewal_day": 42,
"is_sync_installments": true,
"status": "unpublished",
"recurring_entitlement_expires_in": 42,
"recurring_entitlement_expires_in_time_unit_num": 42,
"recurring_entitlement_expires_in_time_unit_midnight_offset": 42,
"expires_in": 42,
"expires_at": "string",
"published_from": "string",
"published_until": "string",
"articles": [42],
"categories": [42],
"issuable_vouchers": [42],
"notification_topics": [42],
"files": [ProductFileInput],
"id": 42
}
Response
{
"data": {
"ProductUpdate": {
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [AdminArticle],
"categories": [CategoryListedAsRelation],
"period_renewal_day": 42,
"is_sync_installments": false,
"frequency": 1,
"time_unit": "day",
"recurring_entitlement_expires_in_time_unit_midnight_offset": 86400,
"recurring_entitlement_expires_in_time_unit_num": 86400,
"recurring_entitlement_expires_in": 86400,
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"call_to_action_tag_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"published_from": "string",
"published_until": "string",
"newsletter_list_id": "string",
"issuable_vouchers": [AdminPaymentSyndicateVoucher],
"notification_topics": [AdminNotificationTopic],
"files": [File]
}
}
}
ProjectConfigListUpdate
Response
Returns an AdminProjectConfigsListedWithPagination
Arguments
| Name | Description |
|---|---|
project_id - Int
|
|
project_config_context - ProjectConfigContextEnum
|
|
password_current - String
|
|
items - [ProjectConfigInput]
|
Example
Query
mutation ProjectConfigListUpdate(
$project_id: Int,
$project_config_context: ProjectConfigContextEnum,
$password_current: String,
$items: [ProjectConfigInput]
) {
ProjectConfigListUpdate(
project_id: $project_id,
project_config_context: $project_config_context,
password_current: $password_current,
items: $items
) {
items {
...AdminProjectConfigFragment
}
pagination {
...PaginationFragment
}
}
}
Variables
{
"project_id": 42,
"project_config_context": "branding_web_custom_css",
"password_current": "string",
"items": [ProjectConfigInput]
}
Response
{
"data": {
"ProjectConfigListUpdate": {
"items": [AdminProjectConfig],
"pagination": Pagination
}
}
}
ProjectConfigUpdate
Response
Returns an AdminProjectConfig
Example
Query
mutation ProjectConfigUpdate(
$project_id: Int,
$id: Int,
$value: String
) {
ProjectConfigUpdate(
project_id: $project_id,
id: $id,
value: $value
) {
id
project_id
key
value
default_value
label
type
is_read_only
is_auth_only
related_file_type
created_at
updated_at
}
}
Variables
{
"project_id": 42,
"id": 42,
"value": "string"
}
Response
{
"data": {
"ProjectConfigUpdate": {
"id": 42,
"project_id": 42,
"key": "string",
"value": "string",
"default_value": "string",
"label": "string",
"type": "string",
"is_read_only": false,
"is_auth_only": false,
"related_file_type": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
}
}
SubscriptionCreate
Response
Returns an AdminSubscription
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
description_short - [TranslationInput]
|
|
newsletter_list_id - String
|
|
discoverability - SubscriptionDiscoverabilityEnum
|
|
type - SubscriptionTypeEnum
|
Default = svod |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
Default = all |
status - SubscriptionStatusEnum
|
Default = inactive |
price - Float
|
|
price_per_installment - Float
|
|
time_unit - SubscriptionTimeUnitEnum
|
Default = month |
frequency - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
initial_installment_num - Int
|
|
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
|
allow_suspend_after_installment_num - Int
|
|
max_concurrent_vod_stream_num - Int
|
|
user_subscription_status_action - SubscriptionUserSubscriptionStatusActionEnum
|
Default = activate |
project_id - Int
|
Example
Query
mutation SubscriptionCreate(
$locale: String,
$name: String,
$title: [TranslationInput],
$description: [TranslationInput],
$description_short: [TranslationInput],
$newsletter_list_id: String,
$discoverability: SubscriptionDiscoverabilityEnum,
$type: SubscriptionTypeEnum,
$entitlement_scope: SubscriptionEntitlementScopeEnum,
$status: SubscriptionStatusEnum,
$price: Float,
$price_per_installment: Float,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$currency: String,
$currency_symbol: String,
$initial_installment_num: Int,
$initial_installment_time_unit: SubscriptionTimeUnitEnum,
$allow_suspend_after_installment_num: Int,
$max_concurrent_vod_stream_num: Int,
$user_subscription_status_action: SubscriptionUserSubscriptionStatusActionEnum,
$project_id: Int
) {
SubscriptionCreate(
locale: $locale,
name: $name,
title: $title,
description: $description,
description_short: $description_short,
newsletter_list_id: $newsletter_list_id,
discoverability: $discoverability,
type: $type,
entitlement_scope: $entitlement_scope,
status: $status,
price: $price,
price_per_installment: $price_per_installment,
time_unit: $time_unit,
frequency: $frequency,
currency: $currency,
currency_symbol: $currency_symbol,
initial_installment_num: $initial_installment_num,
initial_installment_time_unit: $initial_installment_time_unit,
allow_suspend_after_installment_num: $allow_suspend_after_installment_num,
max_concurrent_vod_stream_num: $max_concurrent_vod_stream_num,
user_subscription_status_action: $user_subscription_status_action,
project_id: $project_id
) {
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 {
...AdminPaymentProviderListedAsRelationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
created_at
updated_at
user_subscription_status_action
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
discoverability
status
products {
...AdminProductListedAsRelationFragment
}
entitleable_articles {
...ArticleListedAsRelationFragment
}
files {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"description_short": [TranslationInput],
"newsletter_list_id": "string",
"discoverability": "hidden",
"type": "svod",
"entitlement_scope": "all",
"status": "inactive",
"price": 987.65,
"price_per_installment": 987.65,
"time_unit": "month",
"frequency": 987.65,
"currency": "string",
"currency_symbol": "string",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"user_subscription_status_action": "activate",
"project_id": 42
}
Response
{
"data": {
"SubscriptionCreate": {
"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]
}
}
}
SubscriptionDelete
SubscriptionFileDelete
Description
Delete a file for a given subscription
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
id - Int
|
|
type - FileTypeEnum
|
|
duration - Int
|
|
locale - String
|
|
subscription_id - Int
|
Example
Query
mutation SubscriptionFileDelete(
$id: Int,
$type: FileTypeEnum,
$duration: Int,
$locale: String,
$subscription_id: Int
) {
SubscriptionFileDelete(
id: $id,
type: $type,
duration: $duration,
locale: $locale,
subscription_id: $subscription_id
)
}
Variables
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"subscription_id": 42
}
Response
{"data": {"SubscriptionFileDelete": true}}
SubscriptionUpdate
Response
Returns an AdminSubscription
Arguments
| Name | Description |
|---|---|
locale - String
|
|
name - String
|
|
title - [TranslationInput]
|
|
description - [TranslationInput]
|
|
description_short - [TranslationInput]
|
|
newsletter_list_id - String
|
|
discoverability - SubscriptionDiscoverabilityEnum
|
|
type - SubscriptionTypeEnum
|
|
entitlement_scope - SubscriptionEntitlementScopeEnum
|
|
status - SubscriptionStatusEnum
|
|
price - Float
|
|
price_per_installment - Float
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
frequency - Float
|
|
currency - String
|
|
currency_symbol - String
|
|
initial_installment_num - Int
|
|
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
|
allow_suspend_after_installment_num - Int
|
|
max_concurrent_vod_stream_num - Int
|
|
user_subscription_status_action - SubscriptionUserSubscriptionStatusActionEnum
|
|
id - Int
|
|
products - [ProductStackInput]
|
|
payment_providers - [Int]
|
|
articles - [Int]
|
|
categories - [Int]
|
|
files - [SubscriptionFileInput]
|
Example
Query
mutation SubscriptionUpdate(
$locale: String,
$name: String,
$title: [TranslationInput],
$description: [TranslationInput],
$description_short: [TranslationInput],
$newsletter_list_id: String,
$discoverability: SubscriptionDiscoverabilityEnum,
$type: SubscriptionTypeEnum,
$entitlement_scope: SubscriptionEntitlementScopeEnum,
$status: SubscriptionStatusEnum,
$price: Float,
$price_per_installment: Float,
$time_unit: SubscriptionTimeUnitEnum,
$frequency: Float,
$currency: String,
$currency_symbol: String,
$initial_installment_num: Int,
$initial_installment_time_unit: SubscriptionTimeUnitEnum,
$allow_suspend_after_installment_num: Int,
$max_concurrent_vod_stream_num: Int,
$user_subscription_status_action: SubscriptionUserSubscriptionStatusActionEnum,
$id: Int,
$products: [ProductStackInput],
$payment_providers: [Int],
$articles: [Int],
$categories: [Int],
$files: [SubscriptionFileInput]
) {
SubscriptionUpdate(
locale: $locale,
name: $name,
title: $title,
description: $description,
description_short: $description_short,
newsletter_list_id: $newsletter_list_id,
discoverability: $discoverability,
type: $type,
entitlement_scope: $entitlement_scope,
status: $status,
price: $price,
price_per_installment: $price_per_installment,
time_unit: $time_unit,
frequency: $frequency,
currency: $currency,
currency_symbol: $currency_symbol,
initial_installment_num: $initial_installment_num,
initial_installment_time_unit: $initial_installment_time_unit,
allow_suspend_after_installment_num: $allow_suspend_after_installment_num,
max_concurrent_vod_stream_num: $max_concurrent_vod_stream_num,
user_subscription_status_action: $user_subscription_status_action,
id: $id,
products: $products,
payment_providers: $payment_providers,
articles: $articles,
categories: $categories,
files: $files
) {
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 {
...AdminPaymentProviderListedAsRelationFragment
}
icons {
...FileFragment
}
images {
...FileFragment
}
posters {
...FileFragment
}
videos {
...FileFragment
}
created_at
updated_at
user_subscription_status_action
title_translations {
...TranslationFragment
}
description_translations {
...TranslationFragment
}
description_short_translations {
...TranslationFragment
}
discoverability
status
products {
...AdminProductListedAsRelationFragment
}
entitleable_articles {
...ArticleListedAsRelationFragment
}
files {
...FileFragment
}
}
}
Variables
{
"locale": "string",
"name": "string",
"title": [TranslationInput],
"description": [TranslationInput],
"description_short": [TranslationInput],
"newsletter_list_id": "string",
"discoverability": "hidden",
"type": "svod",
"entitlement_scope": "partial_exclusive",
"status": "inactive",
"price": 123.45,
"price_per_installment": 987.65,
"time_unit": "day",
"frequency": 987.65,
"currency": "string",
"currency_symbol": "string",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"user_subscription_status_action": "activate",
"id": 42,
"products": [ProductStackInput],
"payment_providers": [42],
"articles": [42],
"categories": [42],
"files": [SubscriptionFileInput]
}
Response
{
"data": {
"SubscriptionUpdate": {
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [
AdminPaymentProviderListedAsRelation
],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"user_subscription_status_action": "string",
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"products": [AdminProductListedAsRelation],
"entitleable_articles": [ArticleListedAsRelation],
"files": [File]
}
}
}
UserAuthenticate
Description
Initiate an authenticated session and request new tokens
Response
Returns an Authenticate
Example
Query
mutation UserAuthenticate(
$email: String,
$password: String
) {
UserAuthenticate(
email: $email,
password: $password
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{
"email": "string",
"password": "string"
}
Response
{
"data": {
"UserAuthenticate": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
UserAuthenticateInvalidate
Description
Invalidate current authenticated session and remove all tokens
Response
Returns a Boolean
Example
Query
mutation UserAuthenticateInvalidate {
UserAuthenticateInvalidate
}
Response
{"data": {"UserAuthenticateInvalidate": true}}
UserAuthenticateRefresh
Description
Refresh current authenticated session and request new tokens
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
refresh_token - String
|
Example
Query
mutation UserAuthenticateRefresh($refresh_token: String) {
UserAuthenticateRefresh(refresh_token: $refresh_token) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{"refresh_token": "string"}
Response
{
"data": {
"UserAuthenticateRefresh": {
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
}
}
UserCreate
Description
Create user
Response
Returns an AdminUser
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
gender - UserGenderTypeEnum
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone - String
|
|
phone_country - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
|
project_id - Int
|
|
metas - [UserMetaInput]
|
|
roles - [Int]
|
|
is_administrator - Boolean
|
Indicate if the mutation is intended for an Administrator |
Example
Query
mutation UserCreate(
$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,
$metas: [UserMetaInput],
$roles: [Int],
$is_administrator: Boolean
) {
UserCreate(
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,
metas: $metas,
roles: $roles,
is_administrator: $is_administrator
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...AdminUserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
external_user_id
metas {
...AdminUserMetaFragment
}
managed_projects {
...AdminProjectFragment
}
recent_project {
...AdminProjectFragment
}
roles {
...RoleFragment
}
user_product_orders {
...AdminUserPaymentAccountOrderFragment
}
payment_accounts {
...AdminUserPaymentAccountFragment
}
article_view_sessions {
...UserArticleSessionFragment
}
devices {
...AdminDeviceFragment
}
activity_logs {
...AdminActivityLogFragment
}
created_at
updated_at
active_at
credits {
...AdminUserPaymentCreditFragment
}
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"gender": "male",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone": "string",
"phone_country": "string",
"birthday": "string",
"height": 987.65,
"weight": 987.65,
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": false,
"project_id": 42,
"metas": [UserMetaInput],
"roles": [42],
"is_administrator": true
}
Response
{
"data": {
"UserCreate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [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]
}
}
}
UserDelete
Description
Delete user
Response
Returns a Boolean
Example
Query
mutation UserDelete(
$id: Int,
$email: String,
$is_administrator: Boolean
) {
UserDelete(
id: $id,
email: $email,
is_administrator: $is_administrator
)
}
Variables
{
"id": 42,
"email": "string",
"is_administrator": false
}
Response
{"data": {"UserDelete": true}}
UserDetailsUpdate
Description
Update current authenticated user
Response
Returns an AdminUserDetails
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
gender - UserGenderTypeEnum
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone - String
|
|
phone_country - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
|
password_current - String
|
Example
Query
mutation UserDetailsUpdate(
$name: String,
$email: String,
$password: String,
$gender: UserGenderTypeEnum,
$address: String,
$postal_code: String,
$city: String,
$country: String,
$locale: String,
$subtitle_locale: String,
$audio_locale: String,
$phone: String,
$phone_country: String,
$birthday: String,
$height: Float,
$weight: Float,
$custom_data: String,
$consents: [UserConsentInput],
$notification_topics: [UserNotificationTopicInput],
$notification_profiles: [UserNotificationProfileInput],
$notifiable: UserNotifiableTypeEnum,
$is_newsletter_opt_in: Boolean,
$password_current: String
) {
UserDetailsUpdate(
name: $name,
email: $email,
password: $password,
gender: $gender,
address: $address,
postal_code: $postal_code,
city: $city,
country: $country,
locale: $locale,
subtitle_locale: $subtitle_locale,
audio_locale: $audio_locale,
phone: $phone,
phone_country: $phone_country,
birthday: $birthday,
height: $height,
weight: $weight,
custom_data: $custom_data,
consents: $consents,
notification_topics: $notification_topics,
notification_profiles: $notification_profiles,
notifiable: $notifiable,
is_newsletter_opt_in: $is_newsletter_opt_in,
password_current: $password_current
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...UserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...UserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
metas {
...AdminUserMetaFragment
}
managed_projects {
...AdminProjectFragment
}
managed_roles {
...RoleFragment
}
recent_project {
...AdminProjectFragment
}
roles {
...RoleFragment
}
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"gender": "male",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone": "string",
"phone_country": "string",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": false,
"password_current": "string"
}
Response
{
"data": {
"UserDetailsUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 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",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"managed_roles": [Role],
"recent_project": AdminProject,
"roles": [Role]
}
}
}
UserDevicePairingDelete
Description
Delete an existing device pairing for given user
Example
Query
mutation UserDevicePairingDelete(
$device_id: Int,
$user_id: Int
) {
UserDevicePairingDelete(
device_id: $device_id,
user_id: $user_id
)
}
Variables
{"device_id": 42, "user_id": 42}
Response
{"data": {"UserDevicePairingDelete": true}}
UserForUserAuthenticate
Description
Initiate an authenticated session and request new tokens for given user
Response
Returns an Authenticate
Example
Query
mutation UserForUserAuthenticate(
$project_id: Int,
$user_id: Int
) {
UserForUserAuthenticate(
project_id: $project_id,
user_id: $user_id
) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{"project_id": 42, "user_id": 42}
Response
{
"data": {
"UserForUserAuthenticate": {
"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"
}
}
}
UserHelpCenterAuthenticate
Description
Initiate an authenticated session and request new credentials for the HelpCenter
Response
Returns an Authenticate
Example
Query
mutation UserHelpCenterAuthenticate {
UserHelpCenterAuthenticate {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Response
{
"data": {
"UserHelpCenterAuthenticate": {
"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"
}
}
}
UserMetaDelete
Description
Delete a metadata property for a given user
Response
Returns a Boolean
Example
Query
mutation UserMetaDelete(
$user_id: Int,
$key: String,
$is_administrator: Boolean
) {
UserMetaDelete(
user_id: $user_id,
key: $key,
is_administrator: $is_administrator
)
}
Variables
{
"user_id": 42,
"key": "string",
"is_administrator": true
}
Response
{"data": {"UserMetaDelete": true}}
UserPasswordResetForUserRequest
Description
Initiate a password reset request for a given user
Response
Returns a Boolean
Example
Query
mutation UserPasswordResetForUserRequest(
$id: Int,
$is_administrator: Boolean
) {
UserPasswordResetForUserRequest(
id: $id,
is_administrator: $is_administrator
)
}
Variables
{"id": 42, "is_administrator": false}
Response
{"data": {"UserPasswordResetForUserRequest": false}}
UserPasswordResetRequest
Description
Initiate a password reset request for a given user
UserPasswordResetValidate
Description
Validate a password reset request and/or reset the password
Example
Query
mutation UserPasswordResetValidate(
$token: String,
$password: String
) {
UserPasswordResetValidate(
token: $token,
password: $password
)
}
Variables
{
"token": "string",
"password": "string"
}
Response
{"data": {"UserPasswordResetValidate": false}}
UserPaymentAccountOrderRefund
Description
Refund payment account order for user
Response
Returns an AdminUserPaymentAccountOrder
Example
Query
mutation UserPaymentAccountOrderRefund(
$id: Int,
$user_id: Int,
$is_auto_suspend_user_subscription: Boolean
) {
UserPaymentAccountOrderRefund(
id: $id,
user_id: $user_id,
is_auto_suspend_user_subscription: $is_auto_suspend_user_subscription
) {
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 {
...AdminUserPaymentAccountOrderInstallmentFragment
}
currency
currency_symbol
user {
...AdminUserFragment
}
user_payment_account_id
remote_payment_order_id
remote_payment_user_id
amount_balance_mutation
amount_remote_mutation
payment_url
method
method_details
ip_address
geo_region_code
origin
purchase_origin
server_origin
is_refundable
metadata
receipt_data
invoice_data
account {
...AdminUserPaymentAccountFragment
}
user_subscription {
...AdminUserSubscriptionFragment
}
products {
...AdminProductListedAsRelationFragment
}
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
categories {
...AdminCategoryFragment
}
}
}
Variables
{"id": 42, "user_id": 42, "is_auto_suspend_user_subscription": false}
Response
{
"data": {
"UserPaymentAccountOrderRefund": {
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [
AdminUserPaymentAccountOrderInstallment
],
"currency": "EUR",
"currency_symbol": "EUR",
"user": AdminUser,
"user_payment_account_id": 42,
"remote_payment_order_id": "string",
"remote_payment_user_id": "string",
"amount_balance_mutation": "string",
"amount_remote_mutation": "string",
"payment_url": "https://url.example.com",
"method": "string",
"method_details": "string",
"ip_address": "string",
"geo_region_code": "nl",
"origin": "string",
"purchase_origin": "string",
"server_origin": "string",
"is_refundable": false,
"metadata": "string",
"receipt_data": "string",
"invoice_data": "string",
"account": AdminUserPaymentAccount,
"user_subscription": AdminUserSubscription,
"products": [AdminProductListedAsRelation],
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"categories": [AdminCategory]
}
}
}
UserProductPaymentAccountOrderCreate
Description
Create product payment account order for user
Response
Returns an AdminUserPaymentAccountOrder
Arguments
| Name | Description |
|---|---|
user_id - Int
|
|
description - String
|
|
products - [ProductStackInput]
|
Example
Query
mutation UserProductPaymentAccountOrderCreate(
$user_id: Int,
$description: String,
$products: [ProductStackInput]
) {
UserProductPaymentAccountOrderCreate(
user_id: $user_id,
description: $description,
products: $products
) {
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 {
...AdminUserPaymentAccountOrderInstallmentFragment
}
currency
currency_symbol
user {
...AdminUserFragment
}
user_payment_account_id
remote_payment_order_id
remote_payment_user_id
amount_balance_mutation
amount_remote_mutation
payment_url
method
method_details
ip_address
geo_region_code
origin
purchase_origin
server_origin
is_refundable
metadata
receipt_data
invoice_data
account {
...AdminUserPaymentAccountFragment
}
user_subscription {
...AdminUserSubscriptionFragment
}
products {
...AdminProductListedAsRelationFragment
}
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
categories {
...AdminCategoryFragment
}
}
}
Variables
{
"user_id": 42,
"description": "string",
"products": [ProductStackInput]
}
Response
{
"data": {
"UserProductPaymentAccountOrderCreate": {
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [
AdminUserPaymentAccountOrderInstallment
],
"currency": "EUR",
"currency_symbol": "EUR",
"user": AdminUser,
"user_payment_account_id": 42,
"remote_payment_order_id": "string",
"remote_payment_user_id": "string",
"amount_balance_mutation": "string",
"amount_remote_mutation": "string",
"payment_url": "https://url.example.com",
"method": "string",
"method_details": "string",
"ip_address": "string",
"geo_region_code": "nl",
"origin": "string",
"purchase_origin": "string",
"server_origin": "string",
"is_refundable": false,
"metadata": "string",
"receipt_data": "string",
"invoice_data": "string",
"account": AdminUserPaymentAccount,
"user_subscription": AdminUserSubscription,
"products": [AdminProductListedAsRelation],
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"categories": [AdminCategory]
}
}
}
UserProductsSanitise
Description
Sanitise user products
Example
Query
mutation UserProductsSanitise($id: Int) {
UserProductsSanitise(id: $id) {
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
{"id": 42}
Response
{
"data": {
"UserProductsSanitise": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [AdminUserSubscription],
"user_products": [UserProduct],
"orders": [AdminUserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR",
"external_user_id": "string",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"recent_project": AdminProject,
"roles": [Role],
"user_product_orders": [
AdminUserPaymentAccountOrder
],
"payment_accounts": [AdminUserPaymentAccount],
"article_view_sessions": [UserArticleSession],
"devices": [AdminDevice],
"activity_logs": [AdminActivityLog],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"active_at": "2000-12-31T12:34:56.000Z",
"credits": [AdminUserPaymentCredit]
}
}
}
UserProjectAuthenticate
Description
Request new tokens for given Project
Response
Returns an Authenticate
Arguments
| Name | Description |
|---|---|
project_id - Int
|
Example
Query
mutation UserProjectAuthenticate($project_id: Int) {
UserProjectAuthenticate(project_id: $project_id) {
access_token
refresh_token
expires_in
token_type
user_id
user_email
active_project_id
url
}
}
Variables
{"project_id": 42}
Response
{
"data": {
"UserProjectAuthenticate": {
"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"
}
}
}
UserProjectManage
Description
Activate project management for user
UserSubscriptionCreate
Description
Create a user subscription for user
Response
Returns an AdminUserSubscription
Example
Query
mutation UserSubscriptionCreate(
$user_id: Int,
$subscription_id: Int,
$payment_provider_id: Int
) {
UserSubscriptionCreate(
user_id: $user_id,
subscription_id: $subscription_id,
payment_provider_id: $payment_provider_id
) {
id
user_id
project_id
subscription_id
switch_from_subscription_id
switch_to_subscription_id
term
acquired_at
expires_at
suspendable_at
suspended_at
invoiced_at
status
status_name
is_valid
is_expired
is_suspendable
is_account_method_changeable
is_switchable
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
subscription {
...AdminSubscriptionFragment
}
switch_to_subscription {
...AdminSubscriptionFragment
}
switch_from_subscription {
...AdminSubscriptionFragment
}
account {
...AdminUserPaymentAccountFragment
}
last_event_type
}
}
Variables
{"user_id": 42, "subscription_id": 42, "payment_provider_id": 42}
Response
{
"data": {
"UserSubscriptionCreate": {
"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": 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"
}
}
}
UserSubscriptionPaymentAccountOrderCreate
Description
Create subscription payment account order for user
Response
Returns an AdminUserPaymentAccountOrder
Arguments
| Name | Description |
|---|---|
user_id - Int
|
|
description - String
|
|
user_subscription_id - Int
|
|
installment_num - Int
|
|
time_unit - SubscriptionTimeUnitEnum
|
|
issue_installments_until - String
|
|
products - [ProductStackInput]
|
Example
Query
mutation UserSubscriptionPaymentAccountOrderCreate(
$user_id: Int,
$description: String,
$user_subscription_id: Int,
$installment_num: Int,
$time_unit: SubscriptionTimeUnitEnum,
$issue_installments_until: String,
$products: [ProductStackInput]
) {
UserSubscriptionPaymentAccountOrderCreate(
user_id: $user_id,
description: $description,
user_subscription_id: $user_subscription_id,
installment_num: $installment_num,
time_unit: $time_unit,
issue_installments_until: $issue_installments_until,
products: $products
) {
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 {
...AdminUserPaymentAccountOrderInstallmentFragment
}
currency
currency_symbol
user {
...AdminUserFragment
}
user_payment_account_id
remote_payment_order_id
remote_payment_user_id
amount_balance_mutation
amount_remote_mutation
payment_url
method
method_details
ip_address
geo_region_code
origin
purchase_origin
server_origin
is_refundable
metadata
receipt_data
invoice_data
account {
...AdminUserPaymentAccountFragment
}
user_subscription {
...AdminUserSubscriptionFragment
}
products {
...AdminProductListedAsRelationFragment
}
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
categories {
...AdminCategoryFragment
}
}
}
Variables
{
"user_id": 42,
"description": "string",
"user_subscription_id": 42,
"installment_num": 42,
"time_unit": "day",
"issue_installments_until": "string",
"products": [ProductStackInput]
}
Response
{
"data": {
"UserSubscriptionPaymentAccountOrderCreate": {
"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]
}
}
}
UserSubscriptionSanitise
Description
Sanitise a user subscription
Response
Returns an AdminUserSubscription
Arguments
| Name | Description |
|---|---|
id - Int
|
Example
Query
mutation UserSubscriptionSanitise($id: Int) {
UserSubscriptionSanitise(id: $id) {
id
user_id
project_id
subscription_id
switch_from_subscription_id
switch_to_subscription_id
term
acquired_at
expires_at
suspendable_at
suspended_at
invoiced_at
status
status_name
is_valid
is_expired
is_suspendable
is_account_method_changeable
is_switchable
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
subscription {
...AdminSubscriptionFragment
}
switch_to_subscription {
...AdminSubscriptionFragment
}
switch_from_subscription {
...AdminSubscriptionFragment
}
account {
...AdminUserPaymentAccountFragment
}
last_event_type
}
}
Variables
{"id": 42}
Response
{
"data": {
"UserSubscriptionSanitise": {
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": true,
"is_expired": true,
"is_suspendable": true,
"is_account_method_changeable": true,
"is_switchable": true,
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"products": [AdminProductListedAsRelation],
"orders": [AdminUserPaymentAccountOrder],
"subscription": AdminSubscription,
"switch_to_subscription": AdminSubscription,
"switch_from_subscription": AdminSubscription,
"account": AdminUserPaymentAccount,
"last_event_type": "first_payment_error"
}
}
}
UserSubscriptionUpdate
Description
Update a user subscription
Response
Returns an AdminUserSubscription
Arguments
| Name | Description |
|---|---|
id - Int
|
|
status - UserSubscriptionStatusEnum
|
|
expires_at - String
|
|
switch_to_subscription_id - Int
|
Example
Query
mutation UserSubscriptionUpdate(
$id: Int,
$status: UserSubscriptionStatusEnum,
$expires_at: String,
$switch_to_subscription_id: Int
) {
UserSubscriptionUpdate(
id: $id,
status: $status,
expires_at: $expires_at,
switch_to_subscription_id: $switch_to_subscription_id
) {
id
user_id
project_id
subscription_id
switch_from_subscription_id
switch_to_subscription_id
term
acquired_at
expires_at
suspendable_at
suspended_at
invoiced_at
status
status_name
is_valid
is_expired
is_suspendable
is_account_method_changeable
is_switchable
user_subscription_products {
...AdminUserSubscriptionProductFragment
}
products {
...AdminProductListedAsRelationFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
subscription {
...AdminSubscriptionFragment
}
switch_to_subscription {
...AdminSubscriptionFragment
}
switch_from_subscription {
...AdminSubscriptionFragment
}
account {
...AdminUserPaymentAccountFragment
}
last_event_type
}
}
Variables
{
"id": 42,
"status": "initialised",
"expires_at": "string",
"switch_to_subscription_id": 42
}
Response
{
"data": {
"UserSubscriptionUpdate": {
"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": false,
"is_account_method_changeable": false,
"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"
}
}
}
UserUpdate
Description
Update user
Response
Returns an AdminUser
Arguments
| Name | Description |
|---|---|
name - String
|
|
email - String
|
|
password - String
|
|
gender - UserGenderTypeEnum
|
|
address - String
|
|
postal_code - String
|
|
city - String
|
|
country - String
|
|
locale - String
|
|
subtitle_locale - String
|
|
audio_locale - String
|
|
phone - String
|
|
phone_country - String
|
|
birthday - String
|
|
height - Float
|
|
weight - Float
|
|
custom_data - String
|
|
consents - [UserConsentInput]
|
|
notification_topics - [UserNotificationTopicInput]
|
|
notification_profiles - [UserNotificationProfileInput]
|
|
notifiable - UserNotifiableTypeEnum
|
|
is_newsletter_opt_in - Boolean
|
|
id - Int
|
|
status - UserStatusEnum
|
|
external_user_id - String
|
|
is_phone_verified - UserPhoneStatusEnum
|
|
metas - [UserMetaInput]
|
|
roles - [Int]
|
|
is_administrator - Boolean
|
Update an admin user |
Example
Query
mutation UserUpdate(
$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,
$id: Int,
$status: UserStatusEnum,
$external_user_id: String,
$is_phone_verified: UserPhoneStatusEnum,
$metas: [UserMetaInput],
$roles: [Int],
$is_administrator: Boolean
) {
UserUpdate(
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,
id: $id,
status: $status,
external_user_id: $external_user_id,
is_phone_verified: $is_phone_verified,
metas: $metas,
roles: $roles,
is_administrator: $is_administrator
) {
id
project_id
name
display_name
email
gender
locale
subtitle_locale
audio_locale
status
address
postal_code
city
country
geo_region_code
phone
is_phone_verified
birthday
height
weight
custom_data
is_newsletter_opt_in
is_terms_and_conditions_opt_in
is_marked_for_deletion
delete_at
notifiable
max_concurrent_vod_stream_num
user_subscription_status
user_subscription_last_event_type
subscription_id
favourite_articles {
...ArticleRelatedFragment
}
nomadic_articles {
...ArticleRelatedFragment
}
history_articles {
...ArticleRelatedFragment
}
entitled_articles {
...ArticleRelatedFragment
}
entitled_root_articles {
...ArticleRelatedFragment
}
articles {
...ArticleRelatedFragment
}
latest_nomadic_article {
...ArticleRelatedFragment
}
consents {
...UserConsentFragment
}
metric_actions {
...MetricActionFragment
}
notification_profiles {
...UserNotificationProfileFragment
}
notification_topics {
...UserNotificationTopicFragment
}
user_subscriptions {
...AdminUserSubscriptionFragment
}
user_products {
...UserProductFragment
}
orders {
...AdminUserPaymentAccountOrderFragment
}
user_payment_credit_amount
user_payment_general_credit_amount
user_payment_free_article_credit_amount
user_payment_currency_amount
user_payment_currency_symbol
user_payment_currency
external_user_id
metas {
...AdminUserMetaFragment
}
managed_projects {
...AdminProjectFragment
}
recent_project {
...AdminProjectFragment
}
roles {
...RoleFragment
}
user_product_orders {
...AdminUserPaymentAccountOrderFragment
}
payment_accounts {
...AdminUserPaymentAccountFragment
}
article_view_sessions {
...UserArticleSessionFragment
}
devices {
...AdminDeviceFragment
}
activity_logs {
...AdminActivityLogFragment
}
created_at
updated_at
active_at
credits {
...AdminUserPaymentCreditFragment
}
}
}
Variables
{
"name": "string",
"email": "string",
"password": "string",
"gender": "male",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"phone": "string",
"phone_country": "string",
"birthday": "string",
"height": 987.65,
"weight": 987.65,
"custom_data": "string",
"consents": [UserConsentInput],
"notification_topics": [UserNotificationTopicInput],
"notification_profiles": [UserNotificationProfileInput],
"notifiable": "none",
"is_newsletter_opt_in": false,
"id": 42,
"status": "disabled",
"external_user_id": "string",
"is_phone_verified": "unverified",
"metas": [UserMetaInput],
"roles": [42],
"is_administrator": false
}
Response
{
"data": {
"UserUpdate": {
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [AdminUserSubscription],
"user_products": [UserProduct],
"orders": [AdminUserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR",
"external_user_id": "string",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"recent_project": AdminProject,
"roles": [Role],
"user_product_orders": [
AdminUserPaymentAccountOrder
],
"payment_accounts": [AdminUserPaymentAccount],
"article_view_sessions": [UserArticleSession],
"devices": [AdminDevice],
"activity_logs": [AdminActivityLog],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"active_at": "2000-12-31T12:34:56.000Z",
"credits": [AdminUserPaymentCredit]
}
}
}
Types
ActivityLogLevelEnum
Description
The activity log entry log level
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"system_error"
AdminActivityLog
Description
An activity log entry
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the activity log entry |
log_name - String
|
The name of the activity log entry |
description - String
|
The description of the activity log entry |
created_at - String
|
The creation date (UTC) of the log entry |
updated_at - String
|
The last modification date (UTC) of the log entry |
project_id - Int
|
The project id of the activity log entry |
user_id - Int
|
The user id of the activity log entry |
log_level - ActivityLogLevelEnum
|
The log level of the activity log entry |
status - Int
|
The processed status of the activity log entry |
properties - String
|
The json encoded logged properties of the activity log entry |
Example
{
"id": 42,
"log_name": "string",
"description": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project_id": 42,
"user_id": 42,
"log_level": "system_error",
"status": "string",
"properties": "string"
}
AdminActivityLogsListedWithPagination
Description
Administrated activity log list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminActivityLog]
|
|
pagination - Pagination
|
Example
{
"items": [AdminActivityLog],
"pagination": Pagination
}
AdminArticle
Description
An administrated article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [AdminArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [AdminAsset]
|
List of assets this article has |
categories - [AdminCategory]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [AdminProduct]
|
The related products for the article |
upsell_products - [AdminProduct]
|
The related upsell products for the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
is_auto_generate_recommendations - Boolean
|
Article has auto-generated recommendations |
is_show_in_all_geo_regions - Boolean
|
Article is shown in all geo-regions, whether it is geo-restricted or not |
generic_url - String
|
Generic url of the article |
url_slug_translations - [Translation]
|
The translations for given property |
full_url_slug_translations - [Translation]
|
The translations for given property |
canonical_url_translations - [Translation]
|
The translations for given property |
canonical_title_translations - [Translation]
|
The translations for given property |
upsell_product_call_to_action_tag_translations - [Translation]
|
The translations for given property |
ribbon_title_translations - [Translation]
|
The translations for given property |
children - [AdminArticle]
|
List of articles this article is parent of |
recommended_articles - [AdminArticle]
|
List of recommended articles |
featured_on_categories - [AdminCategory]
|
List of categories this article is featured on |
files - [File]
|
List of files |
Arguments
|
|
entitling_subscriptions - [AdminSubscription]
|
List of subscriptions through which this article can be entitled |
published_from - String
|
Publish-from date (UTC) for the article |
published_until - String
|
Publish-until date (UTC) for the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [AdminArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [AdminAsset],
"categories": [AdminCategory],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [AdminProduct],
"upsell_products": [AdminProduct],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"is_auto_generate_recommendations": true,
"is_show_in_all_geo_regions": false,
"generic_url": "https://url.example.com",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"canonical_title_translations": [Translation],
"upsell_product_call_to_action_tag_translations": [
Translation
],
"ribbon_title_translations": [Translation],
"children": [AdminArticle],
"recommended_articles": [AdminArticle],
"featured_on_categories": [AdminCategory],
"files": [File],
"entitling_subscriptions": [AdminSubscription],
"published_from": "string",
"published_until": "string"
}
AdminArticleAssetPlay
Description
An article asset play back request
Fields
| Field Name | Description |
|---|---|
article_id - Int!
|
The id of the article |
asset_id - Int!
|
The id of the asset |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float
|
The duration of the asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - Float
|
The fractional aspect ratio of the asset (e.g. 1.778) |
linked_type - ArticleAssetLinkedTypeEnum
|
The asset linked type |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
entitlements - [ArticleAssetPlayEntitlement]
|
The asset entitlements |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
appa - Float
|
The asset absolute play position |
appr - Float
|
The asset relative play position |
pulse_updated_at - String
|
The asset pulse updated date (UTC) |
pulse_token - String
|
The asset pulse token |
concurrent_user_num - Int
|
The number of concurrent users for given article-asset |
fairplay_certificate_url - String
|
The fairplay certificate url |
user_subtitle_locale - String
|
The user preferred subtitle locale |
user_audio_locale - String
|
The user preferred audio locale |
issued_at - String
|
The date stamp (UTC) at which the current play mutation was issued |
Arguments
|
|
Example
{
"article_id": 42,
"asset_id": 42,
"time_marker_intro_start": 123.45,
"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": 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"
}
AdminArticleMeta
Description
An article metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
article_id - Int
|
The metadata property parent article id |
translations - [ArticleMetaTranslation]
|
The translations for given metadata property |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42,
"translations": [ArticleMetaTranslation]
}
AdminArticlesListedWithPagination
Description
Article list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminArticle]
|
|
pagination - Pagination
|
Example
{
"items": [AdminArticle],
"pagination": Pagination
}
AdminAsset
Description
An asset
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the asset |
project_id - Int!
|
The project id of the asset |
source_blob_name - String
|
Source blob name |
thumbnail_asset_id - String
|
Thumbnail asset id |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
type - AssetTypeEnum
|
Asset type |
linked_type - ArticleAssetLinkedTypeEnum
|
Linked asset type |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float!
|
The duration asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - String
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
screenshots - [File]
|
List of screenshot images |
playable_from - String
|
Visible-from date (UTC) for the asset (typically used to indicate when a live event will begin). |
playable_until - String
|
Visible-until date (UTC) for the asset (typically used to indicate when a live event will end). |
published_from - String
|
Publish-from date (UTC) for the asset |
published_until - String
|
Publish-until date (UTC) for the asset |
created_at - String
|
The creation date (UTC) of the asset |
updated_at - String
|
The last modification date (UTC) of the asset |
project - AdminProject
|
The project this asset belongs to |
media_provider - String
|
Media provider |
encoding_profile_name - AssetEncodingProfileNameEnum
|
Encoding profile name |
encryption_profile_name - AssetEncryptionProfileNameEnum
|
Encryption profile name |
source_blob_md5 - String
|
Source blob name (md5 encoded) |
source_asset_id - String
|
Source asset id |
encoded_asset_name - String
|
Encoded asset name |
encoded_asset_id - String
|
Encoded asset id |
streaming_unit_id - String
|
Streaming unit id |
origin - String
|
Upload origin |
streaming_endpoint - String
|
Media url locator |
asset_status_id - Int!
|
The related asset status id |
asset_status - AssetStatusEnum
|
The asset status |
ingestion_status - String
|
The asset ingestion status |
ingestion_status_description - String
|
The asset ingestion status description |
external_asset_id - String
|
External asset id, refers to customer specific id in own archive |
files - [File]
|
List of files |
Arguments
|
|
download_urls - [StructureKeyValueStringPair]
|
List of download urls |
activity_logs - [AdminActivityLog]
|
List of all activity logs for this resource |
player_embed_code_iframe - String
|
Player embed code in iframe format |
ingestion_endpoints - [String]
|
Ingestion endpoints for Asset of type "live_video" |
streaming_credentials - [StructureKeyValueStringPair]
|
Streaming credentials (e.g. for live streams) |
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": false,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 987.65,
"time_marker_end": 987.65,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"project": AdminProject,
"media_provider": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none",
"source_blob_md5": "string",
"source_asset_id": "string",
"encoded_asset_name": "string",
"encoded_asset_id": "string",
"streaming_unit_id": "string",
"origin": "string",
"streaming_endpoint": "string",
"asset_status_id": "string",
"asset_status": "string",
"ingestion_status": "string",
"ingestion_status_description": "string",
"external_asset_id": "string",
"files": [File],
"download_urls": ["https://url.example.com"],
"activity_logs": [AdminActivityLog],
"player_embed_code_iframe": "string",
"ingestion_endpoints": ["string"],
"streaming_credentials": [StructureKeyValueStringPair]
}
AdminAssetListed
Description
A listed asset
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the asset |
project_id - Int!
|
The project id of the asset |
source_blob_name - String
|
Source blob name |
thumbnail_asset_id - String
|
Thumbnail asset id |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
type - AssetTypeEnum
|
Asset type |
linked_type - ArticleAssetLinkedTypeEnum
|
Linked asset type |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float!
|
The duration asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - String
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
screenshots - [File]
|
List of screenshot images |
playable_from - String
|
Visible-from date (UTC) for the asset (typically used to indicate when a live event will begin). |
playable_until - String
|
Visible-until date (UTC) for the asset (typically used to indicate when a live event will end). |
published_from - String
|
Publish-from date (UTC) for the asset |
published_until - String
|
Publish-until date (UTC) for the asset |
created_at - String
|
The creation date (UTC) of the asset |
updated_at - String
|
The last modification date (UTC) of the asset |
project - AdminProject
|
The project this asset belongs to |
media_provider - String
|
Media provider |
encoding_profile_name - AssetEncodingProfileNameEnum
|
Encoding profile name |
encryption_profile_name - AssetEncryptionProfileNameEnum
|
Encryption profile name |
source_blob_md5 - String
|
Source blob name (md5 encoded) |
source_asset_id - String
|
Source asset id |
encoded_asset_name - String
|
Encoded asset name |
encoded_asset_id - String
|
Encoded asset id |
streaming_unit_id - String
|
Streaming unit id |
origin - String
|
Upload origin |
streaming_endpoint - String
|
Media url locator |
asset_status_id - Int!
|
The related asset status id |
asset_status - AssetStatusEnum
|
The asset status |
ingestion_status - String
|
The asset ingestion status |
ingestion_status_description - String
|
The asset ingestion status description |
external_asset_id - String
|
External asset id, refers to customer specific id in own archive |
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": true,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 123.45,
"time_marker_end": 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"
}
AdminAssetPlay
Description
An asset play back request
Fields
| Field Name | Description |
|---|---|
asset_id - Int!
|
The id of the asset |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float
|
The duration of the asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - Float
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
entitlements - [ArticleAssetPlayEntitlement]
|
The asset entitlements |
pulse_updated_at - String
|
The asset pulse updated date (UTC) |
pulse_token - String
|
The asset pulse token |
fairplay_certificate_url - String
|
The fairplay certificate url |
user_subtitle_locale - String
|
The user preferred subtitle locale |
user_audio_locale - String
|
The user preferred audio locale |
issued_at - String
|
The date stamp (UTC) at which the current play mutation was issued |
Arguments
|
|
Example
{
"asset_id": 42,
"time_marker_intro_start": 987.65,
"time_marker_intro_end": 123.45,
"time_marker_end": 987.65,
"duration": 987.65,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"entitlements": [ArticleAssetPlayEntitlement],
"pulse_updated_at": "2000-12-31T12:34:56.000Z",
"pulse_token": "string",
"fairplay_certificate_url": "https://url.example.com",
"user_subtitle_locale": "string",
"user_audio_locale": "string",
"issued_at": "2000-12-31T12:34:56.000Z"
}
AdminAssetUploadToken
Description
A file upload token
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Project id |
asset_id - Int
|
The corresponding Asset id for which the upload-token is issued |
token - String
|
upload token |
token_type - String
|
token type |
credential_string - String
|
Credential-string for multi-part upload |
expires_in - Int
|
token ttl |
source_blob_name - String
|
Sanitised source file name |
account_name - String
|
account name |
folder_name - String
|
upload folder name |
encoding_profile_name - AssetEncodingProfileNameEnum
|
encoding profile assigned to uploaded file |
encryption_profile_name - AssetEncryptionProfileNameEnum
|
encryption profile assigned to uploaded file |
Example
{
"project_id": 42,
"asset_id": 42,
"token": "string",
"token_type": "string",
"credential_string": "string",
"expires_in": 86400,
"source_blob_name": "string",
"account_name": "string",
"folder_name": "string",
"encoding_profile_name": "sd_540p_16x9",
"encryption_profile_name": "none"
}
AdminAssetsListedWithPagination
Description
Asset list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminAssetListed]
|
|
pagination - Pagination
|
Example
{
"items": [AdminAssetListed],
"pagination": Pagination
}
AdminCategoriesListedWithPagination
Description
Category list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminCategory]
|
|
pagination - Pagination
|
Example
{
"items": [AdminCategory],
"pagination": Pagination
}
AdminCategory
Description
A category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [AdminCategoryMeta]
|
List of article metadata properties |
Arguments
|
|
articles - [AdminArticle]
|
List of articles in this category |
Arguments
|
|
products - [AdminProduct]
|
List of products in this category |
Arguments
|
|
featured_articles - [AdminArticle]
|
List of articles directly linked to this category |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The id of the parent category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
generic_url - String
|
Generic url of the category |
url_slug_translations - [Translation]
|
The translations for given property |
full_url_slug_translations - [Translation]
|
The translations for given property |
canonical_url_translations - [Translation]
|
The translations for given property |
posters - [File]
|
List of posters |
files - [File]
|
List of files |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
Visibility of the category |
status - Int
|
Status of the category |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [AdminCategoryMeta],
"articles": [AdminArticle],
"products": [AdminProduct],
"featured_articles": [AdminArticle],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"generic_url": "https://url.example.com",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"posters": [File],
"files": [File],
"visibility": "everyone",
"status": "string"
}
AdminCategoryMeta
Description
A category metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
category_id - Int
|
The metadata property parent category id |
translations - [CategoryMetaTranslation]
|
The translations for given metadata property |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42,
"translations": [CategoryMetaTranslation]
}
AdminClient
Description
An oauth client
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the oauth client |
project_id - Int
|
The project id of the oauth client |
name - String
|
The name of the oauth client |
remote_callback_url - String
|
The remote callback url used to post CRM-synchronisation events to |
remote_callback_crm_contexts - [CrmSyncContextEnum]
|
The CRM synchronisation contexts to which given client integration must trigger |
redirect_uris - [String]
|
A list of allowed redirect uri values |
service_type - ClientServiceTypeEnum
|
The service type of the oauth client |
is_configurable - Boolean
|
The Payment provider is configurable by the Moderator |
authorization_url - String
|
The authorization url for a an OAuth2 authorization-code flow |
token_url - String
|
The token url for a an OAuth2 authorization-code flow |
refresh_token_url - String
|
The refresh-token url for a an OAuth2 authorization-code flow |
user_info_url - String
|
The user-info url for a an OAuth2 authorization-code flow |
scope - String
|
The scope name for a an OAuth2 authorization-code flow |
client_id - String
|
The client-id |
client_secret - String
|
The client-secret |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"remote_callback_url": "https://url.example.com",
"remote_callback_crm_contexts": ["user_article"],
"redirect_uris": ["string"],
"service_type": "external_admin",
"is_configurable": false,
"authorization_url": "https://url.example.com",
"token_url": "https://url.example.com",
"refresh_token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"scope": "string",
"client_id": "string",
"client_secret": "string"
}
AdminClientListed
Description
A listed oauth client
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the oauth client |
project_id - Int
|
The project id of the oauth client |
name - String
|
The name of the oauth client |
remote_callback_url - String
|
The remote callback url used to post CRM-synchronisation events to |
remote_callback_crm_contexts - [CrmSyncContextEnum]
|
The CRM synchronisation contexts to which given client integration must trigger |
redirect_uris - [String]
|
A list of allowed redirect uri values |
service_type - ClientServiceTypeEnum
|
The service type of the oauth client |
is_configurable - Boolean
|
The Payment provider is configurable by the Moderator |
authorization_url - String
|
The authorization url for a an OAuth2 authorization-code flow |
token_url - String
|
The token url for a an OAuth2 authorization-code flow |
refresh_token_url - String
|
The refresh-token url for a an OAuth2 authorization-code flow |
user_info_url - String
|
The user-info url for a an OAuth2 authorization-code flow |
scope - String
|
The scope name for a an OAuth2 authorization-code flow |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"remote_callback_url": "https://url.example.com",
"remote_callback_crm_contexts": ["user_article"],
"redirect_uris": ["string"],
"service_type": "external_admin",
"is_configurable": true,
"authorization_url": "https://url.example.com",
"token_url": "https://url.example.com",
"refresh_token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"scope": "string"
}
AdminClientsListedWithPagination
Description
Client list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminClientListed]
|
|
pagination - Pagination
|
Example
{
"items": [AdminClientListed],
"pagination": Pagination
}
AdminConfig
Description
General admin config
Fields
| Field Name | Description |
|---|---|
system_language_tags - [SystemLanguageTag]
|
A list of system language tags |
language_tag_contexts - [LanguageTagContext]
|
A list of language tag contexts, which represent sets of language tags used in the front-end apps |
locales - [StructureKeyValueStringPair]
|
A list of locales and languages |
project - AdminConfigProject
|
A list of project configs for given project_id |
roles - [Role]
|
A list of available roles for given project_id |
platform_style_font_families - [String]
|
A list of available font-families which can be used in web/app styling |
platform_style_font_allowed_families - [String]
|
A list of all allowed font-families which can be used in web/app styling for given project |
resource_map - AdminResourceMap
|
A map of all resources and properties for given project_id |
type_descendants - [StructureKeyValueStringArrayPair]
|
A list of descendant types |
Arguments
|
|
type_children - [StructureKeyValueStringArrayPair]
|
A list of descendant types |
Arguments
|
|
telemetry_platforms - [String]
|
Telemetry platforms |
article_asset_linked_types - [String]
|
Project default article asset linked types |
article_types - [String]
|
Project default article types |
article_discoverability_types - [String]
|
Project default article discoverability types |
article_metadata_keys - [String]
|
The available article metadata key names |
asset_status_types - [String]
|
Project default asset status types |
category_types - [String]
|
Project default category types |
category_article_taggable_types - [String]
|
Project default category types which can be directly linked to articles |
category_product_taggable_types - [String]
|
Project default category types which can be directly linked to products |
logic_operators - [String]
|
Project default logic operators |
metric_types - [String]
|
Project default metric types |
metric_action_types - [String]
|
Project default metric action types |
metric_condition_types - [String]
|
Project default metric condition types |
notification_types - [String]
|
Project default notification types |
notification_delivery_types - [String]
|
Project default notification delivery types |
notification_topic_types - [String]
|
Project default notification topic types |
notification_channel_context_types - [String]
|
Project default notification channel context 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 |
payment_syndicate_voucher_types - [String]
|
Project voucher types |
payment_syndicate_voucher_discount_types - [String]
|
Project voucher discount types |
payment_syndicate_voucher_installment_types - [String]
|
Project voucher installment types |
payment_syndicate_voucher_user_subscription_status_actions - [String]
|
User subscriptions status actions that a voucher can implement after being claimed |
payment_currency_types - [StructureKeyValueStringPair]
|
Project currency matrix types |
product_types - [String]
|
Product types |
product_recurring_types - [String]
|
Product types |
product_non_recurring_types - [String]
|
Product types |
product_status_types - [String]
|
Product status types |
product_discoverability_types - [String]
|
Project default product discoverability types |
analytics_search_tag_types - [String]
|
Project default search tag types |
subscription_types - [String]
|
Subscription types |
subscription_status_types - [String]
|
Subscription status types |
subscription_entitlement_scope_types - [String]
|
Subscription entitlement scope types |
subscription_time_unit_types - [String]
|
Time unit types |
subscription_discoverability_types - [String]
|
Project default subscription discoverability types |
user_status_types - [String]
|
Project user status types |
user_gender_types - [String]
|
Project user gender types |
user_consent_types - [String]
|
Project user consent types |
user_notifiable_types - [String]
|
Project user notifiable types |
user_phone_status_types - [String]
|
Project user phone status types |
user_subscription_status_types - [String]
|
User subscription status types |
user_payment_credit_types - [String]
|
Project user payment credit types |
role_types - [String]
|
Project role types assigned to users and/or moderators |
system_notification_message - String
|
System notification message that may be displayed in the AudiencePlayer CMS |
system_notification_message_ttl - Int
|
TTL in seconds, after which a system notification message must reappear in the AudiencePlayer CMS |
Example
{
"system_language_tags": [SystemLanguageTag],
"language_tag_contexts": [LanguageTagContext],
"locales": [StructureKeyValueStringPair],
"project": AdminConfigProject,
"roles": [Role],
"platform_style_font_families": [
"string"
],
"platform_style_font_allowed_families": [
"string"
],
"resource_map": AdminResourceMap,
"type_descendants": [StructureKeyValueStringArrayPair],
"type_children": [StructureKeyValueStringArrayPair],
"telemetry_platforms": ["string"],
"article_asset_linked_types": ["film"],
"article_types": ["string"],
"article_discoverability_types": [
"string"
],
"article_metadata_keys": ["string"],
"asset_status_types": ["string"],
"category_types": ["string"],
"category_article_taggable_types": [
"string"
],
"category_product_taggable_types": [
"string"
],
"logic_operators": ["string"],
"metric_types": ["string"],
"metric_action_types": ["string"],
"metric_condition_types": ["string"],
"notification_types": ["string"],
"notification_delivery_types": ["string"],
"notification_topic_types": ["string"],
"notification_channel_context_types": [
"string"
],
"page_types": ["string"],
"page_component_types": ["string"],
"page_component_element_types": [
"string"
],
"payment_syndicate_voucher_types": [
"string"
],
"payment_syndicate_voucher_discount_types": [
"string"
],
"payment_syndicate_voucher_installment_types": [
"string"
],
"payment_syndicate_voucher_user_subscription_status_actions": ["string"],
"payment_currency_types": ["EUR"],
"product_types": ["string"],
"product_recurring_types": ["string"],
"product_non_recurring_types": ["string"],
"product_status_types": ["string"],
"product_discoverability_types": [
"string"
],
"analytics_search_tag_types": ["string"],
"subscription_types": ["string"],
"subscription_status_types": ["string"],
"subscription_entitlement_scope_types": [
"string"
],
"subscription_time_unit_types": [
"string"
],
"subscription_discoverability_types": [
"string"
],
"user_status_types": ["string"],
"user_gender_types": ["string"],
"user_consent_types": ["string"],
"user_notifiable_types": ["string"],
"user_phone_status_types": ["string"],
"user_subscription_status_types": ["string"],
"user_payment_credit_types": ["string"],
"role_types": ["string"],
"system_notification_message": "string",
"system_notification_message_ttl": 42
}
AdminConfigProject
Description
Admin config project
Fields
| Field Name | Description |
|---|---|
has_subscriptions - Boolean
|
Project has subscriptions |
has_auto_canonical_urls - Boolean
|
Project has auto-generated canonical urls |
has_credits - Boolean
|
Project has credits |
has_subscription_payment_registration_integration - Boolean
|
Project has payment flow integrated with registration |
has_subscription_payment_pricing_before_registration - Boolean
|
Project has subscription pricing shown before registration |
has_subscription_credit_integration - Boolean
|
Project has credits integrated within subscriptions |
has_entitlements - Boolean
|
Project has entitlements |
has_geo_restrictions - Boolean
|
Project has geo_restrictions |
has_article_favourites - Boolean
|
Project has article favourites |
has_article_ratings - Boolean
|
Project has article ratings |
has_article_nomadics - Boolean
|
Project has article nomadics |
has_article_series_nomadics - Boolean
|
Project has article nomadics in series |
has_article_entitlements - Boolean
|
Project has article entitlements |
has_article_history - Boolean
|
Project has article history |
has_article_recommendations - Boolean
|
Project has article recommendations |
has_article_offline_downloads - Boolean
|
Project has offline article downloads |
has_article_purchase_buttons - Boolean
|
Project has purchase buttons separately displayed on the article detail pages |
has_product_purchase_affiliation_categories - Boolean
|
Project has affiliation categories for products, to be displayed in the purchase modals |
has_subscription_purchase_affiliation_categories - Boolean
|
Project has affiliation categories for subscriptions, to be displayed in the purchase modals |
has_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 |
asset_encoding_profiles - [AssetEncodingProfile]
|
Project available asset encoding profiles |
asset_encryption_profiles - [AssetEncryptionProfile]
|
Project available asset encryption profiles |
Arguments
|
|
asset_default_encryption_profile_name - AssetEncryptionProfileNameEnum
|
Default asset encoding profile |
asset_default_encoding_profile_name - AssetEncodingProfileNameEnum
|
Default asset encoding profile |
image_resize_resolutions - [ImageResolution]
|
Project image size resolutions |
locale - String
|
Project default locale |
locale_translations - [String]
|
Project locale translations |
default_currency - String
|
Project default currency |
default_currency_symbol - String
|
Project default currency symbol |
website_logo - String
|
Project website logo |
website_url - String
|
Project website url |
website_domain - String
|
Project website domain name |
website_internal_url - String
|
Project internal website url |
base_url_slugs - [AdminConfigProjectBaseUrlSlug]
|
Project website base url slugs |
user_consent_types - [String]
|
Project user consent types |
theme_colours - [String]
|
Project theme colours |
article_ribbon_settings - [StructureKeyValueStringPair]
|
Article thumbnail ribbon settings |
active_platform_contexts - [String]
|
The platform contexts active for the project |
active_config_contexts - [String]
|
The config contexts active for the project |
privileges - AdminConfigProjectPrivileges
|
|
media_provider_types - [String]
|
The available media provider types for the project |
Example
{
"has_subscriptions": true,
"has_auto_canonical_urls": "https://url.example.com",
"has_credits": false,
"has_subscription_payment_registration_integration": true,
"has_subscription_payment_pricing_before_registration": true,
"has_subscription_credit_integration": true,
"has_entitlements": false,
"has_geo_restrictions": false,
"has_article_favourites": false,
"has_article_ratings": false,
"has_article_nomadics": false,
"has_article_series_nomadics": true,
"has_article_entitlements": false,
"has_article_history": false,
"has_article_recommendations": false,
"has_article_offline_downloads": false,
"has_article_purchase_buttons": false,
"has_product_purchase_affiliation_categories": false,
"has_subscription_purchase_affiliation_categories": true,
"has_checkout_combined_login_registration": false,
"is_affiliation_category_selection_required": false,
"max_concurrent_vod_stream_num": 42,
"streampulse_completion_ratio": 987.65,
"encryption_fairplay_certificate_url": "https://url.example.com",
"asset_encoding_profiles": [AssetEncodingProfile],
"asset_encryption_profiles": [AssetEncryptionProfile],
"asset_default_encryption_profile_name": "none",
"asset_default_encoding_profile_name": "sd_540p_16x9",
"image_resize_resolutions": [ImageResolution],
"locale": "string",
"locale_translations": ["string"],
"default_currency": "EUR",
"default_currency_symbol": "EUR",
"website_logo": "string",
"website_url": "https://url.example.com",
"website_domain": "string",
"website_internal_url": "https://url.example.com",
"base_url_slugs": ["url-slug-string"],
"user_consent_types": ["string"],
"theme_colours": ["string"],
"article_ribbon_settings": [
StructureKeyValueStringPair
],
"active_platform_contexts": ["string"],
"active_config_contexts": ["string"],
"privileges": AdminConfigProjectPrivileges,
"media_provider_types": ["string"]
}
AdminConfigProjectBaseUrlSlug
AdminConfigProjectPrivileges
Description
Admin config project privileges
Fields
| Field Name | Description |
|---|---|
has_app_ap_embed - Boolean
|
Project can use AP-Embed. |
has_app_chromecast - Boolean
|
Project can use the AudiencePlayer Chromecast app. |
has_app_metrological - Boolean
|
Project can use the Audienceplayer apps for the Metrological platform. |
has_app_mobile - Boolean
|
Project can use the AudiencePlayer native mobile apps for iOS and Android. |
has_app_smart_tv - Boolean
|
Project can use the AudiencePlayer Smart TV apps. |
has_app_web_custom_domain - Boolean
|
Project can use the AudiencePlayer WEB Template with a custom domain name. |
has_app_web_custom_logo_footer - Boolean
|
Project can use the AudiencePlayer WEB Template with a custom footer logo. |
has_app_web_template - Boolean
|
Project can use the AudiencePlayer WEB Template. |
has_article_non_authorised_playback - Boolean
|
Project can offer Articles without authorised-only playback (i.e. free videos such as trailers and previews). |
has_asset_drm_encryption - Boolean
|
Project can implement DRM encryption on video streams. |
has_asset_live_streaming - Boolean
|
Project can implement live video streams. |
has_gamification - Boolean
|
Project can use Gamification. |
has_integration_api - Boolean
|
Project can implement custom integrations with the AudiencePlayer API. |
has_integration_crm - Boolean
|
Project can use CRM integrations. |
has_integration_wp - Boolean
|
Project can use AudiencePlayer Wordpress plugin integration. |
has_monetization_products - Boolean
|
Project can use monetization Products. |
has_monetization_subscriptions - Boolean
|
Project can use monetization Subscriptions. |
has_monetization_vouchers - Boolean
|
Project can use monetization Vouchers. |
has_push_notifications - Boolean
|
Project can use Push Notification. |
limit_aggregated_max_video_duration_hr - Float
|
Project has a limit on the total duration of all aggregated video content. |
limit_aggregated_max_file_storage_gb - Float
|
Project has a limit on the total storage space measured in Gb (video, images, etc). |
limit_aggregated_max_streaming_gb_month - Float
|
Project has a limit on the total streaming consumption measured in Gb per month (video, images, etc). |
Example
{
"has_app_ap_embed": false,
"has_app_chromecast": true,
"has_app_metrological": true,
"has_app_mobile": true,
"has_app_smart_tv": true,
"has_app_web_custom_domain": false,
"has_app_web_custom_logo_footer": true,
"has_app_web_template": true,
"has_article_non_authorised_playback": true,
"has_asset_drm_encryption": false,
"has_asset_live_streaming": false,
"has_gamification": true,
"has_integration_api": true,
"has_integration_crm": true,
"has_integration_wp": false,
"has_monetization_products": true,
"has_monetization_subscriptions": true,
"has_monetization_vouchers": false,
"has_push_notifications": false,
"limit_aggregated_max_video_duration_hr": 123.45,
"limit_aggregated_max_file_storage_gb": 987.65,
"limit_aggregated_max_streaming_gb_month": 987.65
}
AdminDevice
Description
A device
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the device |
name - String
|
The name of device |
uuid - String
|
The UUID of device |
project_id - Int
|
The device project id |
user_id - Int
|
The device user id |
created_at - String
|
The creation date (UTC) of the device |
type - String
|
Device type |
operator_context - String
|
Device operator context |
brand - String
|
Device brand |
model - String
|
Device model |
key - String
|
Device key |
ip_address - String
|
Device IP Address |
Example
{
"id": 42,
"name": "string",
"uuid": "string",
"project_id": 42,
"user_id": 42,
"created_at": "2000-12-31T12:34:56.000Z",
"type": "string",
"operator_context": "string",
"brand": "string",
"model": "string",
"key": "string",
"ip_address": "string"
}
AdminFile
Description
A file
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the file |
name - String
|
The original name of the file |
title - String
|
The alt/title of the file |
type - FileTypeEnum
|
The type of the file |
size - Int
|
The size of the file |
width - Int
|
The width of the file |
height - Int
|
The height of the file |
aspect_ratio_profile - String
|
The aspect ratio profile |
duration - Int
|
The duration of the (audio/video) file (seconds) |
locale - String
|
The language locale code of the file |
locale_label - String
|
The language locale label of the file |
base_url - String
|
The base url of the file |
base_path - String
|
The base url path of the file |
url - String
|
The url of the file |
proxy_file_path - String
|
The proxy url of the file |
proxy_url - String
|
The proxy url of the file |
file_name - String
|
The name of the file |
file_path - String
|
The path of the file |
title_translations - [Translation]
|
The translations for given property |
origin_url - String
|
The origin url of the file, which serves as the origin for CDN hydration. |
Example
{
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string",
"title_translations": [Translation],
"origin_url": "https://url.example.com"
}
AdminLanguageTag
Description
Language tag
Fields
| Field Name | Description |
|---|---|
key - String
|
The name of language tag |
value - String
|
The value of language tag |
format - MetaFormatEnum
|
The value rendering format |
id - Int!
|
The id of the language tag |
project_id - Int!
|
The project id of the language tag |
platform_context - String
|
The platform context of the language tag |
value_translations - [Translation]
|
The translations for given property |
Arguments
|
|
Example
{
"key": "string",
"value": "string",
"format": "date",
"id": 42,
"project_id": 42,
"platform_context": "string",
"value_translations": [Translation]
}
AdminLanguageTagsListedWithPagination
Description
mail template list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminLanguageTag]
|
|
pagination - Pagination
|
Example
{
"items": [AdminLanguageTag],
"pagination": Pagination
}
AdminMailTemplate
Description
A mail template
Fields
| Field Name | Description |
|---|---|
id - Int
|
The mail template id |
project_id - Int
|
The mail template project id |
name - String
|
The mail template name |
subject - String
|
The mail template subject |
content - String
|
The mail template content |
Arguments
|
|
subject_translations - [Translation]
|
The translations for given property |
content_translations - [Translation]
|
The translations for given property |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
files - [File]
|
List of files |
Arguments
|
|
status - Int
|
Status of the mail template |
created_at - String
|
The creation date (UTC) of the mail template |
updated_at - String
|
The last modification date (UTC) of the mail template |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"subject": "string",
"content": "string",
"subject_translations": [Translation],
"content_translations": [Translation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File],
"status": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminMailTemplatesListedWithPagination
Description
mail template list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminMailTemplate]
|
|
pagination - Pagination
|
Example
{
"items": [AdminMailTemplate],
"pagination": Pagination
}
AdminMenu
Description
A menu
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the menu |
project_id - Int!
|
The project id of the menu |
name - String
|
The name of the menu |
platform_contexts - [String]
|
The platform contexts of the menu |
locale_regions - [LocaleRegion]
|
List of locale regions this menu belongs to |
geo_regions - [GeoRegion]
|
List of geo regions this menu belongs to |
components - [AdminMenuComponent]
|
The menu components |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
Visibility of the menu |
subscriptions - [AdminSubscription]
|
The related subscriptions |
products - [AdminProduct]
|
The related products |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"platform_contexts": ["string"],
"locale_regions": [LocaleRegion],
"geo_regions": [GeoRegion],
"components": [AdminMenuComponent],
"visibility": "everyone",
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
AdminMenuComponent
Description
A menu component
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the component |
parent_id - Int
|
|
menu_id - Int!
|
The menu id of the component |
page_id - Int
|
The page id of the component |
page_full_url_slug - String
|
The full page url slug of the component |
type - MenuComponentTypeEnum
|
The type of the component |
title - String
|
The title of the component |
content - String
|
The content of the component |
Arguments
|
|
url - String
|
The url of the component |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
files - [File]
|
List of files |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
Visibility of the menu component |
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
page - AdminPage
|
Related page for this menu component |
subscriptions - [AdminSubscription]
|
The related subscriptions |
products - [AdminProduct]
|
The related products |
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],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"page": AdminPage,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
AdminMenuComponentsListedWithPagination
Description
Menu component list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminMenuComponent]
|
|
pagination - Pagination
|
Example
{
"items": [AdminMenuComponent],
"pagination": Pagination
}
AdminMenusListedWithPagination
Description
Menu list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminMenu]
|
|
pagination - Pagination
|
Example
{
"items": [AdminMenu],
"pagination": Pagination
}
AdminMetric
Description
An administrated metric
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric |
project_id - Int!
|
The project id of the metric |
name - String
|
The name of the metric |
description - String
|
The description of the metric |
time_window - Int
|
The time window of the metric (seconds) |
type - MetricTypeEnum
|
The type of the metric |
published_from - String
|
Publish-from date (UTC) for the metric |
published_until - String
|
Publish-until date (UTC) for the metric |
created_at - String
|
The creation date (UTC) of the metric |
updated_at - String
|
The last modification date (UTC) of the metric |
status - MetricStatusEnum
|
The status of the metric |
conditions - [AdminMetricCondition]
|
List of metric conditions for this metric |
articles - [AdminArticle]
|
List of articles this metric relates to |
categories - [AdminCategory]
|
List of categories this metric relates to |
products - [AdminProduct]
|
List of products this metric relates to |
subscriptions - [AdminSubscription]
|
List of subscriptions this metric relates to |
eligible_users - [AdminUser]
|
List of users this metric may be applied on |
metric_actions - [AdminMetricAction]
|
The related metric actions of the metric |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"time_window": 42,
"type": "article",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"conditions": [AdminMetricCondition],
"articles": [AdminArticle],
"categories": [AdminCategory],
"products": [AdminProduct],
"subscriptions": [AdminSubscription],
"eligible_users": [AdminUser],
"metric_actions": [AdminMetricAction]
}
AdminMetricAction
Description
An administrated metric action
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric action |
project_id - Int!
|
The project id of the metric action |
name - String
|
The name of the metric action |
title - String
|
The title of the metric action |
content - String
|
The content of the metric action |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
files - [File]
|
List of files |
Arguments
|
|
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
type - MetricActionTypeEnum
|
The type of the metric action |
status - MetricActionStatusEnum
|
The type of the metric action |
webhook_url - String
|
The webhook url of the metric action |
user_subscription_installment_num - Int
|
The number of entitled user subscription installments of the metric action |
user_subscription_installment_time_unit - String
|
The time unit of the entitled user subscription installments of the metric action |
created_at - String
|
The creation date (UTC) of the metric action |
updated_at - String
|
The last modification date (UTC) of the metric action |
products - [AdminProductListedAsRelation]
|
List of products this metric action relates to |
eligible_users - [AdminUser]
|
List of users this metric may be applied on |
metrics - [AdminMetric]
|
The related metrics of the metric action |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"title": "string",
"content": "string",
"icons": [File],
"images": [File],
"files": [File],
"title_translations": [Translation],
"content_translations": [Translation],
"type": "user_entitlement",
"status": "string",
"webhook_url": "https://url.example.com",
"user_subscription_installment_num": 42,
"user_subscription_installment_time_unit": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"products": [AdminProductListedAsRelation],
"eligible_users": [AdminUser],
"metrics": [AdminMetric]
}
AdminMetricActionsListedWithPagination
Description
Administrated metric action list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminMetricAction]
|
|
pagination - Pagination
|
Example
{
"items": [AdminMetricAction],
"pagination": Pagination
}
AdminMetricCondition
Description
An administrated metric condition
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric condition |
metric_id - Int
|
The id of the related metric |
type - MetricConditionTypeEnum
|
The name of the metric |
logic_operator - LogicOperatorEnum
|
The logic operator type |
value - String
|
The value of the metric condition |
created_at - String
|
The creation date (UTC) of the metric |
updated_at - String
|
The last modification date (UTC) of the metric |
Example
{
"id": 42,
"metric_id": 42,
"type": "appa",
"logic_operator": "equals",
"value": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminMetricsListedWithPagination
Description
Administrated metric list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminMetric]
|
|
pagination - Pagination
|
Example
{
"items": [AdminMetric],
"pagination": Pagination
}
AdminNotification
Description
An administrated notification
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification |
project_id - Int!
|
The project id of the notification |
parent_id - Int
|
The parent id of the notification |
name - String
|
The name of the notification |
title - String
|
The title of the notification |
content - String
|
The content of the notification |
url - String
|
The url of the notification |
delivery_type - NotificationDeliveryTypeEnum
|
The type of the notification |
type - NotificationTypeEnum
|
The type of the notification |
notification_channel_contexts - [String]
|
The notification channel contexts of the notification |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
files - [File]
|
List of files |
Arguments
|
|
children - [AdminNotification]
|
List of notifications this notification is parent of |
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
articles - [AdminArticle]
|
List of articles this notification belongs to |
Arguments
|
|
categories - [AdminCategory]
|
List of categories this notification belongs to |
Arguments
|
|
notification_topics - [AdminNotificationTopic]
|
List of notification topics this notification belongs to |
Arguments
|
|
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
status - Int
|
Status of the notification |
schedule_at - String
|
Scheduled date (UTC) for the notification |
delivered_at - String
|
Delivery date (UTC) for the notification |
created_at - String
|
The creation date (UTC) of the notification |
updated_at - String
|
The last modification date (UTC) of the notification |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"title": "string",
"content": "string",
"url": "https://url.example.com",
"delivery_type": "generic_users_on_topic",
"type": "single",
"notification_channel_contexts": [
"string"
],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"files": [File],
"children": [AdminNotification],
"title_translations": [Translation],
"content_translations": [Translation],
"articles": [AdminArticle],
"categories": [AdminCategory],
"notification_topics": [AdminNotificationTopic],
"frequency": 1,
"time_unit": "day",
"status": "string",
"schedule_at": "2000-12-31T12:34:56.000Z",
"delivered_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminNotificationTopic
Description
An administrated notification topic
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification topic |
remote_notification_topic_id - String
|
The remote id of the notification topic (e.g. used for in-app push notifications) |
project_id - Int!
|
The project id of the notification topic |
name - String
|
The name of the notification topic |
title - String
|
The title of the notification topic |
description - String
|
The content of the notification topic |
title_translations - [Translation]
|
The translations for given property title |
description_translations - [Translation]
|
The translations for given property description |
Arguments
|
|
notifications - [AdminNotification]
|
List of notifications this notification topic belongs to |
Arguments
|
|
type - NotificationTopicTypeEnum
|
Type of notification topic |
status - Int
|
Status of the notification topic |
created_at - String
|
The creation date (UTC) of the notification topic |
updated_at - String
|
The last modification date (UTC) of the notification topic |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string",
"title_translations": [Translation],
"description_translations": [Translation],
"notifications": [AdminNotification],
"type": "general",
"status": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminNotificationTopicsListedWithPagination
Description
Administrated notification topic list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminNotificationTopic]
|
|
pagination - Pagination
|
Example
{
"items": [AdminNotificationTopic],
"pagination": Pagination
}
AdminNotificationsListedWithPagination
Description
Administrated notification list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminNotification]
|
|
pagination - Pagination
|
Example
{
"items": [AdminNotification],
"pagination": Pagination
}
AdminOauthProvider
Description
An administrated OAuth2 provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the OAuth2 provider |
project_id - Int!
|
The project id of the OAuth2 provider |
call_to_action_tag - String
|
The call-to-action tag of the OAuth2 provider |
name - String
|
The name of the OAuth2 provider |
call_to_action_tag_translations - [Translation]
|
The translations for given property call_to_action_tag |
is_auto_create_user - Boolean
|
If a local User account does not yet exists for the remote OAuth2 Users e-mail address, automatically create a local User account and authenticate a session (alternatively, a User will be redirected to the originating frontend url for further processing). |
allowed_origin_domains - [String]
|
A list of allowed domain names and/or urls, from which an OAuth2 authentication request may be initiated (configured WEB-template domain is always whitelisted). |
client_id - String
|
The client id of the OAuth2 provider |
client_secret - String
|
The credential secret of the OAuth2 provider |
redirect_url - String
|
The redirect url (or "redirect_uri" conform specification RFC 6749) to be specified for the remote OAuth2 provider: It is used as the callback url after remote authentication has been completed. |
status - OauthProviderStatusEnum
|
The status of the OAuth2 provider |
type - OauthProviderTypeEnum
|
Provider type (e.g. "generic", "google") |
scopes - [String]
|
Provider permission scopes |
scope_separator - String
|
Scope separator for remote Provider scopes |
auth_url - String
|
Provider Url to redirect to for authentication |
token_url - String
|
Provider token Url |
user_info_url - String
|
Provider Url for retrieving user info |
email_info_url - String
|
Provider Url for retrieving email info (Optional) |
user_map - String
|
JSON value of user info mapping |
custom_data - String
|
JSON value of custom data (Used for i.e. RequestOptions, Headers) |
created_at - String
|
The creation date (UTC) of the OAuth2 provider |
updated_at - String
|
The last modification date (UTC) of the OAuth2 provider |
files - [File]
|
List of files |
Arguments
|
|
icons - [File]
|
List of icons |
Example
{
"id": 42,
"project_id": 42,
"call_to_action_tag": "string",
"name": "string",
"call_to_action_tag_translations": [Translation],
"is_auto_create_user": true,
"allowed_origin_domains": ["string"],
"client_id": "string",
"client_secret": "string",
"redirect_url": "https://url.example.com",
"status": "string",
"type": "facebook",
"scopes": ["string"],
"scope_separator": "string",
"auth_url": "https://url.example.com",
"token_url": "https://url.example.com",
"user_info_url": "https://url.example.com",
"email_info_url": "foo@example.com",
"user_map": "string",
"custom_data": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"files": [File],
"icons": [File]
}
AdminOauthProvidersListedWithPagination
Description
An administrated OAuth2 provider list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminOauthProvider]
|
|
pagination - Pagination
|
Example
{
"items": [AdminOauthProvider],
"pagination": Pagination
}
AdminPage
Description
A page
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the page |
project_id - Int!
|
The project id of the page |
category_id - Int
|
The category id of the page |
parent_id - Int
|
|
name - String
|
The name of the page |
url_slug - String
|
The url slug of the page |
Arguments
|
|
full_url_slug - String
|
The full url slug of the page |
Arguments
|
|
canonical_url - String
|
The canonical url of the page |
title - String
|
The title of the page |
type - PageTypeEnum
|
The type of the page |
is_in_sitemap - Boolean
|
Listing in general sitemap |
platform_contexts - [String]
|
The platform contexts of the page |
locale_regions - [LocaleRegion]
|
List of locale regions this page belongs to |
geo_regions - [GeoRegion]
|
List of geo regions this menu belongs to |
metas - [AdminPageMeta]
|
List of article metadata properties |
Arguments
|
|
components - [AdminPageComponent]
|
The page components |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
visibility - ResourceVisibilityEnum
|
Visibility of the page |
status - Int
|
Page status |
url_slug_translations - [Translation]
|
The translations for given property |
full_url_slug_translations - [Translation]
|
The translations for given property |
canonical_url_translations - [Translation]
|
The translations for given property |
title_translations - [Translation]
|
The translations for given property |
category - AdminCategory
|
Related category for this page |
subscriptions - [AdminSubscription]
|
The related subscriptions |
products - [AdminProduct]
|
The related products |
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": [AdminPageMeta],
"components": [AdminPageComponent],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"files": [File],
"visibility": "everyone",
"status": "string",
"url_slug_translations": ["url-slug-string"],
"full_url_slug_translations": ["url-slug-string"],
"canonical_url_translations": ["https://url.example.com"],
"title_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
AdminPageComponent
Description
A page component
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the component |
page_id - Int!
|
The page id of the component |
parent_id - Int
|
|
category_id - Int
|
Deprecated in favour of resource_categories |
title - String
|
The title of the component |
content - String
|
The content of the component |
url - String
|
The url of the component |
value - String
|
The value of the component |
style_type - String
|
The style type of the component |
display_type - String
|
The display type of the component |
type - PageComponentTypeEnum
|
The type of the component |
elements - [AdminPageComponentElement]
|
The page component elements |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
List of resource articles |
resource_categories - [CategoryListedAsResource]
|
List of resource categories |
resource_pages - [PageListedAsResource]
|
List of resource pages |
resource_products - [ProductListedAsResource]
|
List of resource products |
resource_subscriptions - [SubscriptionListedAsResource]
|
List of resource subscriptions |
visibility - ResourceVisibilityEnum
|
Visibility of the page component |
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
category - AdminCategory
|
Related category for this page component |
subscriptions - [AdminSubscription]
|
The related subscriptions |
products - [AdminProduct]
|
The related products |
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": [AdminPageComponentElement],
"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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"category": AdminCategory,
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
AdminPageComponentElement
Description
A page component element
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the element |
page_component_id - Int!
|
The page component id of the element |
parent_id - Int
|
|
type - String
|
The type of the element |
title - String
|
The title of the element |
content - String
|
The content of the element |
label - String
|
The label of the element |
url - String
|
The url of the element |
value - String
|
The value of the element |
toggle - Boolean
|
The value of the toggle |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of posters |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
files - [File]
|
List of files |
Arguments
|
|
resource_articles - [ArticleListedAsResource]
|
List of resource articles |
resource_categories - [CategoryListedAsResource]
|
List of resource categories |
resource_pages - [PageListedAsResource]
|
List of resource pages |
resource_products - [ProductListedAsResource]
|
List of resource products |
resource_subscriptions - [SubscriptionListedAsResource]
|
List of resource subscriptions |
visibility - ResourceVisibilityEnum
|
Visibility of the page component element |
title_translations - [Translation]
|
The translations for given property title |
content_translations - [Translation]
|
The translations for given property content |
Arguments
|
|
label_translations - [Translation]
|
The translations for given property label |
subscriptions - [AdminSubscription]
|
The related subscriptions |
products - [AdminProduct]
|
The related products |
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
],
"visibility": "everyone",
"title_translations": [Translation],
"content_translations": [Translation],
"label_translations": [Translation],
"subscriptions": [AdminSubscription],
"products": [AdminProduct]
}
AdminPageComponentElementsListedWithPagination
Description
Page component element list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPageComponentElement]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPageComponentElement],
"pagination": Pagination
}
AdminPageComponentsListedWithPagination
Description
Page component list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPageComponent]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPageComponent],
"pagination": Pagination
}
AdminPageMeta
Description
A page metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
page_id - Int
|
The metadata property parent page id |
translations - [PageMetaTranslation]
|
The translations for given metadata property |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"page_id": 42,
"translations": [PageMetaTranslation]
}
AdminPagesListedWithPagination
Description
Page list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPage]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPage],
"pagination": Pagination
}
AdminPaymentProvider
Description
A payment provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the payment provider |
project_id - Int!
|
The project id of the payment provider |
name - String
|
The name of the payment provider |
description - String
|
The description of the payment provider |
type - String
|
The type of the payment provider |
status - PaymentProviderStatusEnum
|
The status of the payment provider |
device_capability - Int
|
The device payment capabilities of the payment provider |
order_description_template - String
|
Template for a short order description (i.e. the descriptor visible in the bank transaction) |
recurring_order_description_template - String
|
Template for a short recurring order description (i.e. the descriptor visible in the bank transaction) |
collection_window_day_num - Int
|
The number of days before a subscription expiry, at which date a recurring payment order (renewal) is issued |
amount_payment_method_change - Float
|
The amount charged for changing a (recurring) payment method, equal or greater than 1 smallest currency unit (e.g. €0.01) |
default_currency - String
|
3-letter currency code used by default when no specific currency is configured |
default_currency_symbol - String
|
ISO currency symbol related to the default_currency |
status_message - String
|
The status message of the payment provider |
connect_status - PaymentProviderConnectFlowStatusEnum
|
The status of the payment provider connection with a remote account |
connect_status_message - String
|
The connect flow status message of the payment provider |
remote_profile_status - PaymentProviderRemoteProfileStatusEnum
|
The status of the selected remote profile |
remote_profile_status_message - String
|
The connect flow status message of the payment provider |
is_configurable - Boolean
|
The Payment provider is configurable by the Moderator |
is_support_connect_flow - Boolean
|
The Payment provider supports a connect flow (e.g. Mollie, Stripe) |
remote_account - AdminPaymentProviderRemoteAccount
|
Information about the remotely connected account |
remote_profile_id - String
|
The configured profile id for the remote account |
remote_organisation_id - String
|
The organisation id of the remote account |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42,
"order_description_template": "string",
"recurring_order_description_template": "string",
"collection_window_day_num": 42,
"amount_payment_method_change": 123.45,
"default_currency": "EUR",
"default_currency_symbol": "EUR",
"status_message": "string",
"connect_status": "string",
"connect_status_message": "string",
"remote_profile_status": "string",
"remote_profile_status_message": "string",
"is_configurable": false,
"is_support_connect_flow": false,
"remote_account": AdminPaymentProviderRemoteAccount,
"remote_profile_id": "string",
"remote_organisation_id": "string"
}
AdminPaymentProviderConnectRequest
Description
A connect-request object for given payment provider
Fields
| Field Name | Description |
|---|---|
project_id - Int!
|
The project id of connect request |
state_parameter - String
|
The authorization url used to initiate the remote connect flow with the payment provider |
authorization_url - String
|
The authorization url used to initiate the remote connect flow with the payment provider |
redirect_url - String
|
The url to return to after remote connect flow has been completed |
Example
{
"project_id": 42,
"state_parameter": "string",
"authorization_url": "https://url.example.com",
"redirect_url": "https://url.example.com"
}
AdminPaymentProviderListedAsRelation
Description
A related payment provider
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the payment provider |
project_id - Int!
|
The project id of the payment provider |
name - String
|
The name of the payment provider |
description - String
|
The description of the payment provider |
type - String
|
The type of the payment provider |
status - PaymentProviderStatusEnum
|
The status of the product |
device_capability - Int
|
The device payment capabilities of the payment provider |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"description": "string",
"type": "string",
"status": "string",
"device_capability": 42
}
AdminPaymentProviderRemoteAccount
Description
Information about the remotely connected account for a given payment provider
Fields
| Field Name | Description |
|---|---|
created_at - String
|
The creation date (UTC) of the remotely connected account |
id - String
|
The id of the remotely connected account |
profiles - [AdminPaymentProviderRemoteAccountProfile]
|
List of the available profile ids within the remotely connected account |
name - String
|
The name of the remotely connected account |
onboarding_status - String
|
The onboading status of the remotely connected account |
onboarding_status_message - String
|
The onboading status message of the remotely connected account |
can_receive_payments - Boolean
|
The ability to receive user payments of the remotely connected account |
can_receive_payments_message - String
|
The status message regarding the ability to receive user payments of the remotely connected account |
can_receive_settlements - Boolean
|
The ability to receive settlements (payouts) of the remotely connected account |
can_receive_settlements_message - String
|
The status message regarding the ability to receive settlements (payouts) of the remotely connected account |
Example
{
"created_at": "2000-12-31T12:34:56.000Z",
"id": "string",
"profiles": [AdminPaymentProviderRemoteAccountProfile],
"name": "string",
"onboarding_status": "string",
"onboarding_status_message": "string",
"can_receive_payments": true,
"can_receive_payments_message": "string",
"can_receive_settlements": true,
"can_receive_settlements_message": "string"
}
AdminPaymentProviderRemoteAccountProfile
Description
Information about the remotely connected account for a given payment provider
Example
{
"remote_profile_id": "string",
"remote_profile_name": "string",
"payment_methods": ["string"]
}
AdminPaymentProvidersListedWithPagination
Description
Payment provider list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentProvider]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPaymentProvider],
"pagination": Pagination
}
AdminPaymentSyndicate
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the syndicate |
project_id - Int!
|
The project id of the syndicate |
name - String
|
The name of the syndicate |
type - PaymentSyndicateTypeEnum
|
The type of the syndicate |
created_at - String
|
The creation date (UTC) of the syndicate |
updated_at - String
|
The last modification date (UTC) of the syndicate |
vouchers - [AdminPaymentSyndicateVoucher]
|
List of related vouchers of the syndicate |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"type": "internal",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"vouchers": [AdminPaymentSyndicateVoucher]
}
AdminPaymentSyndicateVoucher
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher |
project_id - Int!
|
The project id of the voucher |
description - String
|
The name of the voucher |
name - String
|
The name of the voucher |
payment_syndicate_id - Int
|
The payment syndicate id of the voucher |
subscription_id - Int
|
The subscription id of the voucher |
description_translations - [Translation]
|
The translations for given property |
currency - String
|
The currency of the voucher |
currency_symbol - String
|
The currency symbol of the voucher |
amount - Float
|
The price/amount of the voucher |
installment_num - Int
|
The number of periodic installments of the voucher |
max_claimed_num - Int
|
The maximum number of times the voucher can be claimed |
max_claimed_per_user_num - Int
|
The maximum number of times the voucher can be claimed by each unique user |
claimed_num - Int
|
The number of times codes from the voucher have been claimed |
is_allow_on_valid_subscription - Boolean
|
The setting of the voucher to allow usage on already valid user subscriptions |
user_subscription_status_action - String
|
The user subscription status action of the voucher |
newsletter_list_id - String
|
The newsletter list id of the voucher |
time_unit - SubscriptionTimeUnitEnum
|
The voucher time unit |
discount_type - PaymentSyndicateVoucherDiscountTypeEnum
|
The voucher discount type |
installment_type - PaymentSyndicateVoucherInstallmentTypeEnum
|
The voucher installment type |
type - PaymentSyndicateVoucherTypeEnum
|
The type of the voucher |
issue_installments_until - String
|
The date (UTC) of the voucher until which installments are issued |
installed_at - String
|
The installation date (UTC) of the voucher |
expires_at - String
|
The expiry date (UTC) of the voucher |
created_at - String
|
The creation date (UTC) of the voucher |
updated_at - String
|
The last modification date (UTC) of the voucher |
syndicate - AdminPaymentSyndicate
|
The payment syndicate to which the voucher belongs |
batches - [AdminPaymentSyndicateVoucherCodeBatch]
|
List of related voucher code batches of the voucher |
scoped_products - [AdminProduct]
|
The scoped products to which the voucher can be applied |
products - [AdminProductListedAsRelation]
|
The related products of the subscription |
subscription - AdminSubscription
|
The subscription on which this voucher can be applied |
eligible_email_addresses - [String]
|
The related (partial) e-mail addresses eligible for voucher validation |
Example
{
"id": 42,
"project_id": 42,
"description": "string",
"name": "string",
"payment_syndicate_id": 42,
"subscription_id": 42,
"description_translations": [Translation],
"currency": "EUR",
"currency_symbol": "EUR",
"amount": 987.65,
"installment_num": 42,
"max_claimed_num": 42,
"max_claimed_per_user_num": 42,
"claimed_num": 42,
"is_allow_on_valid_subscription": false,
"user_subscription_status_action": "string",
"newsletter_list_id": "string",
"time_unit": "day",
"discount_type": "percentage",
"installment_type": "fixed_date",
"type": "generic",
"issue_installments_until": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"syndicate": AdminPaymentSyndicate,
"batches": [AdminPaymentSyndicateVoucherCodeBatch],
"scoped_products": [AdminProduct],
"products": [AdminProductListedAsRelation],
"subscription": AdminSubscription,
"eligible_email_addresses": ["foo@example.com"]
}
AdminPaymentSyndicateVoucherCode
Description
Payment syndicate voucher code
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher code |
payment_syndicate_voucher_id - Int!
|
The voucher code id |
payment_syndicate_voucher_code_batch_id - Int!
|
The voucher code batch id |
code - String
|
The name of the voucher code |
claimed_num - Int!
|
The number of times the voucher code has been claimed |
claimed_at - String
|
The claim date (UTC) of the voucher code |
created_at - String
|
The creation date (UTC) of the voucher code |
updated_at - String
|
The last modification date (UTC) of the voucher code |
batch - AdminPaymentSyndicateVoucherCodeBatch
|
The voucher code batch of the voucher code |
Example
{
"id": 42,
"payment_syndicate_voucher_id": 42,
"payment_syndicate_voucher_code_batch_id": 42,
"code": "string",
"claimed_num": 42,
"claimed_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"batch": AdminPaymentSyndicateVoucherCodeBatch
}
AdminPaymentSyndicateVoucherCodeBatch
Description
Payment syndicate voucher
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the voucher code batch |
payment_syndicate_voucher_id - Int!
|
The voucher id |
installment - Int
|
The voucher code batch installment number |
created_at - String
|
The creation date (UTC) of the voucher code batch |
updated_at - String
|
The last modification date (UTC) of the voucher code batch |
codes - AdminPaymentSyndicateVoucherCodesListedWithPagination
|
The list of voucher codes of the voucher code batch |
code_num - Int
|
The number of voucher codes of the voucher code batch |
claimed_num - Int
|
The number of times codes from the voucher code batch have been claimed |
Example
{
"id": 42,
"payment_syndicate_voucher_id": 42,
"installment": 42,
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"codes": AdminPaymentSyndicateVoucherCodesListedWithPagination,
"code_num": 42,
"claimed_num": 42
}
AdminPaymentSyndicateVoucherCodesListedWithPagination
Description
Payment syndicate voucher code list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentSyndicateVoucherCode]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPaymentSyndicateVoucherCode],
"pagination": Pagination
}
AdminPaymentSyndicateVouchersListedWithPagination
Description
Payment syndicate voucher list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentSyndicateVoucher]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPaymentSyndicateVoucher],
"pagination": Pagination
}
AdminPaymentSyndicatesListedWithPagination
Description
Payment syndicate voucher list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminPaymentSyndicate]
|
|
pagination - Pagination
|
Example
{
"items": [AdminPaymentSyndicate],
"pagination": Pagination
}
AdminProduct
Description
A product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [AdminArticle]
|
The related articles for the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
period_renewal_day - Int
|
The period-day number on which a recurring product renews |
is_sync_installments - Boolean
|
The recurring product is synchronised with user-subscription installments |
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
Expires-in time-unit midnight (UTC) offset value |
recurring_entitlement_expires_in_time_unit_num - Int
|
Expires-in interval in number of time_units for the issued product |
recurring_entitlement_expires_in - Int
|
Expires-in interval in seconds for the issued product |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
call_to_action_tag_translations - [Translation]
|
The translations for given property |
discoverability - ProductDiscoverabilityEnum
|
Discoverability of the product |
status - ProductStatusEnum
|
The status of the product |
published_from - String
|
Publish-from date (UTC) for the product |
published_until - String
|
Publish-until date (UTC) for the product |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The related issuable voucher of the product |
notification_topics - [AdminNotificationTopic]
|
The related notification topics of the product |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 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 related product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product id |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [AdminArticle]
|
The related articles for the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
period_renewal_day - Int
|
The period-day number on which a recurring product renews |
is_sync_installments - Boolean
|
The recurring product is synchronised with user-subscription installments |
frequency - Float
|
The recurring product frequency per time unit |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the recurring product |
recurring_entitlement_expires_in_time_unit_midnight_offset - Int
|
Expires-in time-unit midnight (UTC) offset value |
recurring_entitlement_expires_in_time_unit_num - Int
|
Expires-in interval in number of time_units for the issued product |
recurring_entitlement_expires_in - Int
|
Expires-in interval in seconds for the issued product |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
call_to_action_tag_translations - [Translation]
|
The translations for given property |
discoverability - ProductDiscoverabilityEnum
|
Discoverability of the product |
status - ProductStatusEnum
|
The status of the product |
published_from - String
|
Publish-from date (UTC) for the product |
published_until - String
|
Publish-until date (UTC) for the product |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
issuable_vouchers - [AdminPaymentSyndicateVoucher]
|
The related issuable voucher of the product |
notification_topics - [AdminNotificationTopic]
|
The related notification topics of the product |
files - [File]
|
List of files |
Arguments
|
|
product_price - Float
|
The set product price for given product id |
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 123.45,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [AdminArticle],
"categories": [CategoryListedAsRelation],
"period_renewal_day": 42,
"is_sync_installments": 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
}
AdminProductsListedWithPagination
Description
AdminProduct list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminProduct]
|
|
pagination - Pagination
|
Example
{
"items": [AdminProduct],
"pagination": Pagination
}
AdminProject
Description
A project
Example
{
"id": 42,
"name": "string",
"users": [User],
"managers": [User],
"status": "string",
"status_label": "string"
}
AdminProjectConfig
Description
A project config
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the project config |
project_id - Int
|
The id of the project |
key - String
|
The key of the project config |
value - String
|
The value of the project config |
Arguments
|
|
default_value - String
|
The default value of the project config |
label - String
|
The label of the project config |
type - String
|
The type of the project config |
is_read_only - Boolean
|
The project config can only be accessed as read only |
is_auth_only - Boolean
|
The project config can only be accessed with explicit password authentication |
related_file_type - String
|
The file type related to this project config |
created_at - String
|
The creation date (UTC) of the project config |
updated_at - String
|
The last modification date (UTC) of the project config |
Example
{
"id": 42,
"project_id": 42,
"key": "string",
"value": "string",
"default_value": "string",
"label": "string",
"type": "string",
"is_read_only": true,
"is_auth_only": false,
"related_file_type": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AdminProjectConfigsListedWithPagination
Description
AdminProjectConfig list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminProjectConfig]
|
|
pagination - Pagination
|
Example
{
"items": [AdminProjectConfig],
"pagination": Pagination
}
AdminRemoteAssetFile
Description
An asset
Fields
| Field Name | Description |
|---|---|
file_id - String
|
The file id |
file - String
|
The full file path and name including extension. |
file_name - String
|
The full file name including extension. |
file_extension - String
|
The file extension. |
file_size - Float
|
The file size in bytes. |
encoding_profile_name - AssetEncodingProfileNameEnum
|
The encoding profile name assigned to the file. |
file_md5 - String
|
The MD5 hash of the file. |
download_url - String
|
The download-url of the file. |
created_at - String
|
The creation date (UTC) of the remotely connected account |
Example
{
"file_id": "string",
"file": "string",
"file_name": "string",
"file_extension": "string",
"file_size": 987.65,
"encoding_profile_name": "sd_540p_16x9",
"file_md5": "string",
"download_url": "https://url.example.com",
"created_at": "2000-12-31T12:34:56.000Z"
}
AdminRemoteAssetFilesWithPagination
Description
Remote Asset list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminRemoteAssetFile]
|
|
pagination - Pagination
|
Example
{
"items": [AdminRemoteAssetFile],
"pagination": Pagination
}
AdminResourceMap
Description
A resource map
Fields
| Field Name | Description |
|---|---|
asset - [AdminResourceTypeMap]
|
Asset property map |
article - [AdminResourceTypeMap]
|
Article property map |
article_meta - [AdminResourceTypeMap]
|
Article meta property map |
category - [AdminResourceTypeMap]
|
Article property map |
category_meta - [AdminResourceTypeMap]
|
Category property map |
mail_template - [AdminResourceTypeMap]
|
Mail template property map |
menu - [AdminResourceTypeMap]
|
Menu property map |
menu_component - [AdminResourceTypeMap]
|
Menu component property map |
metric - [AdminResourceTypeMap]
|
Metric property map |
metric_action - [AdminResourceTypeMap]
|
Metric action property map |
notification - [AdminResourceTypeMap]
|
Notification template property map |
notification_topic - [AdminResourceTypeMap]
|
Notification topic template property map |
oauth_provider - [AdminResourceTypeMap]
|
OAuth2 Provider property map |
page - [AdminResourceTypeMap]
|
Page property map |
page_meta - [AdminResourceTypeMap]
|
Page meta property map |
page_component - [AdminResourceTypeMap]
|
Page component property map |
page_component_element - [AdminResourceTypeMap]
|
Page component element property map |
payment_syndicate_voucher - [AdminResourceTypeMap]
|
Payment syndicate voucher property map |
product - [AdminResourceTypeMap]
|
Product property map |
subscription - [AdminResourceTypeMap]
|
Subscription property map |
user - [AdminResourceTypeMap]
|
User property map |
user_payment_account_order - [AdminResourceTypeMap]
|
User payment account order property map |
user_subscription - [AdminResourceTypeMap]
|
User subscription property map |
Example
{
"asset": [AdminResourceTypeMap],
"article": [AdminResourceTypeMap],
"article_meta": [AdminResourceTypeMap],
"category": [AdminResourceTypeMap],
"category_meta": [AdminResourceTypeMap],
"mail_template": [AdminResourceTypeMap],
"menu": [AdminResourceTypeMap],
"menu_component": [AdminResourceTypeMap],
"metric": [AdminResourceTypeMap],
"metric_action": [AdminResourceTypeMap],
"notification": [AdminResourceTypeMap],
"notification_topic": [AdminResourceTypeMap],
"oauth_provider": [AdminResourceTypeMap],
"page": [AdminResourceTypeMap],
"page_meta": [AdminResourceTypeMap],
"page_component": [AdminResourceTypeMap],
"page_component_element": [AdminResourceTypeMap],
"payment_syndicate_voucher": [AdminResourceTypeMap],
"product": [AdminResourceTypeMap],
"subscription": [AdminResourceTypeMap],
"user": [AdminResourceTypeMap],
"user_payment_account_order": [AdminResourceTypeMap],
"user_subscription": [AdminResourceTypeMap]
}
AdminResourceTypeBlockMap
AdminResourceTypeMap
Description
A resource type map
Fields
| Field Name | Description |
|---|---|
type - String
|
Resource type |
properties - [AdminResourceTypePropertyMap]
|
Resource property map for given resource type |
blocks - [AdminResourceTypeBlockMap]
|
Available blocks to group given properties for display |
Example
{
"type": "string",
"properties": [AdminResourceTypePropertyMap],
"blocks": [AdminResourceTypeBlockMap]
}
AdminResourceTypePropertyMap
Description
A property map
Fields
| Field Name | Description |
|---|---|
name - String
|
Property name |
format - String
|
Property format |
values - [String]
|
Property list of values |
label - String
|
Property label |
is_required - Boolean
|
Property filling is required |
is_disabled - Boolean
|
Property input is disabled |
max_length - Int
|
Property max character length |
block_name - String
|
Block name indicating in which block the property must be grouped |
Example
{
"name": "string",
"format": "string",
"values": ["string"],
"label": "string",
"is_required": true,
"is_disabled": false,
"max_length": 42,
"block_name": "string"
}
AdminSubscription
Description
A subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles (excluding descendants) that are listed under the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [AdminPaymentProviderListedAsRelation]
|
The related payment providers of the subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
user_subscription_status_action - String
|
The user subscription status action of the voucher |
title_translations - [Translation]
|
The translations for given property |
description_translations - [Translation]
|
The translations for given property |
Arguments
|
|
description_short_translations - [Translation]
|
The translations for given property |
discoverability - SubscriptionDiscoverabilityEnum
|
Discoverability of the subscription |
status - SubscriptionStatusEnum
|
The status of the subscription |
products - [AdminProductListedAsRelation]
|
The related products of the subscription |
entitleable_articles - [ArticleListedAsRelation]
|
The complete list of articles (including descendants) that can be entitled through the subscription |
files - [File]
|
List of files |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [
AdminPaymentProviderListedAsRelation
],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"user_subscription_status_action": "string",
"title_translations": [Translation],
"description_translations": [Translation],
"description_short_translations": [Translation],
"discoverability": "hidden",
"status": "string",
"products": [AdminProductListedAsRelation],
"entitleable_articles": [ArticleListedAsRelation],
"files": [File]
}
AdminSubscriptionsListedWithPagination
Description
AdminSubscription list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminSubscription]
|
|
pagination - Pagination
|
Example
{
"items": [AdminSubscription],
"pagination": Pagination
}
AdminTelemetryGeoRegionSessionDay
Description
Telemetry metrics on geo region viewing sessions
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
geo_region_code - String
|
Geo region code for given data set |
geo_region_name - String
|
Geo region name for given data set |
time_watched - Int
|
Telemetry sum amount of time watched (seconds) for given geo region |
time_watched_fraction - Float
|
Telemetry fraction of time watched for given geo region |
num_unique_users - Int
|
Number of unique users that contributed to time_watched for given geo region |
num_unique_user_articles - Int
|
Number of unique user articles that contributed to time_watched for given geo region |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"geo_region_code": "nl",
"geo_region_name": "string",
"time_watched": 42,
"time_watched_fraction": 123.45,
"num_unique_users": 42,
"num_unique_user_articles": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryGeoRegionSessionDaysListedWithPagination
Description
Telemetry metrics on geo region viewing sessions list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryGeoRegionSessionDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryGeoRegionSessionDay],
"pagination": Pagination
}
AdminTelemetryPaymentSyndicateVoucherDay
Description
Telemetry metrics on voucher mutations
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
payment_syndicate_voucher_id - Int
|
Telemetry payment syndicate voucher id |
purchase_origin - String
|
Telemetry purchase origin |
tag - String
|
Telemetry type |
total_count - Int
|
Telemetry total number of user vouchers |
empty_count - Int
|
Telemetry total number of users without a user voucher |
aborted_count - Int
|
Telemetry number of aborted user voucher orders |
charged_back_count - Int
|
Telemetry number of charged-back user voucher orders |
open_count - Int
|
Telemetry number of open user voucher orders |
paid_count - Int
|
Telemetry number of paid user voucher orders |
refunded_count - Int
|
Telemetry number of refunded user voucher orders |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"payment_syndicate_voucher_id": 42,
"purchase_origin": "string",
"tag": "string",
"total_count": 42,
"empty_count": 42,
"aborted_count": 42,
"charged_back_count": 42,
"open_count": 42,
"paid_count": 42,
"refunded_count": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryPaymentSyndicateVoucherDaysListedWithPagination
Description
Telemetry metrics on daily voucher mutation list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryPaymentSyndicateVoucherDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryPaymentSyndicateVoucherDay],
"pagination": Pagination
}
AdminTelemetryPlatformSessionDay
Description
Telemetry metrics on platform viewing sessions
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
telemetry_platform - String
|
Telemetry platform for given data set |
time_watched - Int
|
Telemetry sum amount of time watched (seconds) for given telemetry platform |
time_watched_fraction - Float
|
Telemetry fraction of time watched for given telemetry platform |
num_unique_users - Int
|
Number of unique users that contributed to time_watched for given telemetry platform |
num_unique_user_articles - Int
|
Number of unique user articles that contributed to time_watched for given telemetry platform |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"telemetry_platform": "string",
"time_watched": 42,
"time_watched_fraction": 987.65,
"num_unique_users": 42,
"num_unique_user_articles": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryPlatformSessionDaysListedWithPagination
Description
Telemetry metrics on platform viewing sessions list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryPlatformSessionDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryPlatformSessionDay],
"pagination": Pagination
}
AdminTelemetryRealTimeData
Description
A real-time telemetry data set
Example
{
"concurrent_stream_num": 42,
"active_user_num": 42,
"published_article_num": 42
}
AdminTelemetrySearchTermsListedWithPagination
Description
Telemetry metrics on searched terms list with pagination
Fields
| Field Name | Description |
|---|---|
items - [StructureKeyValueIntegerPair]
|
|
pagination - Pagination
|
Example
{
"items": [StructureKeyValueIntegerPair],
"pagination": Pagination
}
AdminTelemetryUserActivityDay
Description
Telemetry metrics on daily user activity
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
product_count - Int
|
Telemetry total active Users entitled through a Product |
product_time_delta - Int
|
Telemetry total view time (seconds) of active Users entitled through a Product |
subscription_count - Int
|
Telemetry total active Users entitled through a Subscription |
subscription_time_delta - Int
|
Telemetry total view time (seconds) of active Users entitled through a Subscription |
authenticated_count - Int
|
Telemetry total active Users with an account |
authenticated_time_delta - Int
|
Telemetry total view time (seconds) of active Users with an account |
authenticated_4k_count - Int
|
Telemetry total active 4K-Users with an account |
authenticated_4k_time_delta - Int
|
Telemetry total view time (seconds) of active 4K-Users with an account |
non_authenticated_count - Int
|
Telemetry total active Users without an account (anonymous) |
non_authenticated_time_delta - Int
|
Telemetry total view time (seconds) of active Users without an account (anonymous) |
non_authenticated_4k_count - Int
|
Telemetry total active 4K-Users without an account (anonymous) |
non_authenticated_4k_time_delta - Int
|
Telemetry total view time (seconds) of active 4K-Users without an account (anonymous) |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"product_count": 42,
"product_time_delta": 42,
"subscription_count": 42,
"subscription_time_delta": 42,
"authenticated_count": 42,
"authenticated_time_delta": 42,
"authenticated_4k_count": 42,
"authenticated_4k_time_delta": 42,
"non_authenticated_count": 42,
"non_authenticated_time_delta": 42,
"non_authenticated_4k_count": 42,
"non_authenticated_4k_time_delta": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryUserActivityDaysListedWithPagination
Description
Telemetry metrics on daily user activity listed with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserActivityDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserActivityDay],
"pagination": Pagination
}
AdminTelemetryUserActivityMonth
Description
Telemetry metrics on monthly user activity
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
product_count - Int
|
Telemetry total active Users entitled through a Product |
product_time_delta - Int
|
Telemetry total view time (seconds) of active Users entitled through a Product |
subscription_count - Int
|
Telemetry total active Users entitled through a Subscription |
subscription_time_delta - Int
|
Telemetry total view time (seconds) of active Users entitled through a Subscription |
authenticated_count - Int
|
Telemetry total active Users with an account |
authenticated_time_delta - Int
|
Telemetry total view time (seconds) of active Users with an account |
authenticated_4k_count - Int
|
Telemetry total active 4K-Users with an account |
authenticated_4k_time_delta - Int
|
Telemetry total view time (seconds) of active 4K-Users with an account |
non_authenticated_count - Int
|
Telemetry total active Users without an account (anonymous) |
non_authenticated_time_delta - Int
|
Telemetry total view time (seconds) of active Users without an account (anonymous) |
non_authenticated_4k_count - Int
|
Telemetry total active 4K-Users without an account (anonymous) |
non_authenticated_4k_time_delta - Int
|
Telemetry total view time (seconds) of active 4K-Users without an account (anonymous) |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
julian_month - Int
|
Telemetry julian month |
Example
{
"project_id": 42,
"tag": "string",
"product_count": 42,
"product_time_delta": 42,
"subscription_count": 42,
"subscription_time_delta": 42,
"authenticated_count": 42,
"authenticated_time_delta": 42,
"authenticated_4k_count": 42,
"authenticated_4k_time_delta": 42,
"non_authenticated_count": 42,
"non_authenticated_time_delta": 42,
"non_authenticated_4k_count": 42,
"non_authenticated_4k_time_delta": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z",
"julian_month": 42
}
AdminTelemetryUserActivityMonthsListedWithPagination
Description
Telemetry metrics on monthly user activity listed with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserActivityMonth]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserActivityMonth],
"pagination": Pagination
}
AdminTelemetryUserArticleViewTimeSessionDay
Description
Telemetry metrics on incremented user article consumption
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
article_id - Int
|
Telemetry article id |
asset_id - Int
|
Telemetry asset id |
article_name - String
|
Telemetry article name |
asset_name - String
|
Telemetry asset name |
asset_duration - Float
|
Telemetry asset duration |
external_asset_id - String
|
Custom external asset id |
linked_type - ArticleAssetLinkedTypeEnum
|
Telemetry linked asset type |
metadata_markers - [StructureKeyValueStringPair]
|
Telemetry project defined metadata markers |
time_watched - Int
|
Telemetry time watched in seconds |
progress_avg - Float
|
Telemetry average asset completion progress |
entitlement_origin - String
|
Telemetry entitlement origin |
entitlement_resource_id - Int
|
Telemetry entitlement resource id |
num_completed - Int
|
Telemetry number of completed views |
num_progress_marker1_completed - Int
|
Telemetry number of completed views conform progress marker 1 |
num_progress_marker2_completed - Int
|
Telemetry number of completed views conform progress marker 2 |
num_progress_marker3_completed - Int
|
Telemetry number of completed views conform progress marker 3 |
num_unique_users - Int
|
Telemetry number of unique users |
num_favourites - Int
|
Telemetry number of articles marked favourite |
rating_value_avg - Float
|
Telemetry average rating value |
rating_user_num - Float
|
Telemetry rating user num value |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"article_id": 42,
"asset_id": 42,
"article_name": "string",
"asset_name": "string",
"asset_duration": 123.45,
"external_asset_id": "string",
"linked_type": "film",
"metadata_markers": [StructureKeyValueStringPair],
"time_watched": 42,
"progress_avg": 987.65,
"entitlement_origin": "string",
"entitlement_resource_id": 42,
"num_completed": 42,
"num_progress_marker1_completed": 42,
"num_progress_marker2_completed": 42,
"num_progress_marker3_completed": 42,
"num_unique_users": 42,
"num_favourites": 42,
"rating_value_avg": 987.65,
"rating_user_num": 987.65,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryUserArticleViewTimeSessionDaysListedWithPagination
Description
Telemetry metrics on daily user article view time consumption list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserArticleViewTimeSessionDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserArticleViewTimeSessionDay],
"pagination": Pagination
}
AdminTelemetryUserPaymentOrderDay
Description
Telemetry metrics on user payment order mutations
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
amount_aborted_sum - Float
|
Telemetry sum amount of aborted payment orders |
amount_paid_sum - Float
|
Telemetry sum amount of paid payment orders |
amount_refunded_sum - Float
|
Telemetry sum amount of refunded payment orders |
amount_charged_back_sum - Float
|
Telemetry sum amount of charged-back payment orders |
order_aborted_count - Int
|
Telemetry count of aborted payment orders |
order_paid_count - Int
|
Telemetry count of paid payment orders |
order_refunded_count - Int
|
Telemetry count of refunded payment orders |
order_charged_back_count - Int
|
Telemetry count of refunded payment orders |
order_total_count - Int
|
Telemetry total payment order count |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"amount_aborted_sum": 123.45,
"amount_paid_sum": 123.45,
"amount_refunded_sum": 987.65,
"amount_charged_back_sum": 123.45,
"order_aborted_count": 42,
"order_paid_count": 42,
"order_refunded_count": 42,
"order_charged_back_count": 42,
"order_total_count": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryUserPaymentOrderDaysListedWithPagination
Description
Telemetry metrics on daily user payment order mutation list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserPaymentOrderDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserPaymentOrderDay],
"pagination": Pagination
}
AdminTelemetryUserProductDay
Description
Telemetry metrics on user product mutations
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
product_id - Int
|
Telemetry product id |
product_name - String
|
Telemetry product name |
purchase_origin - String
|
Telemetry purchase origin |
tag - String
|
Telemetry type |
total_count - Int
|
Telemetry total number of user products |
empty_count - Int
|
Telemetry total number of users without a user product |
aborted_count - Int
|
Telemetry number of aborted user product orders |
charged_back_count - Int
|
Telemetry number of charged-back user product orders |
open_count - Int
|
Telemetry number of open user product orders |
paid_count - Int
|
Telemetry number of paid user product orders |
refunded_count - Int
|
Telemetry number of refunded user product orders |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"product_id": 42,
"product_name": "string",
"purchase_origin": "string",
"tag": "string",
"total_count": 42,
"empty_count": 42,
"aborted_count": 42,
"charged_back_count": 42,
"open_count": 42,
"paid_count": 42,
"refunded_count": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryUserProductDaysListedWithPagination
Description
Telemetry metrics on daily user product mutation list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserProductDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserProductDay],
"pagination": Pagination
}
AdminTelemetryUserSubscriptionDay
Description
Telemetry metrics on user subscription mutations
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
subscription_id - Int
|
Telemetry subscription id |
subscription_name - String
|
Telemetry subscription name |
purchase_origin - String
|
Telemetry purchase origin |
tag - String
|
Telemetry type |
total_count - Int
|
Telemetry total number of user subscriptions |
empty_count - Int
|
Telemetry total number of users without a user subscription |
subscribed_count - Int
|
Telemetry number of subscribed (active + suspended + demo) user subscriptions |
initialised_count - Int
|
Telemetry number of initialised user subscriptions |
active_count - Int
|
Telemetry number of active user subscriptions |
active_paid_count - Int
|
Telemetry number of active user subscriptions with payment mandate |
suspended_count - Int
|
Telemetry number of suspended user subscriptions |
suspended_paid_count - Int
|
Telemetry number of suspended user subscriptions with payment mandate |
demo_count - Int
|
Telemetry number of demo user subscriptions |
expired_count - Int
|
Telemetry number of expired user subscriptions |
stale_count - Int
|
Telemetry number of stale user subscriptions |
switch_from_count - Int
|
Telemetry number of user subscriptions marked to switch out of |
switch_to_count - Int
|
Telemetry number of user subscriptions to switch in to |
churn_rate - Float
|
Telemetry churn rate of user subscriptions |
growth_rate - Float
|
Telemetry growth rate of user subscriptions |
num_retention_days - Int
|
Telemetry average number of user subscription retention days |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"subscription_id": 42,
"subscription_name": "string",
"purchase_origin": "string",
"tag": "string",
"total_count": 42,
"empty_count": 42,
"subscribed_count": 42,
"initialised_count": 42,
"active_count": 42,
"active_paid_count": 42,
"suspended_count": 42,
"suspended_paid_count": 42,
"demo_count": 42,
"expired_count": 42,
"stale_count": 42,
"switch_from_count": 42,
"switch_to_count": 42,
"churn_rate": 123.45,
"growth_rate": 987.65,
"num_retention_days": 42,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryUserSubscriptionDayAggregate
Description
Telemetry aggregate metrics on user subscription mutations
Fields
| Field Name | Description |
|---|---|
churn_rate - Float
|
Telemetry churn rate of user subscriptions over given date range |
growth_rate - Float
|
Telemetry growth rate of user subscriptions over given date range |
num_retention_days - Int
|
Telemetry average number of user subscription retention days over given date range |
Example
{"churn_rate": 987.65, "growth_rate": 987.65, "num_retention_days": 42}
AdminTelemetryUserSubscriptionDaysListedWithPagination
Description
Telemetry metrics on daily user subscription mutation list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryUserSubscriptionDay]
|
|
aggregate - AdminTelemetryUserSubscriptionDayAggregate
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryUserSubscriptionDay],
"aggregate": AdminTelemetryUserSubscriptionDayAggregate,
"pagination": Pagination
}
AdminTelemetryVodEncodingDay
Description
Telemetry metrics on daily VOD encoding
Example
{
"project_id": 42,
"tag": "string",
"minutes_encoded": 123.45,
"hours_encoded": 987.65,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodEncodingDaysListedWithPagination
Description
Telemetry metrics on daily VOD encoding list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodEncodingDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodEncodingDay],
"pagination": Pagination
}
AdminTelemetryVodStorageDay
Description
Telemetry metrics on daily VOD storage
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
bytes - Float
|
Telemetry bytes stored |
bytes_in - Float
|
Telemetry bytes ingress |
bytes_out - Float
|
Telemetry bytes egress |
giga_bytes - Float
|
Telemetry Gigabytes stored |
giga_bytes_in - Float
|
Telemetry Gigabytes ingress |
giga_bytes_out - Float
|
Telemetry Gigabytes egress |
bytes_statics - Float
|
Telemetry bytes stored for static files (images, subtitles, etc) |
giga_bytes_statics - Float
|
Telemetry Gigabytes stored for static files (images, subtitles, etc) |
hours_stored - Float
|
Telemetry stored hours |
minutes_stored - Float
|
Telemetry stored minutes |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"bytes": 123.45,
"bytes_in": 123.45,
"bytes_out": 123.45,
"giga_bytes": 123.45,
"giga_bytes_in": 987.65,
"giga_bytes_out": 123.45,
"bytes_statics": 987.65,
"giga_bytes_statics": 123.45,
"hours_stored": 123.45,
"minutes_stored": 987.65,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodStorageDaysListedWithPagination
Description
Telemetry metrics on daily VOD storage list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodStorageDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodStorageDay],
"pagination": Pagination
}
AdminTelemetryVodStreamingDay
Description
Telemetry metrics on daily VOD streaming
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
bytes - Float
|
Telemetry bytes transferred |
giga_bytes - Float
|
Telemetry Gigabytes transferred |
bytes_zone1 - Float
|
Telemetry bytes transferred in CDN zone 1 |
giga_bytes_zone1 - Float
|
Telemetry Gigabytes transferred in CDN zone 1 |
bytes_zone2 - Float
|
Telemetry bytes transferred in CDN zone 2 |
giga_bytes_zone2 - Float
|
Telemetry Gigabytes transferred in CDN zone 2 |
bytes_zone3 - Float
|
Telemetry bytes transferred in CDN zone 3 |
giga_bytes_zone3 - Float
|
Telemetry Gigabytes transferred in CDN zone 3 |
bytes_zone4 - Float
|
Telemetry bytes transferred in CDN zone 4 |
giga_bytes_zone4 - Float
|
Telemetry Gigabytes transferred in CDN zone 4 |
bytes_zone5 - Float
|
Telemetry bytes transferred in CDN zone 5 |
giga_bytes_zone5 - Float
|
Telemetry Gigabytes transferred in CDN zone 5 |
bytes_zone6 - Float
|
Telemetry bytes transferred in CDN zone 6 |
giga_bytes_zone6 - Float
|
Telemetry Gigabytes transferred in CDN zone 6 |
bytes_statics - Float
|
Telemetry bytes transferred for static files (images, subtitles, etc) |
giga_bytes_statics - Float
|
Telemetry Gigabytes transferred for static files (images, subtitles, etc) |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"bytes": 123.45,
"giga_bytes": 987.65,
"bytes_zone1": 123.45,
"giga_bytes_zone1": 987.65,
"bytes_zone2": 987.65,
"giga_bytes_zone2": 123.45,
"bytes_zone3": 987.65,
"giga_bytes_zone3": 987.65,
"bytes_zone4": 987.65,
"giga_bytes_zone4": 987.65,
"bytes_zone5": 123.45,
"giga_bytes_zone5": 123.45,
"bytes_zone6": 987.65,
"giga_bytes_zone6": 123.45,
"bytes_statics": 123.45,
"giga_bytes_statics": 123.45,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodStreamingDaysListedWithPagination
Description
Telemetry metrics on daily VOD streaming list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodStreamingDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodStreamingDay],
"pagination": Pagination
}
AdminTelemetryVodStreamingMinute
Description
Telemetry metrics on minute-base VOD streaming
Example
{
"project_id": 42,
"tag": "string",
"bytes": 987.65,
"giga_bytes": 123.45,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodStreamingMinutesListedWithPagination
Description
Telemetry metrics on minute-base VOD streaming list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodStreamingMinute]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodStreamingMinute],
"pagination": Pagination
}
AdminTelemetryVodStreamingUnitDay
Description
Telemetry metrics on daily VOD streaming units
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
unit_num - Float
|
Actual integer number of bandwidth units currently committed |
observed_unit_num - Float
|
Observed fractional number of bandwidth units currently used (actual bandwidth usage) |
required_unit_num - Float
|
Calculated fractional number of bandwidth units needed in near future (predicted bandwidth usage) |
scaled_unit_num - Float
|
Number of bandwidth units for which a scaling event was fired |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"unit_num": 987.65,
"observed_unit_num": 123.45,
"required_unit_num": 987.65,
"scaled_unit_num": 123.45,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodStreamingUnitDaysListedWithPagination
Description
Telemetry metrics on daily VOD streaming units listed with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodStreamingUnitDay]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodStreamingUnitDay],
"pagination": Pagination
}
AdminTelemetryVodStreamingUnitMinute
Description
Telemetry metrics on minute-base VOD streaming units
Fields
| Field Name | Description |
|---|---|
project_id - Int
|
Telemetry project id |
tag - String
|
Telemetry type |
unit_num - Float
|
Actual integer number of bandwidth units currently committed |
observed_unit_num - Float
|
Observed fractional number of bandwidth units currently used (actual bandwidth usage) |
required_unit_num - Float
|
Calculated fractional number of bandwidth units needed in near future (predicted bandwidth usage) |
scaled_unit_num - Float
|
Number of bandwidth units for which a scaling event was fired |
julian_day - Int
|
Telemetry julian day |
observed_at - String
|
Telemetry observation date-time (UTC) |
Example
{
"project_id": 42,
"tag": "string",
"unit_num": 987.65,
"observed_unit_num": 123.45,
"required_unit_num": 987.65,
"scaled_unit_num": 123.45,
"julian_day": 42,
"observed_at": "2000-12-31T12:34:56.000Z"
}
AdminTelemetryVodStreamingUnitMinutesListedWithPagination
Description
Telemetry metrics on minute-base VOD streaming units listed with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminTelemetryVodStreamingUnitMinute]
|
|
pagination - Pagination
|
Example
{
"items": [AdminTelemetryVodStreamingUnitMinute],
"pagination": Pagination
}
AdminUser
Description
A user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [AdminUserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [AdminUserPaymentAccountOrder]
|
User orders |
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
external_user_id - String
|
External user id |
metas - [AdminUserMeta]
|
List of user metadata properties |
Arguments
|
|
managed_projects - [AdminProject]
|
List of managed projects |
recent_project - AdminProject
|
Last accessed project |
roles - [Role]
|
User roles |
user_product_orders - [AdminUserPaymentAccountOrder]
|
User product orders |
payment_accounts - [AdminUserPaymentAccount]
|
The user payment accounts |
article_view_sessions - [UserArticleSession]
|
List of all article view sessions of user |
Arguments
|
|
devices - [AdminDevice]
|
List of all paired devices of user |
activity_logs - [AdminActivityLog]
|
List of all activity logs for this resource |
Arguments
|
|
created_at - String
|
The creation date (UTC) of the user |
updated_at - String
|
The last modification date (UTC) of the user |
active_at - String
|
The last video viewing activity date (UTC) of the user |
credits - [AdminUserPaymentCredit]
|
User product orders |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": false,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [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]
}
AdminUserArticle
Description
A user article record, which holds al the "nomadic watching" information per user, per article, per asset
Fields
| Field Name | Description |
|---|---|
id - Int
|
The unique id of the UserArticle record |
user_id - Int
|
The user id of the UserArticle record, which references a User |
anonymous_user_id - String
|
An anonymous user id of the UserArticle record, which references a auto-generated fingerprint of an anonymous (public) user |
article_id - Int
|
The article id of the UserArticle record, which references an Article |
asset_id - Int
|
The asset id of the UserArticle record, which references an Asset |
linked_type - String
|
The linked asset type of the UserArticle record, which represents the link between Article and Asset |
device_type - String
|
The device type of the UserArticle record, which represents the device on which the User has last watched this Article-Assset |
user_agent - String
|
The user agent of the UserArticle record, which represents the browser/agent through which the User has last watched this Article-Assset |
geo_region_code - String
|
The two-character geo region code, which represents the country/region from which the User has last watched this Article-Assset |
subtitle_locale - String
|
The user-selected subtitle locale of the UserArticle record, which indicates the last selected subtitle-track locale (if any) for given Article-Asset |
audio_locale - String
|
The user-selected audio locale of the UserArticle record, which indicates the last selected audio-track locale (if any) for given Article-Asset |
time_watched - Int
|
The amount of time watched (seconds) during play-out of the UserArticle record, which represents the total, aggregated amount of time watched by given User for given Article-Asset |
appa - Float
|
The amount of elapsed seconds of play time of the UserArticle record, which represents the absolute play progress in seconds (between 0 and the Asset duration) for given User for given Article-Asset |
appr - Float
|
The relative play progress of the UserArticle record, which represents the completed percentage for given User for given Article-Asset |
is_favourite - Boolean
|
Indicates if the Article-Asset combination is marked as "favourite" for given User |
is_continue - Boolean
|
Indicates if the Article-Asset combination is marked as "continue watching" for given User |
is_history - Boolean
|
Indicates if the Article-Asset combination is marked as "watched" for given User |
entitlement_origin - String
|
The entitlement origin of the UserArticle record, which indicates the origin responsible for entitling play-out of given Article-Asset for given User |
entitlement_resource_id - Int
|
The entitlement resource id of the UserArticle record, which indicates the specific resource ("Product" or "Subscription") responsible for entitling play-out of given Article-Asset for given User |
is_progress_marker1_completed - Boolean
|
The fulfilment of custom progress marker 1 of the UserArticle record (default: 33% completion) |
is_progress_marker2_completed - Boolean
|
The fulfilment of custom progress marker 2 of the UserArticle record (default: not defined) |
is_progress_marker3_completed - Boolean
|
The fulfilment of custom progress marker 3 of the UserArticle record (default: not defined) |
num_completed - Int
|
The amount of times given User has completed play-out of given Article-Asset (i.e. has crossed the defined time_marker: "End", with a minimum interval of the Asset duration) |
rating_value - Float
|
The rating value given User has assigned given Article-Asset |
rated_at - String
|
The date (UTC) of the UserArticle record, at which it was last rated by given User |
completed_at - String
|
The date (UTC) of the UserArticle record, at which given User first finished play-out (i.e. crossed the defined time_marker: "End") |
created_at - String
|
The creation date (UTC) of the UserArticle record, either because it was marked as favourite or if play-out was started by given User |
updated_at - String
|
The last updated date (UTC) of the UserArticle record, which represents the last time given User watched given Article-Asset |
Example
{
"id": 42,
"user_id": 42,
"anonymous_user_id": "string",
"article_id": 42,
"asset_id": 42,
"linked_type": "film",
"device_type": "string",
"user_agent": "string",
"geo_region_code": "nl",
"subtitle_locale": "string",
"audio_locale": "string",
"time_watched": 42,
"appa": 987.65,
"appr": 0.246,
"is_favourite": false,
"is_continue": false,
"is_history": true,
"entitlement_origin": "string",
"entitlement_resource_id": 42,
"is_progress_marker1_completed": true,
"is_progress_marker2_completed": false,
"is_progress_marker3_completed": true,
"num_completed": 42,
"rating_value": 123.45,
"rated_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"
}
AdminUserArticleSession
Description
A user article view session record, which holds the incremental event data generated by play-out
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user-article-session record |
user_id - Int
|
The user id of the user-article-session record |
anonymous_user_id - String
|
The anonymous user id of the user-article-session record, i.e. an unknown user without a user account |
article_id - Int
|
The article id of the user-article-session record |
asset_id - Int
|
The asset id of the user-article-session record |
linked_type - String
|
The article-asset linked type of the user-article-session record |
time_watched - Int
|
The amount of time watched of the user-article-session record (only applies to event-types related to actual play time) |
time_delta - Float
|
The elapsed time for the given user-article-session record |
resolution_tag - String
|
The displayed resolution of the user-article session record |
event_type - String
|
The event type of the user-article-session record (Play-time event types: "play", "playing", "stop") |
event_payload - String
|
The recorded payload/message of the user-article-session record |
is_progress_marker1_completed - Boolean
|
The fulfilment of custom progress marker 1 of the user-article-session record |
is_progress_marker2_completed - Boolean
|
The fulfilment of custom progress marker 2 of the user-article-session record |
is_progress_marker3_completed - Boolean
|
The fulfilment of custom progress marker 3 of the user-article-session record |
is_completed - Boolean
|
The fulfilment of the asset completion marker of the user-article-session record |
device_type - String
|
The detected device-type of the user-article-session record |
device_brand - String
|
The detected device brand of the user-article-session record |
device_model - String
|
The detected device model of the user-article-session record |
telemetry_platform - String
|
The detected telemetry-platform of the user-article-session record |
ip_address - String
|
The IP address of the user-article-session record |
user_agent - String
|
The user agent of the UserArticle record, which represents the browser/agent through which the User has last watched this Article-Assset |
geo_region_code - String
|
The geo-region code of the user-article-session record |
audio_locale - String
|
The audio language ISO 639-1 code of the user-article-session record |
subtitle_locale - String
|
The subtitle language ISO 639-1 code of the user-article-session record |
started_at - String
|
The article-asset linked type of the user-article-session record |
Example
{
"id": 42,
"user_id": 42,
"anonymous_user_id": "string",
"article_id": 42,
"asset_id": 42,
"linked_type": "film",
"time_watched": 42,
"time_delta": 123.45,
"resolution_tag": "string",
"event_type": "string",
"event_payload": "string",
"is_progress_marker1_completed": false,
"is_progress_marker2_completed": false,
"is_progress_marker3_completed": true,
"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"
}
AdminUserArticleSessionsListedWithPagination
Description
User article session list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminUserArticleSession]
|
|
pagination - Pagination
|
Example
{
"items": [AdminUserArticleSession],
"pagination": Pagination
}
AdminUserArticlesListedWithPagination
Description
User article session list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminUserArticle]
|
|
pagination - Pagination
|
Example
{
"items": [AdminUserArticle],
"pagination": Pagination
}
AdminUserDetails
Description
Details of a user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [UserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [UserPaymentAccountOrder]
|
User orders |
Arguments
|
|
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
metas - [AdminUserMeta]
|
List of user metadata properties |
Arguments
|
|
managed_projects - [AdminProject]
|
List of managed projects |
managed_roles - [Role]
|
Roles that can be managed by given user |
recent_project - AdminProject
|
Last accessed project |
roles - [Role]
|
User roles |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR",
"metas": [AdminUserMeta],
"managed_projects": [AdminProject],
"managed_roles": [Role],
"recent_project": AdminProject,
"roles": [Role]
}
AdminUserMeta
Description
A user metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
user_id - Int
|
The metadata property parent user id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
translations - [UserMetaTranslation]
|
The translations for given metadata property |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
Example
{
"id": 42,
"user_id": 42,
"key": "string",
"value": "string",
"translations": [UserMetaTranslation],
"type": "array",
"format": "string"
}
AdminUserPaymentAccount
Description
A user payment account
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the account |
payment_provider_id - Int
|
The id of the payment provider |
amount_balance - Float
|
The amount balance of the account |
method - String
|
The payment method of the account |
method_details - String
|
The payment method details of the account |
geo_region_code - String
|
The geo region (i.e. country) from which the account creation originated |
orders - [UserPaymentAccountOrder]
|
The account orders |
remote_payment_user_id - String
|
The remote payment user id registered at the remote payment provider or gateway |
remote_payment_mandate_id - String
|
The remote payment mandate id registered at the remote payment provider or gateway, used to create recurring payments |
Example
{
"id": 42,
"payment_provider_id": 42,
"amount_balance": 987.65,
"method": "string",
"method_details": "string",
"geo_region_code": "nl",
"orders": [UserPaymentAccountOrder],
"remote_payment_user_id": "string",
"remote_payment_mandate_id": "string"
}
AdminUserPaymentAccountOrder
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the order |
user_id - Int
|
The user id of the order |
user_subscription_id - String
|
The user subscription id of the order |
payment_syndicate_voucher_id - Int
|
The payment syndicate voucher id attached to the order |
voucher_code - String
|
The voucher code attached to the order |
type - String
|
The type of the order |
recurring_type - String
|
The recurring type of the order |
discount_type - String
|
The discount type of the order |
payment_provider_type - String
|
The payment provider type of the order |
amount - Float
|
The amount of the order |
status - String
|
The status of the order |
status_name - String
|
The status name of the order |
description - String
|
The description of the order |
installed_at - String
|
The installation date (UTC) of the order |
paid_at - String
|
The payment fulfilment date (UTC) of the order |
cancelled_at - String
|
The cancellation date (UTC) of the order |
refunded_at - String
|
The refunded/charge-back date (UTC) of the order |
created_at - String
|
The creation date (UTC) of the order |
updated_at - String
|
The last modification date (UTC) of the order |
installments - [AdminUserPaymentAccountOrderInstallment]
|
The order installments |
currency - String
|
The currency of the order |
currency_symbol - String
|
The currency symbol of the order |
user - AdminUser
|
The user connected to the order |
user_payment_account_id - Int
|
The user payment account id of the order |
remote_payment_order_id - String
|
The remote payment provider order id of the order |
remote_payment_user_id - String
|
The remote payment user id of the order |
amount_balance_mutation - String
|
The balance mutation amount of the order |
amount_remote_mutation - String
|
The remote mutation amount of the order |
payment_url - String
|
The payment url of the order |
method - String
|
The payment method of the order |
method_details - String
|
The payment method details of the order |
ip_address - String
|
The ip address attached to the order |
geo_region_code - String
|
The geo region (i.e. country) from which this order originated |
origin - String
|
The source from which this order originated (e.g. user, moderator, api) |
purchase_origin - String
|
The purchase origin of the fulfilment of this order |
server_origin - String
|
The server instance on which the order originated |
is_refundable - Boolean
|
Is payment order refundable |
metadata - String
|
The order metadata and/or error details |
receipt_data - String
|
The order in-app purchase receipt data and/or error details |
invoice_data - String
|
The order invoice data which summarises purchased items and prices |
account - AdminUserPaymentAccount
|
The user payment account |
user_subscription - AdminUserSubscription
|
The related user subscription |
products - [AdminProductListedAsRelation]
|
The related products of the order |
Arguments
|
|
user_subscription_products - [AdminUserSubscriptionProduct]
|
The user subscription products (pivot relation) |
Arguments
|
|
categories - [AdminCategory]
|
List of (affiliation) categories this order relates to |
Example
{
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [
AdminUserPaymentAccountOrderInstallment
],
"currency": "EUR",
"currency_symbol": "EUR",
"user": AdminUser,
"user_payment_account_id": 42,
"remote_payment_order_id": "string",
"remote_payment_user_id": "string",
"amount_balance_mutation": "string",
"amount_remote_mutation": "string",
"payment_url": "https://url.example.com",
"method": "string",
"method_details": "string",
"ip_address": "string",
"geo_region_code": "nl",
"origin": "string",
"purchase_origin": "string",
"server_origin": "string",
"is_refundable": 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
}
AdminUserPaymentAccountOrdersListedWithPagination
Description
Payment account order list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminUserPaymentAccountOrder]
|
|
pagination - Pagination
|
Example
{
"items": [AdminUserPaymentAccountOrder],
"pagination": Pagination
}
AdminUserPaymentCredit
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the credit |
user_id - Int
|
The user id of the credit |
status - String
|
The status of the credit |
type - String
|
The type of the credit |
amount - Float
|
The amount of the credit |
amount_balance - Float
|
The amount balance of the credit |
installed_at - String
|
The installation date (UTC) of the credit |
expires_at - String
|
The expiry date (UTC) of the credit |
fulfilment_order - AdminUserPaymentAccountOrder
|
The order through which this credit was fulfilled |
fulfilment_order_origin - String
|
The fulfilment order origin |
fulfilment_order_purchase_origin - String
|
The fulfilment order purchase origin |
orders - [AdminUserPaymentAccountOrder]
|
The order through which this credit was fulfilled |
Example
{
"id": 42,
"user_id": 42,
"status": "string",
"type": "string",
"amount": 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
A user subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user subscription |
user_id - Int!
|
The id of the user |
project_id - Int!
|
The project id of the user subscription |
subscription_id - Int!
|
The subscription id of the user subscription |
switch_from_subscription_id - Int
|
The subscription id of the old subscription the user was switched from |
switch_to_subscription_id - Int
|
The subscription id of the new subscription to switch to at next renewal |
term - Int
|
The current term of the user subscription |
acquired_at - String
|
The acquisition date (UTC) of the user subscription |
expires_at - String
|
The expiry date (UTC) of the user subscription |
suspendable_at - String
|
The suspendability date (UTC) of the user subscription |
suspended_at - String
|
The suspension date of (UTC) of the user subscription |
invoiced_at - String
|
The next invoice date (UTC) of the user subscription |
status - UserSubscriptionStatusEnum
|
The status of the user subscription |
status_name - String
|
The status description of the user subscription |
is_valid - Boolean
|
The validity of the user subscription |
is_expired - Boolean
|
The expiry status of the user subscription |
is_suspendable - Boolean
|
The suspendability of the user subscription |
is_account_method_changeable - Boolean
|
The changeability of payment account method of the user subscription |
is_switchable - Boolean
|
The possibility of the user subscription to be switched |
user_subscription_products - [AdminUserSubscriptionProduct]
|
The user subscription products (pivot relation) |
Arguments
|
|
products - [AdminProductListedAsRelation]
|
The products related to the user subscription |
Arguments
|
|
orders - [AdminUserPaymentAccountOrder]
|
The user payment account orders |
Arguments
|
|
subscription - AdminSubscription
|
The parent subscription |
switch_to_subscription - AdminSubscription
|
The subscription the User will switch to at the next renewal |
switch_from_subscription - AdminSubscription
|
The subscription the User was switch from in the past |
account - AdminUserPaymentAccount
|
The user payment account |
last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
Example
{
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": true,
"is_expired": false,
"is_suspendable": true,
"is_account_method_changeable": false,
"is_switchable": true,
"user_subscription_products": [
AdminUserSubscriptionProduct
],
"products": [AdminProductListedAsRelation],
"orders": [AdminUserPaymentAccountOrder],
"subscription": AdminSubscription,
"switch_to_subscription": AdminSubscription,
"switch_from_subscription": AdminSubscription,
"account": AdminUserPaymentAccount,
"last_event_type": "first_payment_error"
}
AdminUserSubscriptionProduct
Description
A user subscription product
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the user subscription product |
product_id - Int
|
The id of the product |
user_subscription_id - Int
|
The id of the user subscription |
user_payment_account_order_id - Int
|
The id of the order |
purchase_num - Int
|
The item quantity of given product id |
product_price - Float
|
The set product price for given product id |
created_at - String
|
The creation date (UTC) |
renews_at - String
|
The renewal date (UTC) |
expires_at - String
|
The expiry date (UTC) |
product - AdminProduct
|
The parent product |
order - AdminUserPaymentAccountOrder
|
The user payment account order |
Example
{
"id": 42,
"product_id": 42,
"user_subscription_id": 42,
"user_payment_account_order_id": 42,
"purchase_num": 42,
"product_price": 7.99,
"created_at": "2000-12-31T12:34:56.000Z",
"renews_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"product": AdminProduct,
"order": AdminUserPaymentAccountOrder
}
AdminUsersListedWithPagination
Description
User list with pagination
Fields
| Field Name | Description |
|---|---|
items - [AdminUser]
|
|
pagination - Pagination
|
Example
{
"items": [AdminUser],
"pagination": Pagination
}
AnalyticsSearchTagTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"article"
Article
Description
An article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
featured_on_categories - [CategoryListedAsRelation]
|
List of categories this article is featured on |
recommended_articles - [ArticleRelated]
|
List of recommended articles |
children - [Article]
|
List of articles this article is parent of |
entitling_subscriptions - [SubscriptionListed]
|
List of subscriptions through which this article can be entitled |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"featured_on_categories": [CategoryListedAsRelation],
"recommended_articles": [ArticleRelated],
"children": [Article],
"entitling_subscriptions": [SubscriptionListed]
}
ArticleAssetInput
Description
An article asset input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The article asset id |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
linked_type - ArticleAssetLinkedTypeEnum
|
The article asset linked type |
Example
{"id": 42, "accessibility": "everyone", "linked_type": "episode"}
ArticleAssetLinkedTypeEnum
Description
The article asset linked type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"episode"
ArticleAssetPlayEntitlement
Description
An article asset play back entitlement
Fields
| Field Name | Description |
|---|---|
media_provider - String
|
The media provider |
encryption_type - String
|
The type of encryption |
encryption_provider - String
|
The encryption provider |
manifest - String
|
Streaming endpoint manifests |
protocol - String
|
The stream type |
mime_type - String
|
The stream mime type |
token - String
|
Play back entitlement token |
content_key_id - String
|
The content key id of the entitlement |
key_delivery_url - String
|
Key delivery url |
hls_key_uri - String
|
Key delivery uri |
expires_in - Int
|
Play back entitlement token ttl |
download_expires_in - Int
|
download policy ttl |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
Example
{
"media_provider": "string",
"encryption_type": "string",
"encryption_provider": "string",
"manifest": "string",
"protocol": "string",
"mime_type": "string",
"token": "string",
"content_key_id": "string",
"key_delivery_url": "https://url.example.com",
"hls_key_uri": "string",
"expires_in": 86400,
"download_expires_in": 86400,
"is_live": true
}
ArticleDiscoverabilityEnum
Description
The article discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
ArticleEntitlementOriginEnum
Description
The entitlement origin for an Article
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"subscription"
ArticleFileInput
Description
An article file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
article_id - Int
|
The file parent article id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"article_id": 42
}
ArticleListFilterTypeEnum
Description
The article list filter type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"trending"
ArticleListedAsRelation
Description
A listed related article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string"
}
ArticleListedAsResource
Description
A listed article resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
ArticleMeta
Description
An article metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
article_id - Int
|
The metadata property parent article id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"article_id": 42
}
ArticleMetaInput
Description
An article metadata input property
Fields
| Input Field | 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 - MetaFormatEnum
|
The metadata property rendering format |
locale - String
|
The metadata property locale |
article_id - Int
|
The metadata property parent article id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "date",
"locale": "string",
"article_id": 42
}
ArticleMetaTranslation
Description
An article metadata translation
Example
{
"id": 42,
"value": "string",
"locale": "string",
"article_meta_id": 42
}
ArticlePlayAudioQualityEnum
Description
The audio stream quality
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"audio_512kb"
ArticlePlayProtocolEnum
Description
The media stream protocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"mss"
ArticlePlayResolutionEnum
Description
The media stream resolution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"w3840_h2160"
ArticleRelated
Description
A related article
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the article |
project_id - Int!
|
The project id of the article |
parent_id - Int
|
The parent id of the article |
name - String
|
The name of the article |
url_slug - String
|
The url slug of the article |
Arguments
|
|
full_url_slug - String
|
The full url slug of the article |
Arguments
|
|
canonical_url - String
|
The canonical url of the article |
canonical_title - String
|
The canonical title of the article |
upsell_product_call_to_action_tag - String
|
The call-to-action tag for related upsell products of the article |
ribbon_title - String
|
The ribbon title of the article thumbnail |
ribbon_settings - String
|
The style settings of the article thumbnail ribbon |
type - ArticleTypeEnum
|
The type of the article (e.g. film, trailer, episode) |
metas - [ArticleMeta]
|
List of article metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
documents - [File]
|
List of documents |
assets - [Asset]
|
List of assets this article has |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
geo_regions - [GeoRegion]
|
List of geo regions this article belongs to |
locale_regions - [LocaleRegion]
|
List of locale regions this article belongs to |
products - [ProductListedAsRelation]
|
The related products of the article |
upsell_products - [ProductListedAsRelation]
|
The related upsell-products of the article |
created_at - String
|
The creation date (UTC) of the article |
updated_at - String
|
The last modification date (UTC) of the article |
popularity_index - Int
|
The popularity index of the article |
visibility - ResourceVisibilityEnum
|
Public availability of the article |
discoverability - ArticleDiscoverabilityEnum
|
Discoverability of the article |
is_downloadable - Boolean
|
Article is available for in-app download |
is_auth_required - Boolean
|
Article requires authentication |
published_at - String
|
Publish-at date (UTC) for the article |
linked_asset_playable_from - String
|
Visible-from date (UTC) for the primary asset (typically of live-streaming type) linked to the article |
status - Int
|
Status of the article |
asset_id - Int
|
The asset id |
is_favourite - Boolean
|
Is article marked as favourite (only relevant if this related article represents a viewed user article) |
is_continue - Boolean
|
Is article marked as continue watching (only relevant if this related article represents a viewed user article) |
is_history - Boolean
|
Is article marked as history (only relevant if this related article represents a viewed user article) |
subtitle_locale - String
|
The user-selected subtitle locale (only relevant if this related article represents a viewed user article) |
audio_locale - String
|
The user-selected audio locale (only relevant if this related article represents a viewed user article) |
rating_value - Float
|
The user-assigned rating value of the article (only relevant if this related article represents a viewed user article) |
root_article_id - Int
|
The root id of the entitled article, i.e. the first ancestor (typically an Article of type series) |
appa - Float
|
The asset absolute play position (only relevant if this related article represents a viewed user article) |
appr - Float
|
The asset relative play position (only relevant if this related article represents a viewed user article) |
linked_type - ArticleAssetLinkedTypeEnum
|
The linked asset type |
entitling_product_id - Int
|
The id of the product that entitled this article (only relevant if this related article represents an entitled article) |
issuing_user_payment_account_order_id - Int
|
The id of the user-payment-account-order that issued this entitled article (only relevant if this related article represents an entitled article) |
is_entitlement_expired - Boolean
|
The entitlement of the article has expired (only relevant if this related article represents an entitled article) |
expires_in - Int
|
The expiry interval (seconds), (only relevant if this related article represents an entitled article) |
expires_at - String
|
The entitlement expiry date (UTC), (only relevant if this related article represents an entitled article) |
entitled_at - String
|
The entitlement date (UTC), (only relevant if this related article represents an entitled article) |
nomadic_updated_at - String
|
The last updated date (UTC) of the nomadic article-asset (only relevant if this related article represents a viewed user article) |
nomadic_completed_at - String
|
The completion date (UTC) of the nomadic article-asset (only relevant if this related article represents a viewed user article) |
nomadic_num_completed - Int
|
The number of times the nomadic article-asset has been completely viewed (only relevant if this related article represents a viewed user article) |
Example
{
"id": 42,
"project_id": 42,
"parent_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"canonical_title": "string",
"upsell_product_call_to_action_tag": "string",
"ribbon_title": "string",
"ribbon_settings": "string",
"type": "episode",
"metas": [ArticleMeta],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"documents": [File],
"assets": [Asset],
"categories": [CategoryListedAsRelation],
"geo_regions": [GeoRegion],
"locale_regions": [LocaleRegion],
"products": [ProductListedAsRelation],
"upsell_products": [ProductListedAsRelation],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"popularity_index": 42,
"visibility": "everyone",
"discoverability": "hidden",
"is_downloadable": false,
"is_auth_required": true,
"published_at": "2000-12-31T12:34:56.000Z",
"linked_asset_playable_from": "string",
"status": "string",
"asset_id": 42,
"is_favourite": true,
"is_continue": true,
"is_history": true,
"subtitle_locale": "string",
"audio_locale": "string",
"rating_value": 987.65,
"root_article_id": 42,
"appa": 987.65,
"appr": 0.246,
"linked_type": "film",
"entitling_product_id": 42,
"issuing_user_payment_account_order_id": 42,
"is_entitlement_expired": true,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"entitled_at": "2000-12-31T12:34:56.000Z",
"nomadic_updated_at": "2000-12-31T12:34:56.000Z",
"nomadic_completed_at": "2000-12-31T12:34:56.000Z",
"nomadic_num_completed": 42
}
ArticleTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"episode"
Asset
Description
An asset
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the asset |
project_id - Int!
|
The project id of the asset |
source_blob_name - String
|
Source blob name |
thumbnail_asset_id - String
|
Thumbnail asset id |
is_live - Boolean
|
Asset is a live stream (only applicable to Assets of type "video" or "audio") |
type - AssetTypeEnum
|
Asset type |
linked_type - ArticleAssetLinkedTypeEnum
|
Linked asset type |
accessibility - ResourceAccessibilityEnum
|
The article asset accessibility |
time_marker_intro_start - Float
|
The time marker of the start of the intro (seconds since start) |
time_marker_intro_end - Float
|
The time marker of the end of the intro (seconds since start) |
time_marker_end - Float
|
The time marker of the end of the asset (seconds since start) |
duration - Float!
|
The duration asset (seconds) |
aspect_ratio - String
|
The human-readable aspect ratio of the asset (e.g. 16x9) |
aspect_ratio_fraction - String
|
The fractional aspect ratio of the asset (e.g. 1.778) |
subtitles - [File]
|
The asset subtitles |
Arguments
|
|
screenshots - [File]
|
List of screenshot images |
playable_from - String
|
Visible-from date (UTC) for the asset (typically used to indicate when a live event will begin). |
playable_until - String
|
Visible-until date (UTC) for the asset (typically used to indicate when a live event will end). |
published_from - String
|
Publish-from date (UTC) for the asset |
published_until - String
|
Publish-until date (UTC) for the asset |
created_at - String
|
The creation date (UTC) of the asset |
updated_at - String
|
The last modification date (UTC) of the asset |
Example
{
"id": 42,
"project_id": 42,
"source_blob_name": "string",
"thumbnail_asset_id": "string",
"is_live": false,
"type": "audio",
"linked_type": "film",
"accessibility": "everyone",
"time_marker_intro_start": 123.45,
"time_marker_intro_end": 987.65,
"time_marker_end": 123.45,
"duration": 123.45,
"aspect_ratio": "16x9",
"aspect_ratio_fraction": 1.778,
"subtitles": [File],
"screenshots": [File],
"playable_from": "string",
"playable_until": "string",
"published_from": "string",
"published_until": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
AssetEncodingProfile
Description
The Asset encoding profile
Fields
| Field Name | Description |
|---|---|
encoding_profile_name - AssetEncodingProfileNameEnum
|
Asset encoding profile name |
tag - String
|
Asset encoding profile tag |
label - String
|
Asset encoding profile label |
description - String
|
Asset encoding profile human readable description |
Example
{
"encoding_profile_name": "sd_540p_16x9",
"tag": "string",
"label": "string",
"description": "string"
}
AssetEncodingProfileNameEnum
Description
The name of the Asset encoding profile
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"sd_540p_16x9"
AssetEncryptionProfile
Description
The Asset encryption profile
Fields
| Field Name | Description |
|---|---|
encryption_profile_name - AssetEncryptionProfileNameEnum
|
Asset encryption profile name |
tag - String
|
Asset encryption profile tag |
label - String
|
Asset encryption profile label |
description - String
|
Asset encryption profile human readable description |
is_best_match - Boolean
|
Asset encryption profile is part of the "best match" selection, at most two profiles are eligible for "best match" (typically these are profile "none" and one other encryption profile) |
Example
{
"encryption_profile_name": "none",
"tag": "string",
"label": "string",
"description": "string",
"is_best_match": false
}
AssetEncryptionProfileNameEnum
Description
The name of the Asset encryption profile
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"none"
AssetFileInput
Description
An asset file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
asset_id - Int
|
The file parent asset id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"asset_id": 42
}
AssetMediaProviderNameEnum
Description
The name of the Asset media provider type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"mock"
AssetState
Description
The actual Asset state, including local and remote status properties.
Fields
| Field Name | Description |
|---|---|
current_asset_status_id - Int
|
The asset current status id |
current_asset_status_name - String
|
The asset current status name |
calculated_asset_status_id - Int
|
The asset calculated status id |
calculated_asset_status_name - String
|
The asset calculated status name |
live_remote_asset_id - String
|
The remote live asset id |
live_remote_asset_status_name - String
|
The remote live asset status name |
live_remote_asset_status_description - String
|
The remote live asset status description |
is_live_remote_asset_source_video_encoding - Boolean
|
The remote live asset is currently encoding a live source audio/video stream |
is_live_remote_asset_encoded_video_packaging - Boolean
|
The remote live asset is currently outputting an encoded live audio/video stream |
Example
{
"current_asset_status_id": "string",
"current_asset_status_name": "string",
"calculated_asset_status_id": "string",
"calculated_asset_status_name": "string",
"live_remote_asset_id": "string",
"live_remote_asset_status_name": "string",
"live_remote_asset_status_description": "string",
"is_live_remote_asset_source_video_encoding": true,
"is_live_remote_asset_encoded_video_packaging": true
}
AssetStatusEnum
Description
The asset status types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"source_asset_created"
AssetTypeEnum
Description
The article type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"audio"
Authenticate
Description
Authentication credentials
Fields
| Field Name | Description |
|---|---|
access_token - String
|
The authentication token |
refresh_token - String
|
The refresh token |
expires_in - Int
|
Expiration time in seconds |
token_type - String
|
The access token type |
user_id - Int
|
The user id belonging to the authentication token (in case token was issued for an administrator, this property represents the user id of that administrator) |
user_email - String
|
The user email belonging to the authentication token (in case token issued for an administrator, this property represents the email address of that administrator) |
active_project_id - Int
|
The active project_id for the issued authentication token |
url - String
|
A url relevant for given credentials may be issued if applicable |
Example
{
"access_token": "string",
"refresh_token": "string",
"expires_in": 86400,
"token_type": "string",
"user_id": 42,
"user_email": "foo@example.com",
"active_project_id": 42,
"url": "https://url.example.com"
}
Boolean
Description
The Boolean scalar type represents true or false.
CategoryFileInput
Description
A category file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
category_id - Int
|
The file parent category id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"category_id": 42
}
CategoryListFilterTypeEnum
Description
The article list filter type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"article_taggable"
CategoryListedAsRelation
Description
A listed relational category
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the category |
project_id - Int!
|
The project id of the category |
name - String
|
The name of the category |
url_slug - String
|
The url slug of the category |
Arguments
|
|
full_url_slug - String
|
The full url slug of the category |
Arguments
|
|
canonical_url - String
|
The canonical url of the category |
type - CategoryTypeEnum
|
The type of the category |
metas - [CategoryMeta]
|
List of category metadata properties |
Arguments
|
|
icons - [File]
|
List of icons |
images - [File]
|
List of images |
videos - [File]
|
List of videos |
parent_id - Int
|
The parent id of the category |
child_metas - [String]
|
List of meta fields for child categories |
created_at - String
|
The creation date (UTC) of the category |
updated_at - String
|
The last modification date (UTC) of the category |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"url_slug": "url-slug-string",
"full_url_slug": "url-slug-string",
"canonical_url": "https://url.example.com",
"type": "article_label",
"metas": [CategoryMeta],
"icons": [File],
"images": [File],
"videos": [File],
"parent_id": 42,
"child_metas": ["string"],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
CategoryListedAsResource
Description
A listed category resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
CategoryMeta
Description
A category metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
category_id - Int
|
The metadata property parent category id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "string",
"category_id": 42
}
CategoryMetaInput
Description
A category metadata input property
Fields
| Input Field | 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 - MetaFormatEnum
|
The metadata property rendering format |
locale - String
|
The metadata property locale |
category_id - Int
|
The metadata property parent category id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "date",
"locale": "string",
"category_id": 42
}
CategoryMetaTranslation
Description
A category metadata translation
Example
{
"id": 42,
"value": "string",
"locale": "string",
"category_meta_id": 42
}
CategoryTypeEnum
Description
The category type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article_label"
ClientServiceTypeEnum
Description
The service type of the oauth client
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"external_admin"
CoreProject
Description
A core project
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the project |
name - String
|
The name of project |
created_at - String
|
The creation date (UTC) of the project |
updated_at - String
|
The last modification date (UTC) of the project |
users - [CoreUser]
|
Related list of users |
managers - [CoreUser]
|
Related list of managers |
status - Int
|
The status of project |
status_label - String
|
The status label of project |
Example
{
"id": 42,
"name": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"users": [CoreUser],
"managers": [CoreUser],
"status": "string",
"status_label": "string"
}
CoreUser
Description
Details of a user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
metas - [CoreUserMeta]
|
List of user metadata properties |
Arguments
|
|
managed_projects - [CoreProject]
|
List of managed projects |
managed_roles - [Role]
|
Roles that can be managed by given user |
recent_project - CoreProject
|
Last accessed project |
roles - [Role]
|
User roles |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 987.65,
"weight": 123.45,
"custom_data": "string",
"is_newsletter_opt_in": false,
"is_terms_and_conditions_opt_in": false,
"is_marked_for_deletion": false,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"metas": [CoreUserMeta],
"managed_projects": [CoreProject],
"managed_roles": [Role],
"recent_project": CoreProject,
"roles": [Role]
}
CoreUserMeta
Description
A core user metadata property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The metadata property id |
user_id - Int
|
The metadata property parent user id |
key - String
|
The metadata property key |
value - String
|
The metadata property value |
translations - [UserMetaTranslation]
|
The translations for given metadata property |
type - MetaTypeEnum
|
The metadata property type |
format - String
|
The metadata property rendering format |
Example
{
"id": 42,
"user_id": 42,
"key": "string",
"value": "string",
"translations": [UserMetaTranslation],
"type": "array",
"format": "string"
}
CrmSyncContextEnum
Description
The CRM synchronisation context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"user_article"
DateRangeInput
DeviceModelContextEnum
Description
The device model context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"chromecast_legacy"
File
Description
A file
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the file |
name - String
|
The original name of the file |
title - String
|
The alt/title of the file |
type - FileTypeEnum
|
The type of the file |
size - Int
|
The size of the file |
width - Int
|
The width of the file |
height - Int
|
The height of the file |
aspect_ratio_profile - String
|
The aspect ratio profile |
duration - Int
|
The duration of the (audio/video) file (seconds) |
locale - String
|
The language locale code of the file |
locale_label - String
|
The language locale label of the file |
base_url - String
|
The base url of the file |
base_path - String
|
The base url path of the file |
url - String
|
The url of the file |
proxy_file_path - String
|
The proxy url of the file |
proxy_url - String
|
The proxy url of the file |
file_name - String
|
The name of the file |
file_path - String
|
The path of the file |
Example
{
"id": 42,
"name": "string",
"title": "string",
"type": "binary",
"size": 42,
"width": 42,
"height": 42,
"aspect_ratio_profile": "16x9",
"duration": 42,
"locale": "string",
"locale_label": "string",
"base_url": "https://url.example.com",
"base_path": "string",
"url": "https://url.example.com",
"proxy_file_path": "string",
"proxy_url": "https://url.example.com",
"file_name": "string",
"file_path": "string"
}
FileSubtitleFormatEnum
Description
The subtitle file format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"vtt"
FileTypeEnum
Description
The file type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"binary"
FilterByInput
Description
A filter-by input property
Fields
| Input Field | Description |
|---|---|
field - String
|
The field to filter on |
logic_operator - LogicOperatorEnum
|
The operator to apply |
value - String
|
The field value to filter on |
Example
{
"field": "string",
"logic_operator": "equals",
"value": "string"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GeoRegion
GeoRegionListed
GeoRegionsListedWithPagination
Description
Geo region list with pagination
Fields
| Field Name | Description |
|---|---|
items - [GeoRegionListed]
|
|
pagination - Pagination
|
Example
{
"items": [GeoRegionListed],
"pagination": Pagination
}
ImageResolution
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
42
LanguageTagContext
Description
Language tag context set
Fields
| Field Name | Description |
|---|---|
language_tag_context - LanguageTagContextEnum
|
The context identifier |
platform_contexts - [String]
|
The platform contexts for which the current language tag context is available |
title - String
|
The title of the context |
description - String
|
The description of the context |
language_tag_keys - [String]
|
The language tag keys belonging to this context |
Example
{
"language_tag_context": "language_tag_context_login_create_account",
"platform_contexts": ["string"],
"title": "string",
"description": "string",
"language_tag_keys": ["string"]
}
LanguageTagContextEnum
Description
The language tag context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"language_tag_context_login_create_account"
LocaleRegion
LocaleRegionListed
LocaleRegionsListedWithPagination
Description
Locale region list with pagination
Fields
| Field Name | Description |
|---|---|
items - [LocaleRegionListed]
|
|
pagination - Pagination
|
Example
{
"items": [LocaleRegionListed],
"pagination": Pagination
}
LogicOperatorEnum
Description
The logic operator type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"equals"
MailTemplateFileInput
Description
An mail template file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
mail_template_id - Int
|
The file parent mail template id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"mail_template_id": 42
}
MenuComponentFileInput
Description
An menu component file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
menu_component_id - Int
|
The file parent menu component id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"menu_component_id": 42
}
MenuComponentTypeEnum
Description
The menu component type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"button_url_link"
MetaFormatEnum
Description
The metadata format
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"date"
MetaOutputTypeEnum
Description
The metadata output type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"html"
MetaTypeEnum
Description
The metadata type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"array"
MetricAction
Description
A metric action
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the metric action |
project_id - Int!
|
The project id of the metric action |
name - String
|
The name of the metric action |
title - String
|
The title of the metric action |
content - String
|
The content of the metric action |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
files - [File]
|
List of files |
Arguments
|
|
fulfilled_at - String
|
The user fulfilment date (UTC) of the metric action |
acknowledged_at - String
|
The user acknowledgement date (UTC) of the metric action |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"title": "string",
"content": "string",
"icons": [File],
"images": [File],
"files": [File],
"fulfilled_at": "2000-12-31T12:34:56.000Z",
"acknowledged_at": "2000-12-31T12:34:56.000Z"
}
MetricActionFileInput
Description
A metric action file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
metric_action_id - Int
|
The file parent metric action id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"metric_action_id": 42
}
MetricActionStatusEnum
Description
The metric action status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
MetricActionTypeEnum
Description
The metric action type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"user_entitlement"
MetricConditionTypeEnum
Description
The metric condition type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"appa"
MetricStatusEnum
Description
The metric status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
MetricTypeEnum
Description
The metric type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"article"
NodePivotActionEnum
Description
The node pivot action type
Values
| Enum Value | Description |
|---|---|
|
|
Place resource at the sibling position immediately after the resource with given "pivot_id". |
|
|
Place resource at the sibling position immediately before the resource with given "pivot_id". |
|
|
Place resource a the last child position immediately under before the resource with given "pivot_id". |
Example
"after"
NotificationChannelContextEnum
Description
The notification channel context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"sms"
NotificationDeliveryTypeEnum
Description
The notification delivery type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"generic_users_on_topic"
NotificationFileInput
Description
A notification file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
notification_id - Int
|
The file parent notification id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"notification_id": 42
}
NotificationTopicTypeEnum
Description
The notification topic type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"general"
NotificationTypeEnum
Description
The notification type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"single"
OauthProviderStatusEnum
Description
The OauthProvider status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"inactive"
OauthProviderTypeEnum
Description
The OauthProvider type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"facebook"
PageComponentDisplayTypeEnum
Description
The page component display type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"sliding_carousel"
PageComponentElementFileInput
Description
A page component element file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
page_component_element_id - Int
|
The file parent page component element id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_component_element_id": 42
}
PageComponentElementTypeEnum
Description
The page component element type
Values
| Enum Value | Description |
|---|---|
|
|
This element displays a button that when clicked, directly opens the registration flow. It is only displayed when a User is not logged in. |
|
|
This element displays a rounded button that when clicked, opens a give Page. It is typically used in a component of type "carousel". |
|
|
This element displays a round button that when clicked, opens a relative or absolute Url. It is typically used in a component of type "carousel". |
|
|
This element displays button that when clicked, opens a login pop-up. |
|
|
This element displays button that when clicked, opens a pop-up where a User can log in or create a new User account. |
|
|
This element displays button that when clicked, immediately logs out the User. It is only displayed when a User is logged in. |
|
|
This element displays a button that when clicked, opens a give Page. |
|
|
This element displays a button that when clicked, opens a relative or absolute Url. |
|
|
This element displays a button that when clicked, opens the purchase flow for given Product. |
|
|
This element displays a button that when clicked, opens the purchase flow for given Subscription. |
|
|
This element displays a button that when clicked, opens the video player for given Article. |
|
|
This element displays a button that when clicked, opens a registration pop-up for the given Newsletter List ID (configuration of a CRM-integration is required). |
|
|
This element displays a button that when selected, allows the User to change the language of the TV-app. |
|
|
This element represents a single slide within the carousel component. It can be configured to display a poster or background video as well as multiple calls to action. |
|
|
This element allows a User to enter the pairing code that is displayed on their TV app, thus linking that device/app to their User account. |
|
|
This element displays an overview of the devices/apps that are linked to the User account, as well as the option to remove items from that list. |
|
|
This element allows you to configure a parent filter Category, of which the child Categories are automatically presented to the User a s filter buttons. |
|
|
This element specifically displays the User Subscription status as well as options to purchase or switch Subscriptions. |
|
|
This element displays the current amount balance, which is typically result of redeemed gift cards for a certain amount. When the Project is configured for credit usage, the credit balance is also displayed. |
|
|
This element allows the User to redeem a voucher code. If the User has an active Subscription, a voucher code suitable for Subscriptions may be immediately applied to that active User Subscription. |
|
|
This element allows the User to see and/or change the current payment method that is configured for recurring payments. It is recommended to always display this element when the Project uses Subscriptions. |
|
|
This element allows the User to continue or discontinue their User Subscription by activating or suspending the recurring payment renewal. |
|
|
This element displays an overview of the order history. This overview includes single purchases as well as recurring payments. |
|
|
This element allows the User to modify their address (street name) of residence. |
|
|
This element allows the User to modify their birthday. |
|
|
This element allows the User to modify their city of residence. |
|
|
This element allows the User to modify their country of residence. |
|
|
This element allows the User to modify their e-mail address. |
|
|
This element allows the User to modify their first name. |
|
|
This element allows the User to select their gender. |
|
|
This element allows the User to modify their body height. |
|
|
This element allows the User to modify their last/family name. |
|
|
This element allows the User to modify their full name (automatic detection of first/last name is implemented). |
|
|
This element allows the User to opt-in to receiving newsletters (configuration of a CRM-integration is required). |
|
|
This element allows the User to opt-in to the general terms and conditions as defined by the Project. When configured, User opt-in is always mandatory. |
|
|
This element allows the User to select of they are notifiable via SMS text messages or push notifications (configured in the secion "Push notification"). |
|
|
This element allows the User to modify their password. |
|
|
This element allows the User to modify their phone number. |
|
|
This element allows the User to modify their zip/postal code of residence. |
|
|
This element allows the User to select the cookie consents of their choice. |
|
|
This element allows the User select the push notification topics of their choice. |
|
|
This element allows the User to modify their body address. |
|
|
This element allows you to configure a single Subscription banner that is displayed inside the "subscriptions" component. |
|
|
This type is reserved for legacy TV apps only, and is deprecated. |
|
|
This element represents a single slide within the text carousel component. It can be configured to display a small WYSIWYG text component. |
|
|
This element represents a single USP bullet. It can be configured to display a small WYSIWYG text component. |
|
|
This element is provided for the benefit of custom API-integrations, but has no practical application in the general CMS-context. |
|
|
This element displays the information and actual link a User can click to initiate deletion of their account. |
|
|
This element informs the User that their account is scheduled for deletion, and allows the User to undo this. |
Example
"button_account_create"
PageComponentFileInput
Description
A page component file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
page_component_id - Int
|
The file parent page component id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_component_id": 42
}
PageComponentTypeEnum
Description
The page component type
Values
| Enum Value | Description |
|---|---|
|
|
This component allows you to configure the registration form a User must fill out to create a User account. |
|
|
This component allows you to configure the notification a User sees when registration is not allowed (typically due to geo-region restrictions). |
|
|
This component allows you to configure the "delete account" button on the payment account page, through which a User can initiate account deletion conform GDPR. |
|
|
This component displays all Articles a User is entitled to watch, either through purchase, rental or voucher redemption. |
|
|
This component displays all Articles a User has marked as "favourite". |
|
|
This component displays the most recent Articles a User has previously completely watched. |
|
|
This component displays the most recent Articles a User has not yet completely watched, so that they can continue watching. |
|
|
This component allows you to configure a large click-area which you can fill with an image/poster and text. Clicking the area directs the User to a given Page. |
|
|
This component allows you to configure a large click-area which you can fill with an image/poster and text. Clicking the area directs the User to a given Url. |
|
|
This component allows you to configure a large carousel, typically displayed a the top of a Page. The carousel can contain multiple slides, which allow you to display large posters or videos, and configure calls to action. |
|
|
This component allows you to configure an overview of all the child-Categories for a given Category. Clicking a Category directs the User to an automatically generated Category detail Page. |
|
|
This component allows you to configure a default carousel which displays all the Articles for a given Category. |
|
|
This component allows you to configure a block of custom HTML and/or JavaScript. |
|
|
This component is the placeholder under which you can configure the pairing code input field, and overview of already paired devices. |
|
|
This component allows you to configure the main filter section, under which multiple filter categories can be placed. Typically one filter section is sufficient. |
|
|
This component displays a generic support form, which a User can fill out. The contents of the form are sent to your support e-mail address which you have configured in the MailService. |
|
|
This component displays and overview of all fulfilled gamification actions, i.e. their "achievements". |
|
|
This component allows you to configure an overview of all the child-Pages for given Page (of type "blog"). It is typically used to show all available blogs. |
|
|
This component allows you to configure the main profile section that is displayed on the WEB/MOBILE profile page. There can be only component of this type on the Page. |
|
|
This component allows you to configure a call-to-action which leads to a random sub-page, given a provided parent Page. The typicall use-case is to offer the User a random Blog page ("pick a card"). |
|
|
This component allows you to configure a relative or absolute Url, to which the User must be redirected. |
|
|
This component allows you to configure a randomly selected Page, to which the User must be redirected. |
|
|
This component allows you to configure a pre-styled wide component well suited to display a short tag-line or quote. |
|
|
This component allows you to configure the main account detail section that is displayed on the WEB/MOBILE payment-account page. There can be only component of this type on the Page. |
|
|
This component allows you to configure a pricing overview with one or more Subscription banners. When placed on a Page of type "pricing", it defines the default Subscriptions that are automatically offered in the purchase flow. When placed on a Page of type "text", it allows you to create specific landing pages that offer given Subscriptions. |
|
|
This component is a basic multi-purpose component that allows you to place content on a Page using a WYSIWYG-editor. |
|
|
This component allows you to display multiple text/content blocks in a carousel, e.g. a set of short news messages or testimonials. |
|
|
This component allows you to display a few (typically 1-3) small text/content blocks side-by-side, e.g. a set of unique selling points (USPs). |
Example
"account_create"
PageFileInput
Description
A page file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
page_id - Int
|
The file parent page id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"page_id": 42
}
PageListedAsResource
Description
A listed page resource
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the resource |
name - String
|
The name of resource |
visibility - ResourceVisibilityEnum
|
Visibility of the resource |
Example
{
"id": 42,
"name": "string",
"visibility": "everyone"
}
PageMetaInput
Description
A page metadata input property
Fields
| Input Field | 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 - MetaFormatEnum
|
The metadata property rendering format |
locale - String
|
The metadata property locale |
page_id - Int
|
The metadata property parent page id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "date",
"locale": "string",
"page_id": 42
}
PageMetaTranslation
Description
A page metadata translation
Example
{
"id": 42,
"value": "string",
"locale": "string",
"page_meta_id": 42
}
PageTypeEnum
Description
The page type
Values
| Enum Value | Description |
|---|---|
|
|
A WEB/MOBILE page with this type is used to offer the User the option to delete their User account. |
|
|
A MOBILE page with this type provides the User with an overview of all the Articles that have been downloaded within the native mobile app. |
|
|
A WEB/MOBILE page with this type can have multiple sub-pages, each sub-page then represents a single blog. |
|
|
This type is reserved for legacy TV apps only, and is deprecated. |
|
|
A WEB/MOBILE page with this type is used to allow the User to enter a pairing code and thus link a device. |
|
|
A WEB/MOBILE page with this type may contain multiple filter categories and allows for a filtered search experience. |
|
|
A page with this type is used as the default landing/opening page. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows you to display a pairing code, so that a User may link their device to their User account. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type shows the User an overview of their main User account with active subscriptions, purchase overview, voucher redemption and more. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type is used by the purchase flow to offer subscriptions to Users. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows a User to see their general profile information such as name and e-mail address, as well as information specific to the TV app such as "version", which is often helpful for customer support queries. There can be only one page with this type per platform context. |
|
|
The single WEB/MOBILE page with this type allows the User to edit their user profile information such as name and e-mail address, reset their password or change their e-mail address. |
|
|
A WEB/MOBILE page with this type allows you to configure a redirect to another page or, an external URL. When this page is opened by a User, they are automatically redirected to the configured target. |
|
|
The single WEB/MOBILE page with this type allows a User to fill out the registration form and create a User account. There can be only one page with this type per platform context. |
|
|
The single TV page with this type allows the User to search and filter on specific Articles. There can be only one page with this type per platform context. |
|
|
This is the most generic page type, intended for most content purposes. |
|
|
The single TV page with this type is displayed to Users when first opening the TV app. There can be only one page with this type per platform context. |
Example
"account_delete"
Pagination
PaymentProviderConnectFlowStatusEnum
Description
The payment provider connect flow status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"test_key"
PaymentProviderCurrencyEnum
Description
The currency used for payment with the payment provider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREDIT"
PaymentProviderListedAsRelation
PaymentProviderRemoteProfileStatusEnum
Description
The payment provider remote account profile status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"not_applicable"
PaymentProviderStatusEnum
Description
The payment provider status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"active"
PaymentSyndicateTypeEnum
Description
The subscription type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"internal"
PaymentSyndicateVoucherDiscountTypeEnum
Description
The payment syndicate voucher discount type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"percentage"
PaymentSyndicateVoucherInstallmentTypeEnum
Description
The payment syndicate voucher installment type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"fixed_date"
PaymentSyndicateVoucherTypeEnum
Description
The payment syndicate voucher type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"generic"
PaymentSyndicateVoucherUserSubscriptionStatusActionEnum
Description
The default UserSubscription status the voucher implements when successfully claimed
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"none"
PlatformContextEnum
Description
The platform context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"web"
Product
Description
A product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [ArticleListedAsRelation]
|
The related articles of the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
ProductDiscoverabilityEnum
Description
The product discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
ProductFileInput
Description
A product file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
product_id - Int
|
The file parent product id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"product_id": 42
}
ProductListedAsRelation
Description
A listed related product
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the product |
project_id - Int!
|
The project id of the product |
remote_product_id - String
|
The remote id of the product (e.g. used for in-app purchases) |
name - String
|
The name of the product |
title - String
|
The title of the product |
description - String
|
The description of the product |
Arguments
|
|
description_short - String
|
The product short description |
Arguments
|
|
call_to_action_tag - String
|
The call-to-action tag of the product |
type - ProductTypeEnum
|
The type of the product |
credit_type - UserPaymentCreditTypeEnum
|
The credit type of the product |
currency - String
|
The currency of the product |
currency_symbol - String
|
The currency symbol of the product |
price - Float
|
The price of the product |
credit_price - Float
|
The credit-price of the product |
credit_amount - Float
|
The number of credits |
amount_balance - Float
|
The quantity of amount-balance issued by the product |
purchase_num - Int
|
The item quantity of given product |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given product |
expires_in - Int
|
Expires-in interval in seconds for the product |
expires_at - String
|
Expires-at date (UTC) for the product |
created_at - String
|
The creation date (UTC) of the product |
updated_at - String
|
The last modification date (UTC) of the product |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
articles - [ArticleListedAsRelation]
|
The related articles of the product |
categories - [CategoryListedAsRelation]
|
List of categories this article belongs to |
Arguments
|
|
Example
{
"id": 42,
"project_id": 42,
"remote_product_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"call_to_action_tag": "string",
"type": "article",
"credit_type": "general",
"currency": "EUR",
"currency_symbol": "EUR",
"price": 7.99,
"credit_price": 1,
"credit_amount": 1,
"amount_balance": 987.65,
"purchase_num": 42,
"max_purchase_num": 1,
"expires_in": 86400,
"expires_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation]
}
ProductListedAsResource
ProductStackInput
ProductStatusEnum
Description
The product status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"unpublished"
ProductTypeEnum
Description
The product type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article"
ProjectConfigContextEnum
Description
The project config context
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"branding_web_custom_css"
ProjectConfigInput
ProjectConfigTypeEnum
Description
The project config type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"array"
RemoteAssetFileContextEnum
Description
The remote asset file context
Values
| Enum Value | Description |
|---|---|
|
|
Example
"bulk_upload"
ResourceAccessibilityEnum
Description
The resource accessibility type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"everyone"
ResourceTypeEnum
Description
The resource type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"article"
ResourceVisibilityEnum
Description
The resource visibility type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"everyone"
Role
Description
The role
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the role |
name - String
|
The name of the role |
type - RoleTypeEnum
|
The type of the role |
description - String
|
The description of the role |
Example
{
"id": 42,
"name": "string",
"type": "root",
"description": "string"
}
RoleTypeEnum
Description
The role types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"root"
SortByInput
Description
A sort-by input property
Fields
| Input Field | Description |
|---|---|
field - String
|
The sort order field |
direction - SortOrderEnum
|
The sort order direction |
Example
{"field": "string", "direction": "asc"}
SortOrderEnum
Description
The sort order type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"asc"
SortPivotActionEnum
Description
The sort pivot action type
Values
| Enum Value | Description |
|---|---|
|
|
Place resource at the position immediately before the resource with given "pivot_id". |
|
|
Place resource at the position immediately after the resource with given "pivot_id". |
Example
"before"
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"
StructureKeyValueIntegerPair
StructureKeyValueStringArrayPair
StructureKeyValueStringPair
Subscription
Description
A subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles that are part of the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [PaymentProviderListedAsRelation]
|
The related payment providers part of the given subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [PaymentProviderListedAsRelation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
SubscriptionDiscoverabilityEnum
Description
The subscription discoverability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hidden"
SubscriptionEntitlementScopeEnum
Description
The subscription entitlement scope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"partial_exclusive"
SubscriptionFileInput
Description
An subscription file input property
Fields
| Input Field | Description |
|---|---|
id - Int
|
The file id |
type - FileTypeEnum
|
The file type |
duration - Int
|
The (audio/video) file duration |
locale - String
|
The file language locale code |
subscription_id - Int
|
The file parent subscription id |
Example
{
"id": 42,
"type": "binary",
"duration": 42,
"locale": "string",
"subscription_id": 42
}
SubscriptionListed
Description
A listed subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the subscription |
project_id - Int!
|
The project id of the subscription |
remote_subscription_id - String
|
The remote id of the subscription (e.g. used for in-app purchases) |
name - String
|
The name of the subscription |
title - String
|
The title of the subscription |
description - String
|
The description of the subscription |
Arguments
|
|
description_short - String
|
The subscription short description |
Arguments
|
|
type - SubscriptionTypeEnum
|
The type of the subscription |
price - Float
|
The price of the subscription |
price_per_installment - Float
|
The subscription price per installment |
time_unit - SubscriptionTimeUnitEnum
|
The periodical time unit of the subscription |
time_unit_translation - String
|
The translation of the periodical time unit of the subscription |
frequency - Float
|
The subscription frequency per time unit |
currency - String
|
The currency of the subscription |
currency_symbol - String
|
The currency symbol of the subscription |
initial_installment_num - Int
|
The subscription initial number of installments |
initial_installment_time_unit - SubscriptionTimeUnitEnum
|
The subscription initial installment time unit |
allow_suspend_after_installment_num - Int
|
The subscription is allowed to be suspended after given number of installments |
max_concurrent_vod_stream_num - Int
|
The subscription maximum allowed concurrent vod streams |
newsletter_list_id - String
|
3rd party newsletter list id for the product |
entitlement_scope - SubscriptionEntitlementScopeEnum
|
The entitlement scope of the subscription |
is_credit_issuing - Boolean
|
Subscription periodically issues credits |
purchase_num - Int
|
The item quantity of given subscription |
max_purchase_num - Int
|
The maximum quantity that may be purchased for given subscription |
articles - [ArticleListedAsRelation]
|
The related articles that are part of the given entitlement scope of the subscription |
categories - [CategoryListedAsRelation]
|
The related categories that are part of the given entitlement scope of the subscription |
payment_providers - [PaymentProviderListedAsRelation]
|
The related payment providers part of the given subscription |
icons - [File]
|
List of icons |
images - [File]
|
List of images |
posters - [File]
|
List of images |
videos - [File]
|
List of videos |
created_at - String
|
The creation date (UTC) of the subscription |
updated_at - String
|
The last modification date (UTC) of the subscription |
is_pricing_highlighted - Boolean
|
The listed subscription is highlighted as "recommended" in pricing overviews |
is_pricing_display_recurring_price - Boolean
|
The recurring price of the subscription is automatically displayed in pricing overviews |
Example
{
"id": 42,
"project_id": 42,
"remote_subscription_id": "string",
"name": "string",
"title": "string",
"description": "string",
"description_short": "string",
"type": "svod",
"price": 7.99,
"price_per_installment": 7.99,
"time_unit": "day",
"time_unit_translation": "string",
"frequency": 1,
"currency": "EUR",
"currency_symbol": "EUR",
"initial_installment_num": 42,
"initial_installment_time_unit": "day",
"allow_suspend_after_installment_num": 42,
"max_concurrent_vod_stream_num": 42,
"newsletter_list_id": "string",
"entitlement_scope": "partial_exclusive",
"is_credit_issuing": true,
"purchase_num": 42,
"max_purchase_num": 1,
"articles": [ArticleListedAsRelation],
"categories": [CategoryListedAsRelation],
"payment_providers": [PaymentProviderListedAsRelation],
"icons": [File],
"images": [File],
"posters": [File],
"videos": [File],
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"is_pricing_highlighted": true,
"is_pricing_display_recurring_price": 7.99
}
SubscriptionListedAsResource
SubscriptionStatusEnum
Description
The subscription status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"inactive"
SubscriptionTimeUnitEnum
Description
The subscription time unit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"day"
SubscriptionTypeEnum
Description
The subscription type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"svod"
SubscriptionUserSubscriptionStatusActionEnum
Description
The default UserSubscription status the subscription implements when it is created
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"activate"
SystemLanguageTag
Description
System language tag
Fields
| Field Name | Description |
|---|---|
key - String
|
The name of language tag |
value - String
|
The value of language tag |
format - MetaFormatEnum
|
The value rendering format |
Example
{
"key": "string",
"value": "string",
"format": "date"
}
Translation
TranslationInput
User
Description
A user
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user |
project_id - Int
|
User project id |
name - String
|
The name of user |
display_name - String
|
The display name of user, typically the User's first name or first part of the e-mail address |
email - String
|
The email of user |
gender - UserGenderTypeEnum
|
The gender of user |
locale - String
|
The locale (language) of user |
subtitle_locale - String
|
The preferred subtitle locale (language) of user |
audio_locale - String
|
The preferred audio locale (language) of user |
status - UserStatusEnum
|
The user status |
address - String
|
The user address |
postal_code - String
|
The user postal code |
city - String
|
The user city |
country - String
|
The user country |
geo_region_code - String
|
The user geo-region code |
phone - String
|
The user phone |
is_phone_verified - UserPhoneStatusEnum
|
Phone verification status |
birthday - String
|
The user birthday |
height - Float
|
The user height |
weight - Float
|
The user weight |
custom_data - String
|
Custom data stored for the user |
is_newsletter_opt_in - Boolean
|
User newsletter opt-in status |
is_terms_and_conditions_opt_in - Boolean
|
Terms and conditions opt-in status |
is_marked_for_deletion - Boolean
|
Indicated if user account is marked for deletion |
delete_at - String
|
The date (UTC) at which the user account will be deleted |
notifiable - UserNotifiableTypeEnum
|
User notifiable status |
max_concurrent_vod_stream_num - Int
|
Maximum allowed number of concurrent VOD streams |
user_subscription_status - UserSubscriptionStatusEnum
|
The status of the current user subscription, if any |
user_subscription_last_event_type - UserSubscriptionEventTypeEnum
|
The last event type of importance generated for the current user subscription, if any |
subscription_id - Int
|
The id of the subscription on which the user-subscription was created |
favourite_articles - [ArticleRelated]
|
List of favourite articles of user |
nomadic_articles - [ArticleRelated]
|
List of nomadic articles of user |
history_articles - [ArticleRelated]
|
List of all completed articles of user |
entitled_articles - [ArticleRelated]
|
List of all entitled articles of user |
entitled_root_articles - [ArticleRelated]
|
List of all entitled root articles of user |
articles - [ArticleRelated]
|
List of all related articles of user |
Arguments
|
|
latest_nomadic_article - ArticleRelated
|
Latest active nomadic article |
consents - [UserConsent]
|
List of user consents |
metric_actions - [MetricAction]
|
List of fulfilled metric actions for user |
notification_profiles - [UserNotificationProfile]
|
List of user notification profiles |
notification_topics - [UserNotificationTopic]
|
List of user notification profiles |
user_subscriptions - [UserSubscription]
|
User subscriptions |
user_products - [UserProduct]
|
User subscriptions |
orders - [UserPaymentAccountOrder]
|
User orders |
Arguments
|
|
user_payment_credit_amount - Float
|
Amount of available credits for given user |
Arguments
|
|
user_payment_general_credit_amount - Float
|
Amount of available general credits for given user |
user_payment_free_article_credit_amount - Float
|
Amount of available free-article credits for given user |
user_payment_currency_amount - Float
|
Amount balance for given user |
user_payment_currency_symbol - String
|
Currency symbol for current amount balance for given user |
user_payment_currency - String
|
Currency for current amount balance for given user |
Example
{
"id": 42,
"project_id": 42,
"name": "string",
"display_name": "string",
"email": "foo@example.com",
"gender": "male",
"locale": "string",
"subtitle_locale": "string",
"audio_locale": "string",
"status": "string",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"geo_region_code": "nl",
"phone": "string",
"is_phone_verified": "unverified",
"birthday": "string",
"height": 123.45,
"weight": 987.65,
"custom_data": "string",
"is_newsletter_opt_in": true,
"is_terms_and_conditions_opt_in": true,
"is_marked_for_deletion": true,
"delete_at": "2000-12-31T12:34:56.000Z",
"notifiable": "none",
"max_concurrent_vod_stream_num": 42,
"user_subscription_status": "string",
"user_subscription_last_event_type": "first_payment_error",
"subscription_id": 42,
"favourite_articles": [ArticleRelated],
"nomadic_articles": [ArticleRelated],
"history_articles": [ArticleRelated],
"entitled_articles": [ArticleRelated],
"entitled_root_articles": [ArticleRelated],
"articles": [ArticleRelated],
"latest_nomadic_article": ArticleRelated,
"consents": [UserConsent],
"metric_actions": [MetricAction],
"notification_profiles": [UserNotificationProfile],
"notification_topics": [UserNotificationTopic],
"user_subscriptions": [UserSubscription],
"user_products": [UserProduct],
"orders": [UserPaymentAccountOrder],
"user_payment_credit_amount": 1,
"user_payment_general_credit_amount": 1,
"user_payment_free_article_credit_amount": 1,
"user_payment_currency_amount": "EUR",
"user_payment_currency_symbol": "EUR",
"user_payment_currency": "EUR"
}
UserArticleSession
Description
A user article view session
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user-article-session record |
user_id - Int
|
The user id of the user-article-session record |
anonymous_user_id - String
|
The anonymous user id of the user-article-session record, i.e. an unknown user without a user account |
article_id - Int
|
The article id of the user-article-session record |
asset_id - Int
|
The asset id of the user-article-session record |
linked_type - String
|
The article-asset linked type of the user-article-session record |
time_watched - Int
|
The amount of time watched of the user-article-session record (only applies to event-types related to actual play time) |
time_delta - Float
|
The elapsed time for the given user-article-session record |
resolution_tag - String
|
The displayed resolution of the user-article session record |
event_type - String
|
The event type of the user-article-session record (Play-time event types: "play", "playing", "stop") |
event_payload - String
|
The recorded payload/message of the user-article-session record |
is_progress_marker1_completed - Boolean
|
The fulfilment of custom progress marker 1 of the user-article-session record |
is_progress_marker2_completed - Boolean
|
The fulfilment of custom progress marker 2 of the user-article-session record |
is_progress_marker3_completed - Boolean
|
The fulfilment of custom progress marker 3 of the user-article-session record |
is_completed - Boolean
|
The fulfilment of the asset completion marker of the user-article-session record |
device_type - String
|
The detected device-type of the user-article-session record |
device_brand - String
|
The detected device brand of the user-article-session record |
device_model - String
|
The detected device model of the user-article-session record |
telemetry_platform - String
|
The detected telemetry-platform of the user-article-session record |
ip_address - String
|
The IP address of the user-article-session record |
user_agent - String
|
The user agent of the UserArticle record, which represents the browser/agent through which the User has last watched this Article-Assset |
geo_region_code - String
|
The geo-region code of the user-article-session record |
audio_locale - String
|
The audio language ISO 639-1 code of the user-article-session record |
subtitle_locale - String
|
The subtitle language ISO 639-1 code of the user-article-session record |
started_at - String
|
The article-asset linked type of the user-article-session record |
article_name - String
|
The article name of the user-article-session record |
Example
{
"id": 42,
"user_id": 42,
"anonymous_user_id": "string",
"article_id": 42,
"asset_id": 42,
"linked_type": "film",
"time_watched": 42,
"time_delta": 987.65,
"resolution_tag": "string",
"event_type": "string",
"event_payload": "string",
"is_progress_marker1_completed": false,
"is_progress_marker2_completed": false,
"is_progress_marker3_completed": false,
"is_completed": false,
"device_type": "string",
"device_brand": "string",
"device_model": "string",
"telemetry_platform": "string",
"ip_address": "string",
"user_agent": "string",
"geo_region_code": "nl",
"audio_locale": "string",
"subtitle_locale": "string",
"started_at": "2000-12-31T12:34:56.000Z",
"article_name": "string"
}
UserConsent
Description
A user consent property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The user consent property id |
user_id - Int
|
The user consent property user id |
value - Boolean
|
The user consent property value |
type - UserConsentTypeEnum
|
The enum value of the user consent |
created_at - String
|
The creation date (UTC) of the user consent |
updated_at - String
|
The last modification date (UTC) of the user consent |
Example
{
"id": 42,
"user_id": 42,
"value": true,
"type": "cookie_analytics",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserConsentInput
Description
A user consent input property
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
The boolean value of the user consent |
type - UserConsentTypeEnum
|
The enum value of the user consent |
Example
{"value": true, "type": "cookie_analytics"}
UserConsentTypeEnum
Description
The user consent types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"cookie_analytics"
UserGenderTypeEnum
Description
The user gender types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"male"
UserMetaInput
Description
A user metadata input property
Fields
| Input Field | 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 - MetaFormatEnum
|
The metadata property rendering format |
locale - String
|
The metadata property locale |
user_id - Int
|
The metadata property parent user id |
Example
{
"id": 42,
"key": "string",
"value": "string",
"type": "array",
"format": "date",
"locale": "string",
"user_id": 42
}
UserMetaTranslation
Description
A user metadata translation
Example
{
"id": 42,
"user_meta_id": 42,
"value": "string",
"locale": "string"
}
UserNotifiableTypeEnum
Description
The user notifiable types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"none"
UserNotificationProfile
Description
A user notification profile property
Fields
| Field Name | Description |
|---|---|
id - Int
|
The user notification profile property id |
user_id - Int
|
The user notification profile property user id |
notification_token - String
|
The notification token |
device_tag - String
|
The device tag |
created_at - String
|
The creation date (UTC) of the user notification profile |
updated_at - String
|
The last modification date (UTC) of the user notification profile |
Example
{
"id": 42,
"user_id": 42,
"notification_token": "string",
"device_tag": "string",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserNotificationProfileInput
UserNotificationTopic
Description
A user notification topic property
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the notification topic |
remote_notification_topic_id - String
|
The remote id of the notification topic (e.g. used for in-app push notifications) |
project_id - Int!
|
The project id of the notification topic |
name - String
|
The name of the notification topic |
title - String
|
The title of the notification topic |
description - String
|
The content of the notification topic |
is_subscribed - Boolean
|
The user notification topic subscription status |
notify_at - String
|
The preferred time (UTC) to be notified |
notified_at - String
|
The last time (UTC) the user was notified on this topic |
created_at - String
|
The creation date (UTC) of the notification topic user subscription |
updated_at - String
|
The last modification date (UTC) of the notification topic user subscription |
Example
{
"id": 42,
"remote_notification_topic_id": "string",
"project_id": 42,
"name": "string",
"title": "string",
"description": "string",
"is_subscribed": false,
"notify_at": "2000-12-31T12:34:56.000Z",
"notified_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z"
}
UserNotificationTopicInput
Description
A user notification topic input property
Example
{
"id": 42,
"notify_at": "string",
"is_subscribed": false
}
UserPaymentAccount
Description
A user payment account
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the account |
payment_provider_id - Int
|
The id of the payment provider |
amount_balance - Float
|
The amount balance of the account |
method - String
|
The payment method of the account |
method_details - String
|
The payment method details of the account |
geo_region_code - String
|
The geo region (i.e. country) from which the account creation originated |
orders - [UserPaymentAccountOrder]
|
The account orders |
Example
{
"id": 42,
"payment_provider_id": 42,
"amount_balance": 123.45,
"method": "string",
"method_details": "string",
"geo_region_code": "nl",
"orders": [UserPaymentAccountOrder]
}
UserPaymentAccountOrder
Description
A user payment account order
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the order |
user_id - Int
|
The user id of the order |
user_subscription_id - String
|
The user subscription id of the order |
payment_syndicate_voucher_id - Int
|
The payment syndicate voucher id attached to the order |
voucher_code - String
|
The voucher code attached to the order |
type - String
|
The type of the order |
recurring_type - String
|
The recurring type of the order |
discount_type - String
|
The discount type of the order |
payment_provider_type - String
|
The payment provider type of the order |
amount - Float
|
The amount of the order |
status - String
|
The status of the order |
status_name - String
|
The status name of the order |
description - String
|
The description of the order |
installed_at - String
|
The installation date (UTC) of the order |
paid_at - String
|
The payment fulfilment date (UTC) of the order |
cancelled_at - String
|
The cancellation date (UTC) of the order |
refunded_at - String
|
The refunded/charge-back date (UTC) of the order |
created_at - String
|
The creation date (UTC) of the order |
updated_at - String
|
The last modification date (UTC) of the order |
installments - [Int]
|
The order installments |
currency - String
|
The currency of the order |
currency_symbol - String
|
The currency symbol of the order |
products - [ProductListedAsRelation]
|
The related products of the order |
Example
{
"id": 42,
"user_id": 42,
"user_subscription_id": "string",
"payment_syndicate_voucher_id": 42,
"voucher_code": "string",
"type": "string",
"recurring_type": "string",
"discount_type": "string",
"payment_provider_type": "string",
"amount": 987.65,
"status": "string",
"status_name": "string",
"description": "string",
"installed_at": "2000-12-31T12:34:56.000Z",
"paid_at": "2000-12-31T12:34:56.000Z",
"cancelled_at": "2000-12-31T12:34:56.000Z",
"refunded_at": "2000-12-31T12:34:56.000Z",
"created_at": "2000-12-31T12:34:56.000Z",
"updated_at": "2000-12-31T12:34:56.000Z",
"installments": [42],
"currency": "EUR",
"currency_symbol": "EUR",
"products": [ProductListedAsRelation]
}
UserPaymentAccountOrderPurchaseOriginEnum
Description
The user payment account order purchase origin type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"currency"
UserPaymentAccountOrderStatusEnum
Description
The user payment account order status type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"open"
UserPaymentAccountOrderTypeEnum
Description
The user payment account order type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"svod"
UserPaymentCreditTypeEnum
Description
The credit type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"general"
UserPhoneStatusEnum
Description
The user phone status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"unverified"
UserProduct
Description
A user product
Fields
| Field Name | Description |
|---|---|
id - Int
|
The id of the user product |
product_id - Int
|
The id of the product |
user_id - Int
|
The id of the product |
user_payment_account_order_id - Int
|
The id of the order |
is_fulfilled - Boolean
|
Fulfilment status |
fulfilment_expires_at - String
|
The last expiry date (UTC) of the fulfilment |
order - UserPaymentAccountOrder
|
The user payment account order |
product - Product
|
The parent product |
account - UserPaymentAccount
|
The user payment account |
Example
{
"id": 42,
"product_id": 42,
"user_id": 42,
"user_payment_account_order_id": 42,
"is_fulfilled": true,
"fulfilment_expires_at": "2000-12-31T12:34:56.000Z",
"order": UserPaymentAccountOrder,
"product": Product,
"account": UserPaymentAccount
}
UserStatusEnum
Description
The user status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"disabled"
UserSubscription
Description
A user subscription
Fields
| Field Name | Description |
|---|---|
id - Int!
|
The id of the user subscription |
user_id - Int!
|
The id of the user |
project_id - Int!
|
The project id of the user subscription |
subscription_id - Int!
|
The subscription id of the user subscription |
switch_from_subscription_id - Int
|
The subscription id of the old subscription the user was switched from |
switch_to_subscription_id - Int
|
The subscription id of the new subscription to switch to at next renewal |
term - Int
|
The current term of the user subscription |
acquired_at - String
|
The acquisition date (UTC) of the user subscription |
expires_at - String
|
The expiry date (UTC) of the user subscription |
suspendable_at - String
|
The suspendability date (UTC) of the user subscription |
suspended_at - String
|
The suspension date of (UTC) of the user subscription |
invoiced_at - String
|
The next invoice date (UTC) of the user subscription |
status - UserSubscriptionStatusEnum
|
The status of the user subscription |
status_name - String
|
The status description of the user subscription |
is_valid - Boolean
|
The validity of the user subscription |
is_expired - Boolean
|
The expiry status of the user subscription |
is_suspendable - Boolean
|
The suspendability of the user subscription |
is_account_method_changeable - Boolean
|
The changeability of payment account method of the user subscription |
is_switchable - Boolean
|
The possibility of the user subscription to be switched |
orders - [UserPaymentAccountOrder]
|
The user payment account orders |
Arguments
|
|
subscription - Subscription
|
The parent subscription |
account - UserPaymentAccount
|
The user payment account |
Example
{
"id": 42,
"user_id": 42,
"project_id": 42,
"subscription_id": 42,
"switch_from_subscription_id": 42,
"switch_to_subscription_id": 42,
"term": 42,
"acquired_at": "2000-12-31T12:34:56.000Z",
"expires_at": "2000-12-31T12:34:56.000Z",
"suspendable_at": "2000-12-31T12:34:56.000Z",
"suspended_at": "2000-12-31T12:34:56.000Z",
"invoiced_at": "2000-12-31T12:34:56.000Z",
"status": "string",
"status_name": "string",
"is_valid": false,
"is_expired": false,
"is_suspendable": false,
"is_account_method_changeable": true,
"is_switchable": false,
"orders": [UserPaymentAccountOrder],
"subscription": Subscription,
"account": UserPaymentAccount
}
UserSubscriptionEventTypeEnum
Description
The user subscription event type
Values
| Enum Value | Description |
|---|---|
|
|
An error occurred when trying to create the first payment to activate the user subscription. |
|
|
A charge-back occurred, impacting the validity of the user subscription. |
|
|
A refund occurred, impacting the validity of the user subscription. |
|
|
A previously fulfilled payment has become unfulfilled. |
|
|
An error occurred when attempting the last renewal, impacting the continued validity of the user subscription. |
|
|
An error occurred when attempting the last renewal, a renewal mandate was expected but not found. |
|
|
A renewal payment order has been generated, but it has not yet been fufilled. |
|
|
When attempting renewal, given voucher code could not be processed. |
Example
"first_payment_error"
UserSubscriptionStatusEnum
Description
The user subscription status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"initialised"