Get Started
Studio API
Content Delivery API
Deep dive
curl --request GET \
--url https://api.mottostreaming.com/ott/platforms/v1 \
--header 'Authorization: Bearer <token>'{
"platforms": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"hosts": [
"<string>"
],
"locales": [
"<string>"
],
"default_locale": "<string>",
"title": {},
"logo_asset_id": "<string>",
"favicon_asset_id": "<string>",
"colors": {},
"navbar_entries": [
{
"title": {},
"url": "<string>"
}
],
"footer_entries": [
{
"title": {},
"url": "<string>"
}
],
"feature_configuration": {},
"scripts": "<string>",
"css": "<string>",
"integrations": {},
"colors_preview": {},
"feature_configuration_preview": {},
"scripts_preview": "<string>",
"css_preview": "<string>",
"integrations_preview": {},
"navbar_entries_preview": [
{
"title": {},
"url": "<string>"
}
],
"footer_entries_preview": [
{
"title": {},
"url": "<string>"
}
],
"breakpoints": {}
}
],
"next_page_token": "<string>"
}List platforms
ListPlatforms
Returns list of platforms based on specified parameters.
curl --request GET \
--url https://api.mottostreaming.com/ott/platforms/v1 \
--header 'Authorization: Bearer <token>'{
"platforms": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"hosts": [
"<string>"
],
"locales": [
"<string>"
],
"default_locale": "<string>",
"title": {},
"logo_asset_id": "<string>",
"favicon_asset_id": "<string>",
"colors": {},
"navbar_entries": [
{
"title": {},
"url": "<string>"
}
],
"footer_entries": [
{
"title": {},
"url": "<string>"
}
],
"feature_configuration": {},
"scripts": "<string>",
"css": "<string>",
"integrations": {},
"colors_preview": {},
"feature_configuration_preview": {},
"scripts_preview": "<string>",
"css_preview": "<string>",
"integrations_preview": {},
"navbar_entries_preview": [
{
"title": {},
"url": "<string>"
}
],
"footer_entries_preview": [
{
"title": {},
"url": "<string>"
}
],
"breakpoints": {}
}
],
"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 host, e.g. host:example.com
To filter on platforms that are configured across all hosts, use host:*
The pagination token in the List request.
Response
OK
Show child attributes
Show child attributes
System generated identifier for the platform.
The name of this platform. Not shown to end users.
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 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 logo asset ID that should be used as the logo for this platform.
The favicon asset ID that should be used as the favicon for this 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_fromandbutton_to: The gradient colors for buttons.
The values should be hex color codes, e.g. #FFFFFF.
Show child attributes
Show child attributes
A set of navigation bar entries that should be shown on the platform.
A set of footer entries that should be shown on the 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.
Web only. Scripts that should be included in the pages of the platform. Primarily useful for such things as Google Analytics scripts.
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 third-party integrations that should be configured on this platform.
The keys in this map represent third-parties that should be configured, and the values represent the necessary API keys, tokens, etc. For a full overview of the available integrations and their configuration options, please refer to the Motto documentation.
The same as feature_configuration, but for the preview environment. If not provided, the preview environment will use feature_configuration.
The same as scripts, but for the preview environment. If not provided, the preview environment will use scripts.
The same as css, but for the preview environment. If not provided, the preview environment will use css.
The same as integrations, but for the preview environment. If not provided, the preview environment will use integrations.
The same as navbar_entries, but for the preview environment. If not provided, the preview environment will use navbar_entries.
The same as footer_entries, but for the preview environment. If not provided, the preview environment will use footer_entries.
A map of breakpoints that should be supported on this platform. This is used within the Studio environment to determine which kinds of assets must be provided, e.g. for banners. The key is the breakpoint min-width (in pixels), and the value is a human-readable name for the breakpoint. If you want to define a default breakpoint for all screen sizes, you can use 0 as the key. E.g.: { 0: "Mobile", 1024: "Desktop" }
Show child attributes
Show child attributes
The pagination token that should be used to get next page results. An empty value means no more results