How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dolby OptiView Ads

OptiView Ads API (THEOads) - server-guided ad insertion: channels, ad breaks, events, marker rules, SCTE marker detection, origins, templates and organization integrations. 28 paths / 55 operations under /api/v1, plus the legacy v1 monetized-stream signalling contract.

Dolby OptiView Ads is one of 7 APIs that Dolby publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Advertising, Video, and SGAI. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 55 operations across 28 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against the base URL https://us.ads.optiview.dolby.com.

55 operations 28 paths 0 schemas 12 DELETE22 GET7 PATCH14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://us.ads.optiview.dolby.com
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Dolby OptiView Ads declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as x-org-id (orgId). By default, every request must be authenticated.

  • basicAuth — API key (username) and secret (password).
  • orgId — Organization identifier.

Paths & Operations 55

Across 28 paths, the API surfaces 55 operations — 12 DELETE, 22 GET, 7 PATCH, 14 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 55
GET
/api/v1/channels
List all channels with pagination, filtering, and sorting.
4 params → 200
POST
/api/v1/channels
Create a new channel.
body → 201
GET
/api/v1/channels/{channelId}
Get a channel by ID.
1 param → 200
PATCH
/api/v1/channels/{channelId}
Update a channel.
1 param body → 200
DELETE
/api/v1/channels/{channelId}
Delete a channel.
1 param → 204
POST
/api/v1/channels/{channelId}/detection/enable
Enable automatic ad-break detection for a channel. Starts the per-channel detection scheduler.
1 param → 200
POST
/api/v1/channels/{channelId}/detection/disable
Disable automatic ad-break detection for a channel. Stops the per-channel detection scheduler.
1 param → 200
GET
/api/v1/channels/{channelId}/breaks
List all breaks for a channel with pagination, filtering, and sorting.
5 params → 200
POST
/api/v1/channels/{channelId}/breaks
Create a break. Optionally provide a templateId to use a template as base.
1 param body → 201
DELETE
/api/v1/channels/{channelId}/breaks
Bulk delete breaks by IDs.
1 param body → 204
GET
/api/v1/channels/{channelId}/breaks/{breakId}
Get a break by ID.
2 params → 200
DELETE
/api/v1/channels/{channelId}/breaks/{breakId}
Delete a break.
2 params → 204
POST
/api/v1/channels/{channelId}/breaks/{breakId}/punch
schedule a CUED break, transitioning it to READY. Accepts an optional startDate (ISO 8601); defaults to now. Past dates are clamped to now.
2 params body → 200
GET
/api/v1/channels/{channelId}/events
List all events for a channel with pagination, filtering, and sorting.
5 params → 200
POST
/api/v1/channels/{channelId}/events
1 param body → 201
DELETE
/api/v1/channels/{channelId}/events
1 param body → 204
GET
/api/v1/channels/{channelId}/events/{eventId}
2 params → 200
PATCH
/api/v1/channels/{channelId}/events/{eventId}
2 params body → 200
DELETE
/api/v1/channels/{channelId}/events/{eventId}
2 params → 204
GET
/api/v1/channels/{channelId}/events/{eventId}/templates
List all templates associated with the event, with pagination, filtering, and sorting.
6 params → 200
GET
/api/v1/channels/{channelId}/events/{eventId}/templates/{templateId}/breaks
List breaks created from a template during an event, with pagination, filtering, and sorting.
7 params → 200
GET
/api/v1/channels/{channelId}/events/{eventId}/breaks
List all breaks associated with the event, with pagination, filtering, and sorting.
6 params → 200
GET
/api/v1/channels/{channelId}/events/{eventId}/breaks/current
List the breaks currently playing for the event: scheduled breaks whose start + duration window contains the request time, plus event-triggered breaks while the event is active.
2 params → 200
GET
/api/v1/channels/{channelId}/markerRules
List all marker rules for a channel with pagination, filtering, and sorting.
5 params → 200
POST
/api/v1/channels/{channelId}/markerRules
Create a marker rule.
1 param body → 201
DELETE
/api/v1/channels/{channelId}/markerRules
Bulk delete marker rules by IDs.
1 param body → 204
GET
/api/v1/channels/{channelId}/markerRules/{markerRuleId}
Get a marker rule by ID.
2 params → 200
PATCH
/api/v1/channels/{channelId}/markerRules/{markerRuleId}
Update a marker rule.
2 params body → 200
DELETE
/api/v1/channels/{channelId}/markerRules/{markerRuleId}
Delete a marker rule.
2 params → 204
GET
/api/v1/channels/{channelId}/detection/history
List detected ad-marker history for a channel with pagination, filtering, and sorting. Each entry records the detected marker and the action taken, plus (when applicable) the matched marker rule, the…
5 params → 200
GET
/api/v1/channels/{channelId}/detection/history/{markerDetectionId}
Get a detected ad-marker history entry by ID.
2 params → 200
GET
/api/v1/channels/{channelId}/integrations
List all channel integrations for a channel with pagination, filtering, and sorting.
5 params → 200
POST
/api/v1/channels/{channelId}/integrations
Create a channel integration.
1 param body → 201
GET
/api/v1/channels/{channelId}/integrations/{channelIntegrationId}
Get a channel integration by ID.
2 params → 200
PATCH
/api/v1/channels/{channelId}/integrations/{channelIntegrationId}
Update a channel integration.
2 params body → 200
DELETE
/api/v1/channels/{channelId}/integrations/{channelIntegrationId}
Delete a channel integration.
2 params → 204
GET
/api/v1/channels/{channelId}/origins
List all origins for a channel with pagination, filtering, and sorting.
5 params → 200
POST
/api/v1/channels/{channelId}/origins
Create a new origin within a channel. The channel is taken from the path.
1 param body → 201
GET
/api/v1/channels/{channelId}/origins/{originId}
Get an origin by ID within a channel.
2 params → 200
PATCH
/api/v1/channels/{channelId}/origins/{originId}
Update an origin within a channel.
2 params body → 200
DELETE
/api/v1/channels/{channelId}/origins/{originId}
Delete an origin within a channel.
2 params → 204
POST
/api/v1/channels/{channelId}/origins/{originId}/enable
Enable an origin within a channel (sets enabled to true).
2 params → 200
POST
/api/v1/channels/{channelId}/origins/{originId}/disable
Disable an origin within a channel (sets enabled to false).
2 params → 200
GET
/api/v1/templates
List all templates with pagination, filtering, and sorting.
4 params → 200
POST
/api/v1/templates
Create a new template. Backdrop is required for non-SINGLE layouts.
body → 201
DELETE
/api/v1/templates
Bulk delete templates by IDs.
body → 204
GET
/api/v1/templates/{templateId}
Get a template by ID.
1 param → 200
PATCH
/api/v1/templates/{templateId}
Update a template. Backdrop is required for non-SINGLE layouts.
1 param body → 200
DELETE
/api/v1/templates/{templateId}
Delete a template.
1 param → 204
GET
/api/v1/organizations/integrations
List all organization integrations for the organization with pagination, filtering, and sorting.
4 params → 200
POST
/api/v1/organizations/integrations
Create an organization integration.
body → 201
GET
/api/v1/organizations/integrations/{organizationIntegrationId}
Get an organization integration by ID.
1 param → 200
PATCH
/api/v1/organizations/integrations/{organizationIntegrationId}
Update an organization integration. type is immutable.
1 param body → 200
DELETE
/api/v1/organizations/integrations/{organizationIntegrationId}
Delete an organization integration.
1 param → 204
POST
/api/v1/organizations/integrations/{organizationIntegrationId}/verify
Verify the organization's stored service account credentials with the ad system: 204 when they verify, 422 with the reason when they do not, 502 when the check itself could not complete. The outcome…
1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dolby-optiview-ads-openapi.yml Raw ↑

Other APIs Dolby publishes across the network.

Dolby OptiView Player
Dolby OptiView Live
Dolby OptiView Real-time Streaming (Millicast)
Dolby OptiView Director API (Millicast)
Dolby OptiView Advanced Analytics API (Millicast)
Dolby OptiView Ad Engine
Where this information came from

This is an independent, third-party profile of Dolby OptiView Ads, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.