Data structures

This document describes objects that appear frequently in API requests and responses. Each entry includes information about which API methods contain or return these objects, helping you navigate the API more efficiently.

VOD

EndpointInfo

Field	Data Type	Notes
id	string	Optional. Unique identifier for the endpoint.
accessType	EndpointAccessType	Required. Specifies the access type of the endpoint (Http, S3, or Glacier).
format	MediaAssetFormatType	Required. Indicates the format of the media asset.
url	string	Optional. The URL of the endpoint.
preset	string	Optional. Preset information for the endpoint.
protection	MediaAssetProtectionType	Required. Specifies the protection type of the media asset.
protectionDetails	MediaAssetProtectionInfo	Optional. Contains additional details about the protection of the media asset.
durationMilliseconds	long	Optional. Duration of the media asset in milliseconds.
size	long	Optional. Size of the media asset in bytes.

Used in:

• List VOD assets
• Get VOD asset

EntityTranscodingOutput

Field	Data Type	Notes
status	AssetStatus	Required. Indicates the current status of the asset.
preset	string	Optional. The preset used for transcoding.
id	string	Optional. Unique identifier for the transcoding output.
expirationDate	date-time	Optional. The date and time when the transcoding output will expire.
endpoints	array of EndpointInfo	Optional. List of endpoints associated with this transcoding output.
completionDate	date-time	Optional. The date and time when the transcoding process was completed.

Used in:

• List VOD assets
• Get VOD asset

TranscodingTrack

Field	Data Type	Notes
trackSelector	TrackSelector	Required. Specifies how to select the track for transcoding.
type	TrackType	Required. Indicates the type of the track (Video, Audio, etc.).
language	string	Optional. The language of the track, if applicable.
name	string	Optional. A name or label for the track.

Used in:

• Create VOD asset
• List files
• Detect media tracks

VodAsset

Field	Data Type	Notes
id	string	Optional. Unique identifier for the VOD asset.
preset	string	Optional. The preset used for the VOD asset.
transcodedJobId	string	Optional. Identifier for the transcoding job associated with this asset.
title	string	Optional. The title of the VOD asset.
metadata	object	Optional. Key-value pairs of strings containing metadata about the asset.
tenantId	string	Optional. Identifier of the tenant associated with this asset.
createDate	date-time	Optional. The date and time when the asset was created.
lastModificationDate	date-time	Optional. The date and time when the asset was last modified.
status	AssetStatus	Required. The current status of the asset.
fileIds	object	Optional. Key-value pairs where the key is a string and the value is a FileTypesFlag.
sources	array of VodSource	Optional. List of sources for this VOD asset.
endpoints	array of EndpointInfo	Optional. List of endpoints associated with this asset.
outputs	array of EntityTranscodingOutput	Optional. List of transcoding outputs for this asset.
errorMessage	string	Optional. Error message if there was an issue with the asset.
durationMilliseconds	long	Optional. Duration of the asset in milliseconds.

Used in:

• List VOD assets
• Get VOD asset
• Update VOD asset

VodSource

Field	Data Type	Notes
fileId	string	Required. Unique identifier for the file. Minimum length: 1.
transcodingTracks	array of TranscodingTrack	Optional. List of transcoding tracks associated with this source.
fileTypesFlag	FileTypesFlag	Required. Indicates the type of file (e.g., Video, Audio, Caption).

Used in:

• Create VOD asset

Live

ChannelResult

Field	Data Type	Notes
id	string	Optional. Unique identifier for the channel.
endpoints	array of EndpointInfo	Optional. List of endpoints associated with this channel.
archiveEndpointIds	array of string	Optional. List of endpoint names that will be used for recording.
transcodeEndpointId	string	Optional. Endpoint name that will be used for transcoding of archived recording.
cdn	CdnChannelInfo	Required. Information about the CDN configuration for this channel.
inputs	array of ChannelInput	Optional. List of channel inputs (ingest points).
encoding	ChannelEncoding	Required. Encoding information for the channel.
status	ChannelStatus	Required. The current status of the channel.
internalStatus	string	Optional. Internal status of the channel.
metadata	object	Optional. Key-value pairs of strings containing metadata about the channel.
createDate	string (date-time)	Optional. The date and time when the channel was created.
lastModificationDate	string (date-time)	Optional. The date and time when the channel was last modified.
automationDisabled	boolean	Required. Indicates whether automation is disabled for this channel.
name	string	Optional. The name of the channel.

Used in:

• List Channels
• Get Channel Details
• Update Channel

EndpointInfo

