Get Started
Studio API
Content Delivery API
Deep dive
curl --request GET \
--url https://api.mottostreaming.com/ott/pages/v1 \
--header 'Authorization: Bearer <token>'{
"pages": [
{
"id": "<string>",
"project_id": "<string>",
"page_type": "PAGE_TYPE_UNSPECIFIED",
"name": "<string>",
"title": {},
"description": {},
"parameters": [
"<string>"
],
"page_component_ids": [
"<string>"
],
"css": "<string>",
"platform_id": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"metadata_tags": {},
"overrides": {},
"page_components": [
{
"project_id": "<string>",
"id": "<string>",
"name": "<string>",
"type": "<string>",
"data": {},
"props": {},
"environments": [
"<string>"
],
"visibility": "VISIBILITY_UNSPECIFIED",
"group_id": "<string>",
"css_classes": [
"<string>"
]
}
],
"is_preview": true,
"source_page_id": "<string>"
}
],
"next_page_token": "<string>"
}List pages
ListPages
Returns list of pages based on specified parameters.
curl --request GET \
--url https://api.mottostreaming.com/ott/pages/v1 \
--header 'Authorization: Bearer <token>'{
"pages": [
{
"id": "<string>",
"project_id": "<string>",
"page_type": "PAGE_TYPE_UNSPECIFIED",
"name": "<string>",
"title": {},
"description": {},
"parameters": [
"<string>"
],
"page_component_ids": [
"<string>"
],
"css": "<string>",
"platform_id": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"metadata_tags": {},
"overrides": {},
"page_components": [
{
"project_id": "<string>",
"id": "<string>",
"name": "<string>",
"type": "<string>",
"data": {},
"props": {},
"environments": [
"<string>"
],
"visibility": "VISIBILITY_UNSPECIFIED",
"group_id": "<string>",
"css_classes": [
"<string>"
]
}
],
"is_preview": true,
"source_page_id": "<string>"
}
],
"next_page_token": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of records to return
Filter the result-set by properties using a subset of the Kibana Query Language.
This currently supports queries based on platform_id, e.g. platform_id:Zidfx48am194
The pagination token in the List request.
Response
OK
Show child attributes
Show child attributes
User generated identifier for the page. It is unique in the context of a single page_type. This id is used to construct the non-slug version URL of this page. If this is a page that represents a single content type in the CMS (event/creative_work/entity), then this id should be the same as the type_id of that content type (e.g. "team")
PAGE_TYPE_UNSPECIFIED, PAGE_TYPE_DEFAULT, PAGE_TYPE_HOME, PAGE_TYPE_EVENT, PAGE_TYPE_CREATIVE_WORK, PAGE_TYPE_ENTITY The name of this page entry. Not shown to end users.
A map of localized titles for this page, for end users to see. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc.
If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.
For PAGE_TYPE_EVENT, PAGE_TYPE_CREATIVE_WORK, and PAGE_TYPE_ENTITY, you can include reference properties of the
resource you are loading dynamically, e.g. {event.title}, {creative_work.description} or {entity.name}.
Important: this is also used in the page's HTML
Note: this overwrites the platform-level title configuration.
Show child attributes
Show child attributes
The list of parameters that a page instance should collect in order to work. For example ["competition_id"].
The order of this list is important, as it will be used to parse the URL of a page.
For example, if the page_type is PAGE_TYPE_ENTITY, the id is "competition", and the parameter list is ["id", "year"],
then this page will listen to e.g. https://example.com/en-US/entity/competition/HiKTtRZYdyGU/2024.
Important: the page will also listen to URLs that do not contain all the parameters. In that case, it will not render
any component that is dependent on this parameter.
A list of page component IDs that together define the structure of the page. The order of this list determines the order in which the components are displayed towards end users.
Web only. CSS rules that should be included in the page. Can be used to override default page/component styling.
The platform ID that this page is associated with.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN A map of metadata tags that should be included in the page. These tags can be used for search-engine optimization. Note that some default tags will already be set based on other fields on this object, like title and description.
Show child attributes
Show child attributes
A map of overrides for the page. This is useful for scenarios where some subset of Page instantiations should have different properties. The key is a filter, which can target any URL parameter or event/entity property. It supports AND and OR clauses, but not both at the same time. It does not support negation, or nesting. The value is a PageOverride, that will be applied to the page when the filter matches. For example:
- if the regular page is for a "team" entity, but you want a special page for FC Barcelona, the key would
be
team.id:fc_barca_123(or whatever the ID of the FC Barcelona entity is). - if the regular page is for a "player" entity, but you want a special page for all players in the the national team,
the key would be
player.fields.team.id:national_team_123(or whatever the ID of the national team entity is), provided the player entity has ateamfield that references the team entity. - If the regular page is a "default" page like the "Search results" page, but you want a special page for the "FC Barcelona"
search query, then you can use the key
q:FC Barcelona(if "q" is your URL parameter name).
Note that a hit on a page override will entirely replace the page components and other properties; it will not merge with the base page.
Show child attributes
Show child attributes
PageOverride is a subset of the Page message. It can be used to modify default behavior of a page.
Show child attributes
Show child attributes
The name of this page entry. Not shown to end users.
A map of localized titles for this page, for end users to see. The key is the language code (ISO 639 - set 1), e.g. "en", "de", "fr", etc.
If you want to localize the text for different regions of the same language, you can add the country code (ISO 3166-1 alpha-2), e.g. "en-US", "en-GB", etc.
For PAGE_TYPE_EVENT, PAGE_TYPE_CREATIVE_WORK, and PAGE_TYPE_ENTITY, you can include reference properties of the
resource you are loading dynamically, e.g. {event.title}, {creative_work.description} or {entity.name}.
Important: this is also used in the page's HTML
Note: this overwrites the platform-level title configuration.
Show child attributes
Show child attributes
A list of page component IDs that together define the structure of the page. The order of this list determines the order in which the components are displayed towards end users.
Web only. CSS rules that should be included in the page. Can be used to override default page/component styling.
A map of metadata tags that should be included in the page. These tags can be used for search-engine optimization. Note that some default tags will already be set based on other fields on this object, like title and description.
Show child attributes
Show child attributes
A list of page components that together define the structure of the page.
The order of this list determines the order in which the components are displayed towards end users.
This field can be set during creation for convenience, but for updating, use page_component_ids after creating individual components first.
Show child attributes
Show child attributes
The type of component that should be rendered. Refer to the documentation to find the available types.
Data needed by individual components. Each component can have its own data structure. Refer to the documentation for the specific component to see what data is needed.
Additional properties that can be used to customize the rendering of this component. This can be used in two ways:
- If you are using the Motto OTT platform, you can find the available keys and values in our OTT documentation.
- If you are rendering the component yourself, you can use this map to pass arbitrary data to your rendering engine.
The environments in which this component should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv" If left empty, the component will be rendered in all environments (when possible).
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN An arbitrary string that can be used to group components together. This is useful to render a group of components in a shared container so that they can be styled/positioned together. Any component that shares a group_id with another component must immediately precede or follow it. If a group_id is not provided, the component's own id will be used as the group_id.
Web only. A list of CSS classes that should be added to the component's container element. This can be used to apply custom styling to the component.
A list of page components that together define the structure of the page.
The order of this list determines the order in which the components are displayed towards end users.
This field can be set during creation for convenience, but for updating, use page_component_ids after creating individual components first.
This field is not populated on List responses.
Show child attributes
Show child attributes
The type of component that should be rendered. Refer to the documentation to find the available types.
Data needed by individual components. Each component can have its own data structure. Refer to the documentation for the specific component to see what data is needed.
Additional properties that can be used to customize the rendering of this component. This can be used in two ways:
- If you are using the Motto OTT platform, you can find the available keys and values in our OTT documentation.
- If you are rendering the component yourself, you can use this map to pass arbitrary data to your rendering engine.
The environments in which this component should be rendered. The available options are: "web", "ios", "android", "tvos", "lg", "samsung", "androidtv" If left empty, the component will be rendered in all environments (when possible).
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN An arbitrary string that can be used to group components together. This is useful to render a group of components in a shared container so that they can be styled/positioned together. Any component that shares a group_id with another component must immediately precede or follow it. If a group_id is not provided, the component's own id will be used as the group_id.
Web only. A list of CSS classes that should be added to the component's container element. This can be used to apply custom styling to the component.
Indicates that this page is a preview page. Preview pages are not shown to end users, but can be used for testing and previewing changes. When you wish to deploy a preview page to production (your main platform for end users), you should set this field to false. When setting this field to false while it is true, any potential "source_page_id" will be deleted, as it is being replaced by this page. Any "dangling" page components that are only used by this page will also be deleted.
The page ID of the production page that this preview page is based on. This field is only relevant when "is_preview" is true. It will be set automatically when using the "ClonePage" API method.
The pagination token that should be used to get next page results. An empty value means no more results