List platforms

GET

ott

platforms

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>"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size

integer

Maximum number of records to return

project_id

string

filter

string

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:*

page_token

string

The pagination token in the List request.

Response

200

application/json

platforms

object[]

Platform is a configuration object that defines the structure of a Motto OTT platform instance.

platforms.id

string

required

System generated identifier for the platform.

platforms.project_id

string

required

platforms.name

string

The name of this platform. Not shown to end users.

platforms.hosts

string[]

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.

platforms.locales

string[]

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.

platforms.default_locale

string

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.

platforms.title

object

A map of localized titles for this platform, for end users to see. The key is the locale. Important: this is also used in the page's HTML <metadata> and <title> tags. Can be overwritten by individual pages.

platforms.logo_asset_id

string

The logo asset ID that should be used as the logo for this platform.

platforms.favicon_asset_id

string

The favicon asset ID that should be used as the favicon for this platform.

platforms.colors

object

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 and button_to: The gradient colors for buttons.

The values should be hex color codes, e.g. #FFFFFF.

A set of navigation bar entries that should be shown on the platform.

platforms.footer_entries

object[]

A set of footer entries that should be shown on the platform.

platforms.feature_configuration

object

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.

platforms.scripts

string

Web only. Scripts that should be included in the pages of the platform. Primarily useful for such things as Google Analytics scripts.

platforms.css

string

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.

next_page_token

string

The pagination token that should be used to get next page results. An empty value means no more results

Get platform Create platform

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>"
    }
  ],
  "next_page_token": "<string>"
}

Get Started

Studio API

Content Delivery API

Deep dive

List platforms

Authorizations

Query Parameters

Response