Playout API
/
Episode companies involved
/
List retailer/e-commerce platforms (merchants) involved.

Media Jay Playout API (2025-08-04)

The playout API of the Media Jay application provides access to the playout data and orchestrates extended queries.

Authentication

To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia support@transfermedia.de to retrieve one.

Versioning

To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-08-04 is used. The response header X-API-Version returns the implementation version the request was processed with.

Further documentation

For further details please visit the documentation or contact Transfermedia support@transfermedia.de.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Development Server

https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/

Session Tracking

APIs for managing user tracking sessions. These endpoints allow clients to create, retrieve, and delete tracking sessions which are used for analytics and user behavior tracking.

Operations

Formats

Access to formats metadata (aka movie collections or series).

Operations

Episodes

Access to episode metadata and general information.

Operations

Episode items

Information about episode items.

Operations

Episode timeline

Information about timeline events with complete timing information.

Operations

Episode groups

Information about existing groups.

Operations

Episode scenes

Information about the scenes.

Operations

Episode companies involved

Information about the involved companies.

Operations

Get detailed information about the streaming platform provider

Request

Retrieves comprehensive information about the streaming platform (affiliate) serving this content.

This includes branding assets, website URLs, and other metadata needed to properly attribute and integrate with the streaming service in client applications.

This endpoint provides client applications with the necessary branding assets, URLs, and metadata about the streaming platform to properly attribute content and maintain consistent branding in the user interface.

The affiliate information includes:

  • Platform name and branding assets (logos, colors)
  • Website URLs for the main site, terms of service, and privacy policy
  • Contact information for support or partnership inquiries
  • Other platform-specific metadata

This data should be used to ensure proper attribution and brand consistency in any client applications that integrate with this content.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier) for authentication and affiliate identification. episode_id: The episode identifier, used to access the episode's data.

Returns:

ResultResponse[PlayoutAffiliate]: Result response contains Comprehensive information about the streaming platform, including name, URLs, branding assets, and contact information.

Raises:

ApiHttpException: When the episode data cannot be found or when affiliate information is unavailable or malformed.

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/companies/affiliate' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved complete affiliate information

Bodyapplication/json
dataobject(The response data)

Represents a streaming platform provider (affiliate)

Example: {"name":"string","description":"string","url":"string","logoUrl":"string"}
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": {
    "name": "string",
    "description": "string",
    "url": "string",
    "logoUrl": "string"
  }
}

List retailer/e-commerce platforms (merchants) involved.

Request

Get information about the retailer/e-commerce platforms (merchants) involved.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier). episode_id: The episode identifier

Returns:

ResultResponse[List[PlayoutMerchant]]: Result response contains the list of merchants.

Raises:

ApiHttpException: If the episode or merchant information is not found (404).

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/companies/merchants' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved list of merchants

Bodyapplication/json
dataArray of objects(The response data)

The response data.

Example: [{"id":"string","name":"string","description":"string","url":"string","logoUrl":"string","termsOfUseUrl":"string","privacyStatementUrl":"string"}]
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": [
    { … }
  ]
}

Details about a retailer/e-commerce platform (merchant).

Request

Get information about a specific retailer/e-commerce platform (merchant).

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier). episode_id: The episode identifier merchant_id: The merchant identifier (shop source).

Returns:

ResultResponse[PlayoutMerchant]: Result response contains the merchant details.

Raises:

ApiHttpException: If the episode, merchant list, or specific merchant are not found (404).

Path
playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

merchantIdstring(shop identifier)required

The shop identifier.

Headers
X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...
curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}/companies/merchants/{merchantId}' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved merchant details

Bodyapplication/json
dataobject(The response data)

Represents a retailer/e-commerce platform (merchant)

Example: {"id":"string","name":"string","description":"string","url":"string","logoUrl":"string","termsOfUseUrl":"string","privacyStatementUrl":"string"}
errorobject(The error response)

Represents a data response with a possible error.

Response
application/json
{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "url": "string",
    "logoUrl": "string",
    "termsOfUseUrl": "string",
    "privacyStatementUrl": "string"
  }
}

API information

Operations