Field	Data Type	Notes
id	string	Optional. Unique identifier for the endpoint.
accessType	EndpointAccessType	Required. Specifies the access type of the endpoint (Http, S3, or Glacier).
format	enum	Required. Indicates the format of the media asset.
url	string	Optional. The URL of the endpoint.
preset	string	Optional. Preset information for the endpoint.
protection	enum	Required. Specifies the protection type of the media asset.
protectionDetails	MediaAssetProtectionInfo	Optional. Contains additional details about the protection of the media asset.
protectionDetails.keyIds	array of string	Optional. List of key IDs used for protection.
protectionDetails.contentId	string	Optional. Content ID associated with the protection.
durationMilliseconds	integer (int64)	Optional. Duration of the media asset in milliseconds.
size	integer (int64)	Optional. Size of the media asset in bytes.

Used in:

• Get Channel Details
• Get Event Details

EventResult

Field	Data Type	Notes
id	string	Optional. Unique identifier for the event.
channelId	string	Optional. Identifier of the channel associated with this event.
start	string (date-time)	Required. Start time of the event.
end	string (date-time)	Required. End time of the event.
ensureChannel	boolean	Optional. If true, automatically turn on/off the channel for this event.
title	string	Optional. The title of the event.
catchup	EventCatchupResult	Required. Contains information about the catchup configuration for this event.
metadata	object	Optional. Key-value pairs of strings containing metadata about the event.
createDate	string (date-time)	Optional. The date and time when the event was created.
lastModificationDate	string (date-time)	Optional. The date and time when the event was last modified.

Used in API methods:

• List Events
• Get Event Details
• Update Event
• Delete Event

Restream

Field	Data Type	Notes
protocol	RestreamProtocol	Required. The protocol used for restreaming (e.g., RTMP).
id	string	Required. Unique identifier for the restream configuration. Minimum length: 1.
rtmpDestinations	array of RestreamDestination	Optional. List of RTMP destinations for restreaming.
rtmpDestinations.url	string	Optional. The RTMP endpoint for restreaming.
rtmpDestinations.streamKey	string	Optional. The stream key for restreaming.

Used in:

• Create Channel

Recorder

EndpointInfo

Field	Data Type	Notes
id	string	Optional. Unique identifier for the endpoint.
accessType	EndpointAccessType	Required. Specifies the access type of the endpoint (Http, S3, or Glacier).
format	MediaAssetFormatType	Required. Indicates the format of the media asset.
url	string	Optional. The URL of the endpoint.
preset	string	Optional. Preset information for the endpoint.
protection	MediaAssetProtectionType	Required. Specifies the protection type of the media asset.
protectionDetails	MediaAssetProtectionInfo	Optional. Contains additional details about the protection of the media asset.
durationMilliseconds	integer	Optional. Duration of the media asset in milliseconds.
size	integer	Optional. Size of the media asset in bytes.

Used in:

• Get Recording Details
• List Recordings

RecordingResult

Field	Data Type	Notes
id	string	Optional. Unique identifier for the recording.
source	RecordingSourceMessage	Required. Information about the source of the recording.
catchup	CatchupResult	Optional. Information about the catchup configuration for this recording.
archive	EntityArchive	Optional. Information about the archive configuration for this recording.
outputs	array of OutputResult	Optional. List of additional outputs generated after archiving.
expirationDate	string (date-time)	Optional. The date and time when the asset will expire.
status	AssetStatus	Required. The current status of the recording.
metadata	object	Optional. Key-value pairs of strings containing metadata about the recording.
errorMessage	string	Optional. Error message if there was an issue with the recording.
createDate	string (date-time)	Optional. The date and time when the recording was created.
lastModificationDate	string (date-time)	Optional. The date and time when the recording was last modified.
durationMilliseconds	integer (int64)	Optional. Duration of the recording in milliseconds. Read-only.
title	string	Optional. The title of the recording.

Used in:

• Get Recording Details
• List Recordings
• Update Recording

Streaming

AnalyticFilter

Field	Data Type	Notes
name	DimensionKind	Required. The dimension to filter on.
operator	ComparisonOperator	Required. The comparison operator to use for filtering.
value	any	Required. The value to compare against for filtering.

Used in:

• Get ads count analytics
• Get ads sum analytics
• Get ads avg analytics
• Get max concurrent viewers
• List impressions
• Get queries median analytics
• Get queries avg analytics
• Get queries count analytics
• Get queries sum analytics

AnalyticOrderBy

Field	Data Type	Notes
name	DimensionKind	Required. The dimension to order by.
order	OrderDirection	Required. The direction of ordering (ASC or DESC).

Used in:

• Get ads count analytics
• Get ads sum analytics
• Get ads avg analytics
• Get max concurrent viewers
• Get queries median analytics
• Get queries avg analytics
• Get queries count analytics
• Get queries sum analytics

AssetResult

