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

📄️ 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

Get distributions of a channel

📄️ Create a distribution for a channel

Create a distribution 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

Ingests

📄️ 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 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 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

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