Get Started
Studio API
- Introduction
- Streaming
- CMS
- OTT
- Platforms
- Banners
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Get page
GetPage
Returns page information by page ID.
curl --request GET \
--url https://api.mottostreaming.com/ott/pages/v1/{page_id} \
--header 'Authorization: Bearer <token>'{
"page": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"title": {},
"description": {},
"page_type": "PAGE_TYPE_UNSPECIFIED",
"parameters": [
"<string>"
],
"page_component_ids": [
"<string>"
],
"css": "<string>",
"platform_id": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"metadata_tags": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
PAGE_TYPE_UNSPECIFIED, PAGE_TYPE_DEFAULT, PAGE_TYPE_HOME, PAGE_TYPE_EVENT, PAGE_TYPE_CREATIVE_WORK, PAGE_TYPE_ENTITY Response
Page is a configuration object that defines the structure of a page, of which there can be arbitrarily many instances.
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 <metadata> and <title> tags.
If this map is left empty, a best effort title will be generated (e.g. based on page_type + parameter data).
Note: this overwrites the platform-level title configuration.
A map of localized descriptions for this page. This description will be included in the page metadata and can be important for search-engine optimization.
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 curl --request GET \
--url https://api.mottostreaming.com/ott/pages/v1/{page_id} \
--header 'Authorization: Bearer <token>'{
"page": {
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"title": {},
"description": {},
"page_type": "PAGE_TYPE_UNSPECIFIED",
"parameters": [
"<string>"
],
"page_component_ids": [
"<string>"
],
"css": "<string>",
"platform_id": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"metadata_tags": {}
}
}