Field	Data Type	Notes
id	string	Optional. Unique identifier for the asset.
status	AssetStatus	Required. The current status of the asset.
metadata	object	Optional. Key-value pairs of strings containing metadata about the asset.
outputs	array of OutputResult	Optional. List of additional outputs for this asset.
createDate	string (date-time)	Optional. The date and time when the asset was created.
lastModificationDate	string (date-time)	Optional. The date and time when the asset was last modified.
durationMilliseconds	integer	Optional. Duration of the asset in milliseconds.
source	AssetSource	Required. The source of the asset.
type	AssetType	Required. The type of the asset.
channelId	string	Optional. Identifier of the channel associated with this asset.
start	string (date-time)	Optional. Start time of the event (for live events).
end	string (date-time)	Optional. End time of the event (for live events).
isDrm	boolean	Required. Indicates whether the content is DRM-protected.
preset	string	Optional. Preset information for the asset.
tokenRequiredPolicy	InternalTokenRequiredPolicy	Required. Policy for token requirements.
title	string	Optional. The title of the asset.
description	string	Optional. A description of the asset.
tags	array of AssetTag	Optional. List of tags associated with the asset.
images	object	Optional. Key-value pairs of image information associated with the asset.
chapters	array of Chapter	Optional. List of chapters for the asset.

Used in:

• List assets
• Get asset details
• Update asset

UploadedFileResult

Field	Data Type	Notes
id	string	Optional. Unique identifier for the uploaded file.
fileKey	string	Optional. File storage identifier.
status	UploadFileStatus	Required. Current status of the uploaded file.
fileSize	integer	Required. Size of the file in bytes.
s3Uri	string	Optional. S3 URI path for the uploaded file.
url	string	Optional. Public URL for accessing the file.
bucket	string	Optional. Name of the S3 bucket where the file is stored.
orginalFileName	string	Optional. Original name of the uploaded file.
name	string	Optional. Current name of the file in the system.
createDate	string (date-time)	Optional. The date and time when the file was created.
lastModificationDate	string (date-time)	Optional. The date and time when the file was last modified.

Used in:

• List images
• Get image details

EndpointInfo

Field	Data Type	Notes
id	string	Endpoint ID
accessType	EndpointAccessType	Access type of the endpoint
format	MediaAssetFormatType	Format of the media asset
url	string	URL of the endpoint
preset	string	Preset information
protection	MediaAssetProtectionType	Protection type of the media asset
protectionDetails	MediaAssetProtectionInfo	Protection details
protectionDetails.keyIds	array of string	Key IDs for the protection
protectionDetails.contentId	string	Content ID
durationMilliseconds	integer	Duration in milliseconds
size	integer	Size of the asset

Used in:

• List assets
• Get asset details

ContentAcquisitionInfo

Field	Data Type	Notes
acquireContentUrl	string	AcquireContent endpoint URL
sourceConfigUrl	string	SourceConfig endpoint URL
authorization	ContentAuthorizationInfo	Content authorization information
authorization.tokenRequiredPolicy	boolean	Tenant TokenRequiredPolicy determine streaming assets access
authorization.signingKey	string	JWT signing key
authorization.signingAlgorithm	string	JWT signing algorithm

Used in:

• Get settings

LicenseAcquisitionInfo

Field	Data Type	Notes
enabled	boolean	Is DRM enabled
authorization	LicenseAuthorizationInfo	License authorization information
authorization.signingKey	string	JWT signing key
authorization.signingAlgorithm	string	JWT signing algorithm
endpoints	array of LicenseEndpointInfo	List of license endpoint information
endpoints.licenseUrl	string	License endpoint URL
endpoints.certificateUrl	string	Certificate endpoint URL
endpoints.systemName	string	License system name
endpoints.systemId	string	License system ID

Used in:

• Get settings

BitmovinPlayerInfo

Field	Data Type	Notes
embedUrl	string	Bitmovin embed player URL
sourceConfigUrl	string	SourceConfig endpoint URL
playerLicense	PlayerLicenseDetails	Player license details
playerLicense.key	string	License key
playerLicense.impressions	integer	Count of impressions
playerLicense.maxImpressions	integer	Max of impressions
playerLicense.id	string	Player license id
analyticsLicense	LicenseDetails	Analytics license details
analyticsLicense.key	string	License key
analyticsLicense.impressions	integer	Count of impressions
analyticsLicense.maxImpressions	integer	Max of impressions

Used in:

• Get settings

CapInfo

Field	Data Type	Notes
enabled	boolean	Is Cap enabled
capUrl	string	Cap heartbeat URL
signingKey	string	JWT signing key

Used in:

• Get settings

AllowedDomain

Field	Data Type	Notes
playerDomainId	string	Player domain identifier
analyticsDomainId	string	Analytic domain identifier
url	string	Domain URL

Used in:

• Get settings