Get Started
Studio API
- Introduction
- Streaming
- CMS
- OTT
- Platforms
- GETGet platform
- GETList platforms
- POSTCreate platform
- PATCHUpdate platform
- DELDelete platform
- Pages
- Page Components
- Slugs
- Files
- GET
- Banners
- Monetization
- IAM
- Integration
- Analytics
Content Delivery API
Deep dive
Get platform
GetPlatform
Returns platform information by platform ID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
Platform is a configuration object that defines the structure of a Motto OTT platform instance.
System generated identifier for the platform.
A set of colors that should be used in the platform. The available keys are currently:
primary
: The primary color of the platform (in light mode). This is used to highlight important elements.primary_dark
: The primary color of the platform (in dark mode). This is used to highlight important elements.background
: The background color of the platform (in light mode).background_dark
: The background color of the platform (in dark mode).button_from
andbutton_to
: The gradient colors for buttons.
The values should be hex color codes, e.g. #FFFFFF
.
Web only. Global CSS rules that should be included in all pages of the platform. This is useful in two scenarios:
- Affecting default styling across all pages of the platform
- Affecting page-specific styling for static pages that do not have a Page object to represent them (e.g. a sign in/up page). In all other scenarios, it is recommended to apply CSS rules to the Page object itself.
The default locale for this platform. This is used to determine the default language for the platform.
Note: The platform itself may not support all languages. It will reject the default_locale if it references an unsupported language.
The favicon asset ID that should be used as the favicon for this platform.
The features that should be enabled on this platform. Any feature not included in this list will be disabled by default (unless it is a required, non-configurable feature).
The keys in this map represent features that should be enabled, and the values represent the configuration for that feature. For a full overview of the available features and their configuration options, please refer to the Motto documentation.
The hosts that this platform should be served on. Should follow the format of example.com
or ott.example.com
.
Should not include https://
, www.
or any path components.
This should be left empty if the page is not specific to any specific host, but should cover all hosts that may
serve the OTT platform.
The locales you would like to support on this platform. The format should be the language code, e.g. "en", "de", "fr", etc, optionally followed by a region code, e.g. "en-US", "en-GB", etc.
Note: The platform itself may not support all locales. When it does not, it will default to default_locale
.
The logo asset ID that should be used as the logo for this platform.
The name of this platform. Not shown to end users.
Web only. Scripts that should be included in the pages of the platform. Primarily useful for such things as Google Analytics scripts.