OptiView Live REST API
OptiView Live provides a REST API to manage channels, receive events, create reports, and set up webhooks.
Alternatively, you can perform the most common actions directly from the OptiView Live dashboard. See our getting started guide for more information.
To get started with the API, see the Authentication guide.
The full API specification is also available as a Swagger document.
Channels
Get all channels
Get all channels
Create a new channel
Create a new channel
Get a channel by ID
Get a channel by ID
Update a channel by ID
Update a channel by ID
Delete a channel by ID
Delete a channel by ID
Get the DRM content protection configurations of a channel
Get the DRM content protection configurations of a channel
Start a channel (will start all connected engines)
Start a channel (will start all connected engines)
Stop a channel (will stop all connected engines)
Stop a channel (will stop all connected engines)
Get ingests of a channel
Get ingests of a channel
Create an ingest for a channel
Create an ingest for a channel
Get engines of a channel
Get engines of a channel
Create an engine for a channel
Create an engine for a channel
Get distributions of a channel
Distributions are ordered alphabetically by name.
Create a distribution for a channel
Create a distribution for a channel
Send instream metadata for a channel
Send instream metadata for a channel
Get engine runs of a channel
Get engine runs of a channel
Get transcoding minutes analytics for a channel
Get transcoding minutes analytics for a channel
Get viewing minutes analytics for a channel
Get viewing minutes analytics for a channel
Get bytes transferred analytics for a channel
Get bytes transferred analytics for a channel
Get viewing minutes grouped by browser for a channel
Get viewing minutes grouped by browser for a channel
Get viewing minutes grouped by country for a channel
Get viewing minutes grouped by country for a channel
Get bytes transferred grouped by browser for a channel
Get bytes transferred grouped by browser for a channel
Get bytes transferred grouped by country for a channel
Get bytes transferred grouped by country for a channel
Get country insights for a channel
Data is only available for the last 30 days.
Get browser and OS insights for a channel
Data is only available for the last 30 days.
Get viewer count insights for a channel
Data is only available for the last 30 days.
Create a custom endpoint on a channel
Create a custom endpoint on a channel
List all custom endpoints of a channel
List all custom endpoints of a channel
Ingests
Get ingests of a channel
Get ingests of a channel
Create an ingest for a channel
Create an ingest for a channel
Get an ingest by ID
Get an ingest by ID
Update an ingest by ID
Update an ingest by ID
Delete an ingest by ID
Delete an ingest by ID
Get engines of an ingest
Get engines of an ingest
Create an engine for an ingest
Create an engine for an ingest
Engines
Get engines of a channel
Get engines of a channel
Create an engine for a channel
Create an engine for a channel
Get an engine by ID
Get an engine by ID
Update an engine by ID
Update an engine by ID
Delete an engine by ID
Delete an engine by ID
Start an engine
Start an engine
Stop an engine
Stop an engine
Get the last run of an engine
Get the last run of an engine
Get runs of an engine
Get runs of an engine
Distributions
Get distributions of a channel
Distributions are ordered alphabetically by name.
Create a distribution for a channel
Create a distribution for a channel
Get a distribution by ID
Get a distribution by ID
Update a distribution by ID
Update a distribution by ID
Delete a distribution by ID
Delete a distribution by ID
Get security keys of a distribution
Get security keys of a distribution
Add a security key to a distribution
Add a security key to a distribution
Delete all security keys of a distribution
Delete all security keys of a distribution
Get a specific security key
Get a specific security key
Delete a specific security key
Delete a specific security key
Get viewing minutes analytics for a distribution
Get viewing minutes analytics for a distribution
Get bytes transferred analytics for a distribution
Get bytes transferred analytics for a distribution
Get viewing minutes grouped by browser for a distribution
Get viewing minutes grouped by browser for a distribution
Get viewing minutes grouped by country for a distribution
Get viewing minutes grouped by country for a distribution
Get bytes transferred grouped by browser for a distribution
Get bytes transferred grouped by browser for a distribution
Get bytes transferred grouped by country for a distribution
Get bytes transferred grouped by country for a distribution
Get country insights for a distribution
Data is only available for the last 30 days.
Get browser and OS insights for a distribution
Data is only available for the last 30 days.
Get viewer count insights for a distribution
Data is only available for the last 30 days.
Regions
Get all regions available for your organization
Get all regions available for your organization
ABR Ladders
Get all ABR ladders for your organization
Get all ABR ladders for your organization
Webhooks
Get all webhooks
Get all webhooks
Create a new webhook
Create a new webhook
Get a webhook by ID
Get a webhook by ID
Update a webhook by ID
Update a webhook by ID
Delete a webhook by ID
Delete a webhook by ID
Get a webhook secret
Get a webhook secret
Get webhook logs
Get webhook logs
Schedulers
List all schedulers
List all schedulers
Create a scheduler
Create a scheduler
Get a scheduler by ID
Get a scheduler by ID
Update a scheduler by ID
Update a scheduler by ID
Delete a scheduler by ID
Delete a scheduler by ID
Custom Endpoints
Create a custom endpoint on a channel
Create a custom endpoint on a channel
List all custom endpoints of a channel
List all custom endpoints of a channel
Get a custom endpoint by ID
Get a custom endpoint by ID
Update a custom endpoint
Update a custom endpoint
Delete a custom endpoint
Delete a custom endpoint
Monitoring
Get monitoring data for a channel
Returns monitoring data for a specific channel including status of ingests, engines, and distributions.
Get detailed monitoring data for an ingest
Returns monitoring data for a specific ingest including time-series metrics like packet loss, RTT, and bitrate.
Get detailed monitoring data for an engine
Returns monitoring data for a specific engine including rendition metrics.
Get detailed ingest monitoring data for a channel
Returns channel metadata along with detailed monitoring data for all ingests belonging to the channel.
Get detailed engine monitoring data for a channel
Returns channel metadata along with detailed monitoring data for all engines belonging to the channel.
Enhancements
Get all speech dictionaries
A speech dictionary is a flat list of terms (names, proper nouns, acronyms, specialized terminology) that helps the speech recognition correctly caption the source audio of a speech enhancement. It does not translate terms: the source audio is first captioned in the source language (aided by the dictionary) and then translated into the target languages. Connect a dictionary to an ingest via the `dictionary` field of the speech enhancement entry; the dictionary `language` must match that enhancement's `sourceLanguage`.
Create a new speech dictionary
A speech dictionary is a flat list of terms (names, proper nouns, acronyms, specialized terminology) that helps the speech recognition correctly caption the source audio of a speech enhancement. It does not translate terms: the source audio is first captioned in the source language (aided by the dictionary) and then translated into the target languages. Connect a dictionary to an ingest via the `dictionary` field of the speech enhancement entry; the dictionary `language` must match that enhancement's `sourceLanguage`. Terms are cleaned up automatically (whitespace normalized, empty and duplicate entries dropped); terms that cannot be fixed automatically (forbidden characters ';' or '/', more than 6 words) are rejected with `invalid_value`.
Get a speech dictionary by ID
Get a speech dictionary by ID
Update a speech dictionary by ID
The `terms` list is replaced as a whole. Terms are cleaned up automatically (whitespace normalized, empty and duplicate entries dropped); terms that cannot be fixed automatically (forbidden characters ';' or '/', more than 6 words) are rejected with `invalid_value`.
Delete a speech dictionary by ID
A dictionary cannot be deleted while it is connected to an ingest that has an engine which is not stopped (409 `speech_dictionary_in_use`). Once deleted, the dictionary is automatically disconnected from all ingests that referenced it.
Get supported source languages
Languages the speech recognition can transcribe, i.e. the valid values for the `sourceLanguage` field of a speech enhancement entry (the language spoken in the stream).
Get supported target languages
Languages the source captions can be translated into, i.e. the valid values for the `targetTextTracks` field of a speech enhancement entry.