Skip to main content
image/svg+xml
Help
  • Guides
  • API Docs
  • Downloads
  • Video Tutorials
Community Tech Support Help
Help Center > Guides > Video Platform > Developer Guide > API References > Backlot REST API > >
About the Backlot REST API

Video Platform

  • Copyright Notice
  • Welcome to Video Platform Documentation
  • Video Platform Release Notes
    • Subscribe to Ooyala Release Notes
    • 2019 Video Platform Release Notes
      • 2019-02-12 Release
      • 2019-01-22 Release
      • 2019-01-18 Release
    • 2018 Video Platform Release Notes
      • 2018-12-06 Releases
      • 2018-11-22 Release
      • 2018-11-20 Release
      • 2018-10-24 Release
      • 2018-10-08 Release
      • 2018-08-30 Release
      • 2018-08-08 Release
      • 2018-07-13 Release
      • 2018-04-18 Release
      • 2018-04-16 Release
      • 2018-04-13 Release
      • 2018-04-05 Release
      • 2018-04-04 Release
      • 2018-04-03 Release
      • 2018-03-20 Release
      • 2018-03-16 Release
      • 2018-03-13 Release
      • 2018-03-07 Release
      • 2018-02-23 Release
      • 2018-02-14 Release
      • 2018-02-07 Release
      • 2018-02-05 Release
      • 2018-01-23 Release
      • 2018-01-17 Release
      • 2018-01-11 Release
      • 2018-01-04 Release
    • 2017 Video Platform Release Notes
      • 2017-12-22 Release
      • 2017-12-20 Release
      • 2017-12-14 Release
      • 2017-12-11 Release
      • 2017-12-08 Release
      • 2017-12-04 Release
      • 2017-12-01 Release
      • 2017-11-29 Release
      • 2017-11-20 Release
      • 2017-11-16 Release
      • 2017-11-14 Release
      • 2017-11-09 Release
      • 2017-11-08 Release
      • 2017-11-06 Release
      • 2017-11-01 Release
      • 2017-10-26 Release
      • 2017-10-12 Release
      • 2017-10-11 Release
      • 2017-10-04 Release
      • 2017-10-02 Release
      • 2017-09-27 Release
      • 2017-09-26 Release
      • 2017-09-21 Release
      • 2017-09-18 Release
      • 2017-09-14 Release
      • 2017-09-13 Release
      • 2017-09-06 Release
      • 2017-08-31 Release
      • 2017-08-24 Release
      • 2017-08-22 Release
      • 2017-08-16 Release
      • 2017-08-15 Release
      • 2017-08-04 Release
      • 2017-08-03 Release
      • 2017-07-24 Release
      • 2017-07-20 Release
      • 2017-07-10 Release
      • 2017-07-03 Release
      • 2017-06-30 Release
      • 2017-06-14 Release
      • 2017-06-12 Release
      • 2017-06-08 Release
      • 2017-06-04 Release
      • 2017-05-31 Release
      • 2017-05-25 Release
      • 2017-05-24 Release
      • 2017-05-17 Release
      • 2017-05-15 Release
      • 2017-05-10 Release
      • 2017-05-02 Release
      • 2017-05-01 Release
      • 2017-04-04 Release
      • 2017-03-29 Release
      • 2017-03-28 Release
      • 2017-03-13 Release
      • 2017-02-17 Release
      • 2017-02-03 Release
      • 2017-01-30 Release
      • 2017-01-26 Release
      • 2017-01-12 Release
    • 2016 Video Platform Release Notes
      • 2016-12-22 Release
      • 2016-12-15 Release
      • 2016-11-18 Release
      • 2016-11-10 Release
      • 2016-11-03 Release
      • 2016-10-20 Release
      • 2016-10-13 Release
      • 2016-10-06 Release
      • 2016-09-30 Release
      • 2016-09-29 Release
      • 2016-09-14 Release
      • 2016-09-08 Release
      • 2016-08-26 Release
      • 2016-08-18 Release
      • 2016-08-11 Release
      • 2016-08-04 Release
      • 2016-08-01 Release
      • 2016-07-28 Release
      • 2016-07-21 Release
      • 2016-07-14 Release
      • 2016-07-12 Release
      • 2016-07-01 Release
      • 2016-06-30 Release
      • 2016-06-23 Release
      • 2016-06-16 Release
      • 2016-06-09 Release
      • 2016-06-01 Release
      • 2016-05-31 Release
      • 2016-05-23 Release
      • 2016-05-20 Release
      • 2016-05-16 Release
      • 2016-05-13 Release
      • 2016-05-09 Release
      • 2016-05-06 Release
      • 2016-04-29 Release
      • 2016-04-28 Release
      • 2016-04-19 Release
      • 2016-04-15 Release
      • 2016-04-12 Release
      • 2016-04-04 Release
      • 2016-03-31 Release
      • 2016-03-25 Release
      • 2016-03-17 Release
      • 2016-03-09 Release
      • 2016-03-04 Release
      • 2016-02-17 Release
      • 2016-02-10 Release
      • 2016-01-29 Release
      • 2016-01-26 Release
      • 2016-01-20 Release
      • 2016-01-08 Release
    • 2015 Video Platform Release Notes
      • 2015-12-30 Release
      • 2015-12-16 Release
      • 2015-12-07 Release
      • 2015-12-02 Release
      • 2015-11-19 Release
      • 2015-11-16 Release
      • 2015-11-11 Release
      • 2015-10-21 Release
      • 2015-10-15 Release
      • 2015-10-07 Release
      • 2015-09-30 Release
      • 2015-09-18 Release
      • 2015-09-11 Release
      • 2015-09-01 Release
      • 2015-08-24 Release
      • 2015-08-05 Release
      • 2015-07-24 Release
      • 2015-07-22 Release
      • 2015-07-10 Release
      • 2015-07-02 Release
      • 2015-06-30 Release
      • 2015-06-24 Release
      • 2015-06-17 Release
      • 2015-06-01 Release
      • 2015-05-11 Release
      • 2015-05-07 Release
      • 2015-05-01 Release
      • 2015-04-23 Release
      • 2015-04-10 Release
      • 2015-04-08 Release
      • 2015-04-2 Release
      • 2015-03-16 Release
      • 2015-03-10 Release
      • 2015-02-25 Release
      • 2015-02-20 Release
      • 2015-02-17 Release
      • 2015-02-11 Release
      • 2015-02-03 Release
      • 2015-01-26 Release
      • 2015-1-15 Release
    • 2014 Video Platform Release Notes
      • 2014-12-17 Release
      • 2014-12-04 Release
      • 2014-11-10 Release
      • 2014-11-03 Release
      • 2014-10-27 Release
      • 2014-10-13 Release
      • 2014-09-22 Release
      • 2014-09-16 Release
      • 2014-09-08 Release
      • 2014-08-13 Release
      • 2014-07-29 Release
      • 2014-07-17 Release
      • 2014-07-02 Release
      • 2014-06-12 Release
      • 2014-06-03 Release
      • 2014-05-19 Release
      • 2014-05-06 Release
      • 2014-04-22 Release
      • 2014-04-07 Release
    • 2013 Video Platform Release Notes
      • 2013-12-23 Release
      • 2013-10-16 Release
      • 2013-07-03 Release
      • 2013-03-26 Release
    • 2012 Video Platform Release Notes
      • 2012-11-16 Release
      • 2012-09-07 Release
      • 2012-06-19 Release
      • 2012-04-16 Release
      • 2012-02-27 Release
      • 2012-01-30 Release
    • 2011 Video Platform Release Notes
      • 2011-12-12 Release
      • 2011-11-28 Release
  • User Guide
    • Introducing the Online Video Platform
    • Ingestion
      • About Ingesting Content
      • Ways to Ingest Content
        • Uploading to Backlot
          • Ingesting with the Backlot UI
          • Ingesting with the Backlot API
        • Ooyala Ingestion Service (OIS)
          • Ingesting with FTP / FTPS
          • Ingesting with Aspera
          • Ingesting from a Remotely Hosted MRSS Feed
          • Ooyala Ingest Server Endpoints
          • Manifest File Formats
            • CSV Manifest File
            • XML Manifest File
            • Updating Asset Metadata Using CSV or XML Manifest Files
          • Dynamic Manifests
          • Ingestion Log
      • Ingesting Closed Caption Files
      • Ingesting Remote Assets
        • Ingesting Remote Assets via MRSS
        • Adding a Remote Asset in Backlot
        • Adding a Remote Asset Using the Backlot REST API
      • Content Migration
      • Integrate with NewZulu
      • Integrate with Avid Technologies
      • Ingestion Release Notes
    • Backlot User Guide
      • Introduction
        • Features
        • Supported Browsers
      • Getting Started with Backlot
        • Getting a Backlot Account
        • Logging In and Selecting a Language in the Backlot UI
        • Uploading a Video
        • Publishing a Video
        • Watching a Video
        • Monetizing Videos
          • Uploading an Advertisement
          • Creating an Ad Set
          • Applying an Ad Set to a Video
        • Next Steps
      • Before Uploading Content
        • Account Configuration
        • Content Organization
        • Content Upload and Management
        • Transcoding Setup
          • Ooyala Transcoding Service (OTS)
            • Express Processing Assets
          • Delivery Protocols
          • Encoding Settings
          • Processing Time
          • Encoding Recommendations for Player V4
          • Encoding Recommendations for Player V3 (Deprecated)
          • How Flash Players Choose a Stream
          • Ooyala Transcoding Service (OTS) Release Notes
      • Account Configuration
        • Changing Your Password
        • Changing Account Settings
        • Viewing Usage Metrics
        • About Sub-accounts
        • Managing Users
          • Adding a User
          • Editing User Settings
          • Deleting a User
        • Managing API Settings
        • Viewing the Ingest Log in Backlot
      • Managing Players in Backlot
        • Creating a Player in Backlot
        • Configuring a Player in Backlot
        • Deleting a Player in Backlot
        • Configuring Basic Player Settings for Flash Player V3 (Deprecated)
        • Configuring Player Channel Settings for Flash Player V3 (Deprecated)
        • Configuring Player Branding for Flash Player V3 (Deprecated)
        • Configuring the Start Screen for Flash Player V3 (Deprecated)
        • Configuring the End Screen for Flash Player V3 (Deprecated)
        • Editing Player V3 Settings (Deprecated)
      • Analytics
      • Content Upload and Management
        • Status of an Asset
        • Searching for Assets
        • Filtering Your Assets List
        • Recovering from Transcoding Errors
        • Video
          • Quality of and Recommendations on Source Material (Video and Audio)
          • Auto-generated Preview Images (Thumbnails)
          • Uploading a Video
          • Managing Video Details
          • Managing the Preview Image
          • Managing Publishing Rules
          • Managing Monetization
          • Associating an Asset with a Label
          • Replacing Content
        • Audio
          • Uploading Audio
          • Managing Audio Details
          • Managing Publishing Rules
          • Associating an Asset with a Label
          • Replacing Content
        • Setting Up Syndication to Facebook
        • YouTube Videos
          • Adding a YouTube Video
          • Managing YouTube Asset Details
        • Remote Assets
          • Adding a Remote Asset in Backlot
          • Managing Remote Asset Details
          • Managing the Preview Image
          • Managing Publishing Rules
          • Managing Monetization
          • Associating an Asset with a Label
        • Live Streams (Deprecated)
          • Adding a Live Stream (Deprecated)
          • Managing Live Stream Details (Deprecated)
          • Editing a Live Stream (Deprecated)
          • Managing the Preview Image
          • Managing Monetization
          • Associating an Asset with a Label
          • Managing DVR Capabilities (Deprecated)
        • Live Audio Streams (Deprecated)
          • Creating a Live Audio Stream (Deprecated)
          • Adding a Live Audio Stream (Deprecated)
          • Managing Live Stream Details (Deprecated)
          • Associating an Asset with a Label
        • Managing Custom Metadata
          • Adding Custom Metadata
          • Editing Custom Metadata
          • Deleting Custom Metadata
        • Content Publishing
          • Configuring Player Embed Settings in Backlot
          • Syndicating an Asset
        • Managing Closed Captions
          • About Closed Captions
          • Uploading a Closed Caption File in Backlot
          • Deleting a Closed Caption File
          • FCC 708 Styling for Closed Captions in Flash Player V3 (Deprecated)
        • Bulk Applying Settings
      • Channels and Channel Sets (Deprecated)
        • Channels (Deprecated)
          • Creating a Channel (Deprecated)
          • Managing Channel Details (Deprecated)
          • Adding Videos to a Channel (Deprecated)
          • Managing the Preview Image
          • Managing Monetization
          • Managing Publishing Rules (Deprecated)
          • Configuring Player Embed Settings in Backlot
          • Associating an Asset with a Label
          • Deleting a Channel (Deprecated)
        • Channel Sets (Deprecated)
          • Creating a Channel Set (Deprecated)
          • Managing Channel Set Details (Deprecated)
          • Adding Channels to a Channel Set (Deprecated)
          • Managing the Preview Image
          • Managing Publishing Rules for Channel Sets (Deprecated)
          • Managing Monetization
          • Configuring Player Embed Settings in Backlot
          • Associating an Asset with a Label
          • Deleting Channel Sets (Deprecated)
      • Monetization
        • Working with Your Own Ad Assets, Ad Sets, and Ad Sources
          • Uploading a Video Advertisement
          • Creating an Ad Set
          • Creating Ad Sets for Integrating with Ad Sources
            • Ad Set Fields for Ooyala Pulse Ad Manager
            • Ad Set Fields for Adap.tv
            • Ad Set Fields for FreeWheel Ad Manager
            • Ad Set Fields for Google IMA V3
            • Ad Set Fields for LiveRail
            • Ad Set Fields for Tremor Media
          • Migrating from YuMe to VPAID Ad Source
          • Deleting an Ad from an Ad Set
          • Deleting an Ad Set
        • Paywall Integration
          • Integrate with the Piano Go Paywall
          • Integrate with the Cleeng Paywall
        • Monetizing Your Ooyala Content with DFP
      • Content Publishing
        • Manual Publishing
          • Configuring Player Embed Settings in Backlot
          • Masking the Player URL
        • Syndication
          • Creating a Syndication
          • Editing a Syndication
          • Deleting a Syndication
          • Syndication Controls Security Features and Relation to Programming
          • Specific Syndications
            • Syndication to Facebook
            • Syndication with 3GP MRSS
            • Advanced Syndication
            • Syndication with Boxee
            • Syndication with Google Video Sitemap
            • Syndication with iPad MRSS
            • Syndication with iPhone MRSS
            • Syndication with MP4 MRSS
            • Syndication with Player MRSS
            • Syndication with Podcast
            • Syndication with Roku Feed (Deprecated)
            • Syndication with Source MRSS
            • Syndication with YouTube
          • Universal Syndication, Including Live Streams
        • Publishing Rules
          • Creating Publishing Rules
          • Editing Publishing Rules
          • Deleting Publishing Rules
        • Labels
          • Creating Labels
          • Editing Labels
          • Deleting Labels
          • Associating an Asset with a Label
      • Content Discovery and Recommendations
        • About Discovering and Recommending Content
        • Configuring Discovery in the Backlot UI
        • Discovery Insights Reports (No Longer Available)
          • Discovery Plays Report: Leaderboard 1 (No Longer Available)
          • Discovery Leads Report: Leaderboard 2 (No Longer Available)
          • Discovery Time Lift Report (No Longer Available)
          • Discovery Lift Report (No Longer Available)
          • Discovery CTR (Click Through Rate) Report (No Longer Available)
        • Program Analytics Insight Report
      • Playlists and the Theme Builder User Interface
        • Logging into Theme Builder
        • Theme Builder Overview
        • Working with Playlists in Theme Builder
        • Working with Players and Pods in Theme Builder
        • Working with Embeds in Theme Builder
      • Ooyala Backlot Release Notes
    • Theme Builder Player Customization User Guide
      • Playlists and the Theme Builder User Interface
        • Theme Builder Overview
        • Logging into Theme Builder
        • Supported Operating Systems and Browsers
        • Design Choices in Theme Builder
        • Working with Playlists in Theme Builder
        • Working with Players and Pods in Theme Builder
        • Working with Embeds in Theme Builder
      • Implementation Notes for Theme Builder
    • Ooyala IQ Analytics User Guide
      • Introduction to Ooyala IQ
        • How Ooyala IQ Works
        • Common Metric Definitions and Examples
        • Browsers Supported By Ooyala IQ
        • Accessing Ooyala IQ
        • Ooyala IQ and Live Assets
      • Using Ooyala IQ with Third-Party Players
        • Syncing Third-Party Metadata with Ooyala IQ
        • Ooyala IQ Account Management
        • Integrating Third-Party Players with IQ Using the JS SDK
        • Integrating Third-Party Players with IQ Using the JSON API
      • Business Use Case Examples of Analyses
        • Generalized Approaches to Analyses
        • What Type of Content is Performing the Best on Mobile Devices?
        • Online Media: How Are My Different Brands Performing?
        • What Geographies Are Driving My Content Traffic?
        • How Do I Optimize My Targeting of Ad Campaigns?
        • How Do I Uncover Videos With High Potential?
      • Ooyala IQ Workspace Reference
        • Ooyala IQ Dashboard
        • Business Intelligence Reports
          • Common Controls for Tables and Graphs
          • Analytics and Labels
          • Setting the Date Range on the Business Intelligence Page
          • Using the Date Range Comparison Feature on the Business Intelligence Page
          • Examining Videos Across Different Dimensions
          • Using Filters
            • Applying Filters to the Business Intelligence Page
            • Filtering the Asset Dimension by Label or Name
            • Filtering the Asset Dimension by Custom metadata, Duration or Published date
            • Using Preset Filters in the Business Intelligence Page
          • Viewing Performance Metrics
          • Viewing Engagement Metrics
          • Viewing Reach Metrics
          • Viewing Playthrough Metrics
          • Viewing Discovery Insights
          • Deriving Value From Discovery Insights
          • Exporting Business Intelligence Reports
          • Viewing Expanded Tables
          • Business Intelligence Error Handling
        • Video Details
      • Migrating from v2 Analytics (Deprecated)
        • v2/v3 Fundamental Difference: Multidimensional Analysis (Deprecated)
        • Data Migration (Deprecated)
        • How to Export Your Data With the v2 Analytics API (Deprecated)
        • Potential Differences in the Data (Deprecated)
        • Analytics Graphical User Interface (GUI) Differences (Deprecated)
        • v3 Analytics API Differences (Deprecated)
        • Certain "Unique" Metrics Confusing in v2 Analytics (Deprecated)
      • Analytics Glossary
      • Ooyala IQ Release Notes
    • Ooyala Live User Guide
      • Ooyala Live Overview
      • Before You Start
      • Delivering Live Content
        • Add a Channel
          • Channel General Setup
          • Channel Encoding Setup
            • Basic Channel Encoding Setup
            • Playlist Channel Encoding Setup
          • Channel Packaging Setup
          • Channel Syndication Setup
          • Channel Create Summary
        • Setting Up a High Availability Channel
          • Create Live High Availability (HA) Channel
          • How to Identify a High Availability (HA) Channel
          • Swap High Availability (HA) Channels
        • Add a Schedule
        • Add an Event
          • Trim Live Event
          • Add Event to High Availability (HA) Channel
        • Add Playlists
          • Add Playlist
          • Add Videos to a Playlist
          • Edit a Playlist
        • Ooyala Live’s Linear VOD Playlist
        • Add Clips from a Live Stream
        • Ooyala Live Clipping to MAM
      • Syndicate Live Video to Social Media
        • Syndicate Live Video to Facebook
        • Syndicate Live Video to YouTube
        • Syndicate Live Video to Periscope
        • Syndicate Live Video to Twitch
      • Ooyala Live Stream Integration (SSAI)
      • Considerations When Adding and Managing Channels
      • Ooyala Live FAQ
      • Ooyala Live Glossary
      • Ooyala Live Release Notes
    • SSAI User Guide for VOD Assets
    • General Reference
      • Frequently Asked Questions
        • Ad Integration FAQ
        • Ooyala IQ (Analytics) FAQ
        • Ooyala IQ Data Retention Policy FAQ
        • API and SDK FAQ
        • Discovery FAQ
        • External Publishing FAQ
        • Player V4 FAQ
        • Player V3 FAQ (Deprecated)
        • Player Security FAQ
        • Quality of Service FAQ
        • Uploading FAQ
        • Ooyala Live FAQ
      • Errors and Error Handling
        • Errors and Error Handling Overview
        • Handling Errors for Player V4 Using JavaScript
        • Player V3 Errors Overview (Deprecated)
          • Handling Errors for an HTML5 Player V3 Using JavaScript (Deprecated)
          • HTML5-based Player V3 Error Messages (Deprecated)
          • Flash-based Player V3 Error Messages (Deprecated)
          • Player Errors from Other Sources (Deprecated)
        • Dealing with Android Mobile SDK Errors
        • Dealing with iOS Mobile Errors
        • Ingestion Log
      • Country and Location Codes
      • DMA Codes
      • Universal Syndication Template Language
      • Troubleshooting
    • Using the Ooyala Help Center
    • Glossary
    • PDFs
  • Developer Guide
    • Ingestion
      • About Ingesting Content
      • Ways to Ingest Content
        • Uploading to Backlot
          • Ingesting with the Backlot UI
          • Ingesting with the Backlot API
        • Ooyala Ingestion Service (OIS)
          • Ingesting with FTP / FTPS
          • Ingesting with Aspera
          • Ingesting from a Remotely Hosted MRSS Feed
          • Ooyala Ingest Server Endpoints
          • Manifest File Formats
            • CSV Manifest File
            • XML Manifest File
            • Updating Asset Metadata Using CSV or XML Manifest Files
          • Dynamic Manifests
          • Ingestion Log
      • Ingesting Closed Caption Files
      • Ingesting Remote Assets
        • Ingesting Remote Assets via MRSS
        • Adding a Remote Asset in Backlot
        • Adding a Remote Asset Using the Backlot REST API
      • Content Migration
      • Integrate with NewZulu
      • Integrate with Avid Technologies
      • Ingestion Release Notes
    • Backlot Asset Management
      • Getting Started with Backlot
        • Getting Set Up
        • Publishing a Video
        • Watching a Video
        • Next Steps
      • Planning and Setup Guide
        • Introduction
          • Features
        • Before Uploading Content
          • Account Configuration
          • Content Organization
          • Content Upload and Management
        • Account Configuration
          • Transcoding Setup
            • Ooyala Transcoding Service (OTS)
              • Express Processing Assets
            • Delivery Protocols
            • Encoding Settings
            • Processing Time
            • Encoding Recommendations for Player V4
            • Encoding Recommendations for Player V3 (Deprecated)
            • How Flash Players Choose a Stream
            • Ooyala Transcoding Service (OTS) Release Notes
          • Managing Users
            • Adding a User
            • Editing User Settings
            • Deleting a User
      • Using the Backlot REST API
        • Common Deployment Architecture: Multiple Tiers
        • Best Practices
        • Advice for Web Programming
        • REST Overview
        • Character Encoding and MIME Types
        • API Server Endpoints
        • Your API Credentials
        • General Algorithm for Signing Requests
        • Setting an Expiration Time on Requests
        • API Ping URL
        • Practice Making Requests with the Scratchpad
        • Wrapper SDKs/API Libraries
        • API Rate Limiting
        • High Performance API Endpoint
        • JSONP
        • HTTP Response Codes
        • How to Export Your Data With the v2 Analytics API (Deprecated)
        • API Reference
      • Managing Assets
        • Types of Assets and Correlation to /v2/assets Qualifiers
        • Creating an Asset: POST
        • Viewing Asset Information: GET
        • Editing Asset Information: PATCH
        • Deleting an Asset: DELETE
        • Common Tasks with All Assets: PUT or PATCH and Qualifiers
          • Setting an Asset's Post-processing Status
          • Working with Labels
          • Applying Ad Sets
          • Assigning Publishing Rules to Assets
          • Searching for Assets
          • Managing Custom Metadata
            • Adding Custom Metadata
            • Deleting Custom Metadata
          • Managing Closed Captions
            • About Closed Captions
            • Ingesting Closed Caption Files
              • Uploading a Closed Caption File in Backlot
              • Ingesting Closed Captions Using XML Manifest Files
              • Ingesting Closed Captions Using CSV Manifest Files
            • Deleting a Closed Caption File
          • Using External Identifiers
            • Creating an Asset with an External ID
            • Adding an External ID to an Existing Asset
        • Video
          • VR 360 Videos
          • Quality of and Recommendations on Source Material (Video and Audio)
          • Uploading a Video or Audio Asset: Four Steps
          • Auto-generated Preview Images (Thumbnails)
          • Managing the Preview Image
          • Viewing Video Stream Information
          • Viewing Source File Information
        • Live Streams (Deprecated)
          • Adding a Live Stream
          • Setting Up an Encoder
        • Remote Assets
          • Remote Assets
          • Adding a Remote Asset Using the Backlot REST API
          • Ingesting Remote Assets via MRSS
        • YouTube Videos
          • Uploading a YouTube Video
          • Making Remote Assets Available on YouTube
        • Channels and Channel Sets (Deprecated)
          • Creating a Channel (Deprecated)
          • Viewing and Editing Channel Information (Deprecated)
          • Adding Videos to a Channel (Deprecated)
          • Creating a Channel Set (Deprecated)
          • Editing a Channel Set (Deprecated)
          • Adding Channels to a Channel Set (Deprecated)
        • Alternative Routes
      • Monetization
        • Monetization and the API
        • Advertising
          • Working with Your Own Ad Assets, Ad Sets, and Ad Sources
            • Uploading a Video Advertisement
            • Ad Sets
            • Creating an Ad Set
            • Adding a Video Ad to an Ad Set
            • Creating Ad Sets for Integrating with Ad Sources
            • Insert Tracking Pixel URLs
            • Deleting an Ad from an Ad Set
            • Deleting an Ad Set
        • Paywall Integration
          • Integrate with the Piano Go Paywall
          • Integrate with the Cleeng Paywall
        • Monetizing Your Ooyala Content with DFP
      • Content Publishing
        • Manual Publishing
          • Manually Embedding an Asset
        • Syndication
          • Creating a Syndication
          • Editing a Syndication
          • Viewing a Syndication
          • Deleting a Syndication
          • Access Key Restrictions
            • Turn on Access Keys
            • Creating an Access Key
            • Viewing Access Keys
            • Remove an Access Key
          • Specific Syndications
            • Live Stream Syndication
            • Syndication with YouTube
              • Handling CAPTCHA Challenges from YouTube
              • Setting Privacy and Other Considerations for YouTube Syndication
            • Syndication with Roku Direct Publisher
        • Publishing Rules
          • Creating Publishing Rules
          • Editing Publishing Rules
          • Deleting Publishing Rules
        • Labels
          • Creating Labels
          • Deleting Labels
          • Working with Labels
        • Universal Syndication
          • Creating a Simple Custom XML Syndication
      • Sample Code for Signing Requests
        • Sample Signature Code (Ruby)
        • Sample Signature Code (Java)
        • Sample Signature Code (PHP)
        • Sample Signature Code (C#)
        • Sample Signature Code (Python)
        • Sample Signature Code (Objective C)
      • Backlot REST API
        • About the Backlot REST API
        • HTTP Response Codes
        • Assets
          • Routes and Attributes Common to All Asset Types
          • Asset Properties by Asset Types
          • Types of Assets and Correlation to /v2/assets Qualifiers
          • Video and Audio Assets
          • Remote Assets
            • Adding URLs for an Asset
          • Uploading VR 360 Content
          • Live Streams (Deprecated)
          • YouTube Assets
          • Channel and Channel Set Assets (Deprecated)
          • Custom Metadata
          • Working with Closed Captions
          • Associate Ad Sets with Assets
          • Associate Publishing Rules with Assets
          • Associate Labels with Asset
          • Associate Player with Asset
          • Query Construction
          • Deleted Assets
          • DRM Attributes for Remote Assets (Including Live Streams)
        • Labels
        • Players (Backlot REST API)
          • Managing Players Using the Backlot REST API
          • Upload a Watermark Image Using the Backlot REST API
          • Upload Player Scrubber Image for Player V3 (Deprecated)
          • Managing Player Custom Metadata Using the Backlot REST API
          • Managing Player V3 Third-Party Modules Using the Backlot REST API (Deprecated)
          • Playlists
          • Cross-Device Resume: Getting the Playback Position Using the Backlot REST API
        • Ad Sets
        • Publishing Rules
        • Configurable DRM
          • DRM Policies
          • Associate DRM Policy with an Account
          • Associate DRM Policy with an Asset
        • Syndications
        • Country and Location Codes
      • Discovery REST API Reference
        • About Paging the Results from Ooyala Discovery
        • Discovery Profiles
        • Trending and Popular Content
        • Similar Videos
        • Providing Feedback
      • Ooyala Schedule
        • Tracks
        • Track Segments
        • Virtual Assets
      • Ooyala Backlot Release Notes
    • Player
      • Player V4
        • Ooyala Player V4 Release Notes
        • Introducing Player V4
          • Player V4 FAQ
          • User Interface for the Player V4 Skin
            • Variable Speed and Skip Controls
          • Supported Browsers and Operating Systems for Player V4
          • System Requirements by Platform for Player V4
          • Functional Support Across Environments for Player V4
          • Integrations in Player V4
        • Getting Started with Player V4
          • Prerequisites for Using Player V4
          • Basic Tutorial for Player V4
        • Migrating to Player V4
          • Migrating from Player V3
          • Differences Between Player Versions
          • Player Migration FAQ
        • Embedding Player V4 on a Web Page
          • Player V4 Plugins
          • Specifying Plugins for the Standard Embed Code
          • Ooyala-hosted Player V4 Resources
          • Hosting Player V4 Resources
          • Cross-Origin Resource Sharing (CORS)
          • Basic Embedding Information
          • Loading Video Plugins
          • Using Flash-free Playback with Player V4
          • Embedding Player V4 in an HTML iframe
          • Playing YouTube Videos in Player V4 (Deprecated)
          • Page-level Parameters for Player V4
          • Examples of Player V4 Web Page Embedding
        • Embedding Player V4: Best Practices
          • Embedding Player V4: General Recommendations
          • Embedding Player V4: Optimizing for Page Load
          • Embedding Player V4: Optimizing for Player Load
          • Embedding Player V4: Optimizing for Stream Loading
          • Embedding Player V4: Performance Troubleshooting
          • Embedding Player V4: A Note About Performance Optimization
        • Customizing the Player V4 Appearance
          • Order of Precedence in Player V4 Settings
          • Customizing the Player V4 Skin with skin.json
          • Variable Speed and Skip Controls
          • Customizing the Player V4 Appearance Using CSS
          • Customizing Player V4 Controls with Graphics
          • Setting the Language for the Ooyala Player
          • Player V4 Skin and the React Application Framework
          • Closed Captions in Player V4
          • Customizing VR 360 Player Controls
          • Adding a Custom Branding Overlay to Player V4
        • Discovering Content in Player V4
        • Using Playlists in Player V4
        • Ads in Player V4
          • FreeWheel Ad Plugin
            • Integrating FreeWheel Ads
            • FreeWheel Ad Parameters
          • Google IMA Ad Plugin
            • Integrating Google IMA Ads
            • Google IMA Ad Parameters
          • Ooyala Pulse Ad Plugin
            • Integrating Ooyala Pulse Ads
            • Ooyala Pulse Ad Parameters
          • VAST and VPAID Ad Plugin
            • Integrating VAST and VPAID Ads
            • VAST and VPAID Ad Parameters
          • Integrating Ads
            • Ads Integration Workflow
            • Integrating Multiple Ad Managers
            • Configuring Ad Parameters
            • Ads and Live Streams
          • Delivering My Ads
          • About Ads
            • Ad Manager Framework
            • Ad Types
            • Ad-Related Events
        • Analytics in Player V4
          • Adobe Analytics (Omniture) Plugin
          • comScore Analytics Plugin
          • Conviva Analytics Plugin
          • Google Analytics Plugin
          • Nielsen Analytics Plugin
          • YOUBORA Analytics Plugin
          • Analytics Framework
        • Player V4 JavaScript API
          • About the Player V4 JavaScript API
          • Programming Closed Captioning Using Player V4 JavaScript
          • Event Model for Player V4
            • Message Bus API
            • Player V4 Message Bus Events
            • Event Publish and Subscribe
            • Listening to a Message Bus Event
            • Listening to Multiple Message Bus Events
            • Writing to the Message Bus
            • Information with Listeners and Method Calls
          • Programming Bitrates and Buffering for Player V4 Using JavaScript
          • Handling Errors for Player V4 Using JavaScript
          • Debugging Player V4
        • Using Ooyala Player V4 with Accelerated Mobile Pages (AMP)
        • Enabling Chromecast in the Ooyala HTML5 Player
        • Using Player V4 in Facebook Instant Articles
        • Introduction to HEVC Streams with Ooyala
          • Considerations for HEVC
          • Configuring the Ooyala Player for HEVC Playback
          • How the Ooyala Player Selects HEVC Streams
          • HEVC and IQ Analytics
        • Introduction to Enabling Videos with Multiple Audio Streams
          • Source File Formats Supported for Multi-Audio Encoding
          • Uploading Content For Multi-Audio Streams
          • Setting up the Processing Profile for Multi-Audio
          • Recommended Encoding Profile for Multi-Audio Streams
          • Configuring the Ooyala Player for Multi-Audio Playback
          • Setting the Default Audio Track
          • Changing the Audio Track (User Controls)
          • How Audio Track Labels are Displayed in Player
          • Multi-Audio and IQ Analytics
        • Introduction to Audio-Only Player
          • Audio-Only Player: Supported Environments, Formats, and Outputs
          • Audio-Only Player: Asset Processing
          • Audio-Only Player: Player Setup
          • Configuring Audio-Only Streaming on Mobile SDK for iOS and Android
    • Mobile Platform Development
      • Mobile SDK for Android
        • Mobile SDK for Android Release Notes
        • About the Mobile SDK for Android
          • Features of the Mobile SDK for Android
          • Upgrading the Mobile SDK for HLS Playback
          • Downloading the Mobile SDK
          • Reference Documentation for the Mobile SDK
          • Supported Configurations for Android
          • Setting Permissions for Android Apps
          • Required Skills
          • General Design of the SDK
          • Introduction to Offline Playback: Download to Own (DTO) and Rentals (DTR)
          • About Access Control
        • Getting Started with the Ooyala Android SDK
          • Getting Started: Setting Up Your Environment in Android Studio
          • Getting Started: Enabling Upgrade for HLS Playback
            • Overriding the Default VisualOn Library For Android Apps
          • Creating a Basic Android App
          • Sample Applications for the Android Mobile SDK
        • Player Skin for Android
          • Getting Started with the Skin Sample Application for Android
          • Updating an Existing Application with the Android Skin
          • Customizing the Player V4 Appearance
            • Player V4 Skin and the React Application Framework
            • Customizing the Player V4 Skin with skin.json
            • Setting the Language for the Ooyala Player
        • Working with the Android SDK
          • Layout Controls
            • Preventing Restart on Tilt
            • Preventing Screen Blackout/Flicker
            • Implementing Custom Controls for Android
          • Working with Events
          • Implementing EmbedTokenGenerator for Android
          • Offline Playback: Download to Own (DTO) and Rentals (DTR) for Android
          • Dealing with Android Mobile SDK Errors
          • About Network Timeouts
          • Configuring the Ooyala Player Options
            • Working with Closed Captions for Android
              • Required Closed Caption Setup in Backlot
              • Fundamental CC Methods on Android
              • Android FCC 708 Closed Captions Compliance
            • About using Android FCC Ratings
              • Android FCC Rating Configuration Parameters
              • Enabling TV Ratings for Android Assets
              • TV Ratings Backlot Metadata Configurations
            • Customizing Player Information
          • Localizing the User Interface
          • Cross-device Resume (XDR) with the Mobile SDK
          • Working with Multi-Resolution Players on Widevine
          • About Discovery for Android Native Apps
            • Get Discovery Results for Android Native
            • Send Discovery Click Notifications for Android Native
            • Send Discovery Impressions for Android Native
          • Implementing Performance Monitoring For Android Apps
        • Android Third Party Integrations
          • Integration with Ooyala Pulse on Android
            • Parameters for Ooyala Pulse on Android
          • About VisualOn Integrations
            • About PlayReady for Mobile Apps (Disabled)
              • Configuring PlayReady for Android Apps (Disabled)
            • Configuring VisualOn Live Scrubbing
              • Disabling the Live Scrubber
          • Integration with Omniture on Android
          • Integration with Google IMA on Android
            • See the IMA Sample App in Action on Android
            • A Closer Look at the Android Sample App
            • Overriding the Ad Tag URL on Android
          • Integration with FreeWheel on Android
            • Cuepoint Markers
            • See the FreeWheel Sample App in Action on Android
            • A Closer Look at the Android Integration Sample App
          • Ooyala QoS Solution Powered by NPAW's YOUBORA
            • Using the QoS Solution Powered by NPAW for Android
          • Integration with Nielsen Analytics
            • Nielsen Integration Requirements
            • Integrating with Nielsen on Android
            • How Nielsen Integration Works
          • Integrating 3rd Party Ad Plugins
          • Integration with Google ExoPlayer on Android
          • Integration with Amazon Fire TV on Android
        • Android Mobile SDK API Reference
      • Mobile SDK for iOS
        • Mobile SDK for iOS Release Notes
        • About the Ooyala Mobile SDK for iOS
          • Supported Configurations for iOS
          • Required Skills
          • General Design of the SDK
          • Reference Documentation for the Mobile SDK
          • About Access Control
          • Integrations
          • Introduction to Offline Playback: Download to Own (DTO) and Rentals (DTR)
        • Getting Started with the Ooyala Mobile SDK for iOS
          • About Cocoa Pods
            • Using CocoaPods
            • Testing the Ooyala CocoaPods Tutorial
          • Getting Started: Setting Up Your Environment in Xcode
          • Getting Started: iOS Sample Application
          • Sample Applications for the iOS Mobile SDK
        • Player Skin for iOS
          • Getting Started with the Sample Application for iOS
          • Updating an Existing Application with the iOS Skin
          • Customizing the Player V4 Appearance
            • Player V4 Skin and the React Application Framework
            • Customizing the Player V4 Skin with skin.json
            • Setting the Language for the Ooyala Player
        • Working with the Ooyala Mobile SDK for iOS
          • Layout Controls
            • About Custom Controls for iOS
            • Implementing Inline Custom Controls for iOS
            • Customizing the Scrubber for iOS playback
          • Working with Events
          • Offline Playback: Download to Own (DTO) and Rentals (DTR) for iOS
          • Dealing with iOS Mobile Errors
          • Configuring the Ooyala Player Options
            • Working with Closed Captions for iOS
              • Required Closed Caption Setup in Backlot
              • Fundamental Closed Caption Functions on iOS
              • Implementing an iOS OOEmbedTokenGenerator
              • iOS FCC 708 Closed Captions Compliance
            • Working with FCC Ratings for iOS
              • iOS FCC Rating Configuration Parameters
              • Enabling TV Ratings for iOS Apps
              • TV Ratings Backlot Metadata Configurations
          • Localizing the User Interface
          • About Discovery for iOS Native Apps
            • Get Discovery Results for iOS Native
            • Send Discovery Click Notifications for iOS Native
            • Send Discovery Impressions for iOS Native
          • Implementing Performance Monitoring For iOS Apps
        • iOS Third Party Integrations
          • Integration with Ooyala Pulse on iOS
            • Parameters for Ooyala Pulse on iOS
          • Integration with FreeWheel on iOS
            • Cuepoint Markers
            • See the FreeWheel Sample App in Action on iOS
            • A Closer Look at the iOS Sample App and Integrations
            • Inserting Ads Dynamically
          • Integration with Google IMA on iOS
            • See the IMA Sample App in Action on iOS
            • A Closer Look at the iOS Sample App and Integration
            • Overriding the Ad Tag URL on iOS
            • Setting the Default Browser for Learn More Events
          • Integration with Omniture on iOS
          • Working with Multi-Resolution Streams on Widevine
          • Working with AirPlay and Widevine Encrypted Assets
          • Configuring PlayReady for iOS Apps (Disabled)
          • Cross-device Resume (XDR) with the Mobile SDK
          • XTV Connect SDK for iOS
            • Create an iOS Development Project for XTV
            • Using XBMC to Configure and Test DLNA Playback
          • Ooyala QoS Solution Powered by NPAW's YOUBORA
            • Using the QoS Solution Powered by NPAW for iOS
          • Integration with Nielsen Analytics
            • Nielsen Integration Requirements
            • Integrating with Nielsen on iOS
            • How Nielsen Integration Works
          • Integrating 3rd Party Ad Plugins
        • iOS Mobile SDK API Reference
      • Mobile SDK for tvOS
        • Integrating with Ooyala Pulse on tvOS
          • Parameters for Ooyala Pulse on tvOS
      • Cross-device Resume (XDR)
        • High-level Steps and Server Architecture for XDR
        • Server-to-Server: Getting the Playback Position
        • Server-side Formatting the Ooyala Player Token String
        • Resuming Playback in Your Application
          • Starting Playback at Specific Position: Mobile SDK for iOS
          • Starting Playback at Specific Position: Mobile SDK for Android
          • Starting Playback at Specific Position: Player V3
    • Ooyala IQ Analytics
      • Ooyala IQ Release Notes
      • Overview
        • v3 Analytics Best Practices
        • Common Metric Definitions and Examples
        • API Server Endpoints
        • Practice Making Requests with the Scratchpad
      • Using Ooyala IQ with Third-Party Players
        • Ooyala IQ Account Management
        • Syncing Third-Party Metadata with Ooyala IQ
        • Integrating Third-Party Players with IQ Using the JS SDK
          • Integrating JW Player with IQ Using the JS SDK
          • Integrating Brightcove Player with IQ Using the JS SDK
          • Integrating FlowPlayer with IQ Using the JS SDK
          • Integrating Kaltura Player with IQ Using the JS SDK
          • Integrating an HTML5 Video Tag with IQ Using the JS SDK
          • Integrating YouTube Player with IQ Using the JS SDK
          • Integrating Xbox One Video App with IQ Using the JS SDK
        • Integrating Third-Party Players with IQ Using the JSON API
          • Ooyala IQ SDK for Roku Integration
      • v3 Analytics Reporting API
        • v3 Analytics Reporting API Syntax
        • Setup/Mechanics for the v3 Analytics Reporting API
          • Your API Credentials
          • General Algorithm for Signing Requests
          • Setting an Expiration Time on Requests
          • Character Encoding and MIME Types
        • Preprogrammed Report Types
      • v3 Analytics Reporting API Request Examples
        • How Are My Different Brands Performing?
        • What Geographies Are Driving My Content Traffic?
        • What Filters Can I Use?
        • How Can I Make a Long and Detailed Query?
        • API Requests: v2 Analytics and v3 Analytics Comparison (Deprecated)
        • How Can I Query Unlimited Asset Data?
      • Parameter Reference
        • Reporting Query String Parameters
        • Dimensions
        • Metrics
        • Filters
        • Codes for Platforms, Devices, and Operating Systems
        • Country and Location Codes
      • HTTP Response Codes and Messages
      • Analytics Glossary
    • Quality of Service Analytics
      • Ooyala QoS Solution Powered by NPAW's YOUBORA
        • Using the QoS Solution Powered by NPAW for Desktop
        • Using the QoS Solution Powered by NPAW for Android
        • Using the QoS Solution Powered by NPAW for iOS
        • Enabling Third Parties to Pass Parameters to YOUBORA
    • Ooyala Live
    • Content Protection and Entitlements
      • Content Protection Overview
        • Content Protection Feature Support Matrix
        • Protecting Your Content
        • Planning for Content Protection
        • Survey of Content Protection Technology
          • Protected Streams
          • Playback Authorization, Including Token-based Authentication and Restrictions
          • Digital Rights Management (DRM) Systems
          • Content Protection Options By Device
        • Warning About Web Browser Third-party Cookies
      • Authentication
        • Ooyala Player Token for Player V3 (Deprecated)
          • Warning About Web Browser Third-party Cookies
          • Controlling Playback with the Ooyala Player Token
          • Ooyala Player Token Expiration
          • Setting the Ooyala Player Token
          • Using Ooyala Player Token with Ooyala iOS and Android SDKs
            • Implementing an iOS OOEmbedTokenGenerator
            • Implementing EmbedTokenGenerator for Android
        • Ooyala Player Token for Player V4
          • Constructing the URL Token Request
        • Akamai Secure Token
        • Adobe Pass Integration Reference
        • Ooyala Account Token API
      • Authorization
        • Player Authorization API for Player V4
        • Player Authorization API for Player V3
        • Limiting Concurrent Streams per Viewer
        • Enforcing Per-Studio Limits on Concurrent Streams
        • Stopping Unauthorized Streams
        • Authorization Errors
      • Access Control
      • Rights Management
        • Rights Locker
          • Prerequisites to Rights Locker
          • Key Concepts
          • Your Users, Your Accounts: Security
          • How Authorization Works
          • Backlot Setup
          • Extended Example of Rights Locker
        • Binding Viewer Devices to Entitlements
      • Device Registration
        • Device Registration API
          • Properties for Device Registration
          • Device Management API for User Portals
          • Device Registration API for Customer Support Portals
      • Digital Rights Management
        • DRM Attributes for Remote Assets (Including Live Streams)
        • Apple FairPlay
        • Widevine Modular Content Protection
        • PlayReady Content Protection
          • PlayReady Workflow
          • PlayReady Example
        • Adobe Access DRM (Deprecated)
        • Configurable DRM
          • Assigning DRM Policies
          • Deleting DRM Policies
    • Content Discovery and Recommendations
      • About Discovering and Recommending Content
      • Configuring Discovery in the Backlot UI
      • Discovery Design Considerations
      • Discovery Best Practices
      • Discovery Profiles
        • Managing Discovery Profiles
        • Comparison of Discovery Profile Settings in Backlot UI and API
        • About Creating and Managing Profiles with the Backlot UI
        • Creating Discovery Profiles Using the Backlot UI
        • Managing Discovery Profiles with the Discovery API
          • Viewing a Discovery Profile
          • Updating a Discovery Profile
          • Using a Defined Discovery Profile on API Requests
          • Enabling / Disabling a Discovery Profile for a Player
      • Discovery Feedback Loop
        • Using the Feedback Loop Routes
        • Returning Impression Events
        • Returning Click Events
      • Discovery Insights Reports (No Longer Available)
        • Discovery Plays Report: Leaderboard 1 (No Longer Available)
        • Discovery Leads Report: Leaderboard 2 (No Longer Available)
        • Discovery Time Lift Report (No Longer Available)
        • Discovery Lift Report (No Longer Available)
        • Discovery CTR (Click Through Rate) Report (No Longer Available)
        • Discovery UI CTR Report for API Usage (Deprecated)
      • Discovery REST APIs
        • Summary of Ooyala Discovery REST API Requests
        • Trending Content Recommendations
        • Related Content Recommendations
        • Similar Assets Recommendations
        • Discovery Editorial Query String Parameters
          • Filtering Results: filter_by
          • Specifying Sequential Relationships: union
        • Top Titles
          • Using Top Titles
          • Top Titles Route Parameters
        • Discovery REST API Reference
          • About Paging the Results from Ooyala Discovery
          • Discovery Profiles
            • Creating a Discovery Profile
            • Route Attributes
            • Discovery Player Properties
            • Discovery Profile API Examples
              • Updating a Discovery Profile
              • Turning on the Pause Screen
              • Enabling and Disabling Discovery Profiles for a Player
              • Using a Previously Created Discovery Profile
              • Viewing Discovery Profile Information
              • Deleting a Discovery Profile
              • Hiding Thumbnails
              • Setting the Default Countdown
              • Filtering with Labels
          • Query String Parameters
          • Trending and Popular Content
          • Similar Videos
          • Providing Feedback
      • Watchlist REST APIs
        • About Watchlists
        • Getting Started with Watchlists
        • Watchlist REST API Reference
          • Create a Watchlist
          • Get All Watchlists Belonging to a User
          • Change the Watchlist Name
          • Delete a Watchlist
          • Add an Item to a Watchlist
          • Move an Item's Position in a Watchlist
          • Delete an Item from a Watchlist
          • Get All Items from a Watchlist
    • Monetization
      • Client Side Ad Integration
        • Supported Ad Providers
        • Advertising
        • Ad Sets
        • Working with Your Own Ad Assets, Ad Sets, and Ad Sources
        • Ads Integration with Backlot and Backlot REST API
          • Backlot
            • Uploading a Video Advertisement
            • Creating an Ad Set
            • Applying an Ad Set to a Video
            • Deleting an Ad from an Ad Set
            • Deleting an Ad Set
          • Backlot REST API
            • Ad Sets
            • Creating Ad Sets for Integrating with Ad Sources
            • Associate Ad Sets with Assets
        • Player V4 Ad Integration
        • Mobile SDK Ad Integration
      • Server Side Ad Insertion
      • Paywall Integration
        • Integrate with the Piano Go Paywall
        • Integrate with the Cleeng Paywall
    • Social Media Integrations
      • Integration with Twitter Player Cards
        • SSL Required for All Content
        • Creating an Ooyala Player Twitter Card
          • Manually Getting Twitter <meta> Tags for Ooyala Player
          • Creating a Sample Web Page
          • Requesting Approval from Twitter
          • Approach to Automating Creation of Twitter Web Pages
        • Advanced Player Options in Twitter Cards
          • Example: Passing Multiple IMA Ad Tags for Pre-roll
      • Sharing Video on Facebook
        • Development Requirements
        • Active Sharing
          • Active Sharing Setup
        • Passive Sharing
          • Creating a Facebook App
          • Configuring the Facebook App
          • Passive App Setup
          • Getting the Viewer to Accept Your App
    • Device Integration
      • Chromecast Integration
        • Introduction to Chromecast Integration
        • Compatibility
        • Enabling Chromecast in the Ooyala HTML5 Player
        • Integrating with Chromecast
          • Integration Overview
          • Requirements for Chromecast Integration
          • Build a Sender Application for iOS
          • Build a Sender Application for Android
          • Build a Chromecast Receiver Application
        • Sample Sender Application for iOS
        • Sample Sender Application for Android
        • Using Closed Captions with Chromecast Integration
        • Analytics for Chromecast Integration
      • Chromecast and Ooyala (Deprecated)
        • Chromecast Sender Application
        • Chromecast Receiver Application
        • Chromecast Supported Platforms
        • Chromecast Supported Features
          • Chromecast Device Registration and Concurrent Stream Limit
          • Chromecast Receiver Stream Selection
          • Chromecast Closed Captions
          • Cast and Play vs. Play and Cast
          • Chromecast Integration Analytics
          • Chromecast Communication Protocol
        • Chromecast Integration Prerequisites
          • CORS and Chromecast
        • iOS Sample App for Chromecast
        • Android Sample App for Chromecast
        • Getting Started with Chromecast
          • Creating an Integrated Android Sender Application
            • Configuring the Chromecast Mini Controller for Android
          • Creating an Integrated iOS Sender Application
            • Configuring the Mini Controller (Default) for iOS
          • Creating an Integrated Receiver Application for Chromecast
          • Casting a Video
        • Customizing the Sender Application for the Ooyala Chromecast Integration
          • Customizing an Android Sender Application
          • Customizing the iOS Sender Application
          • Understanding Notifications
        • Customizing the Receiver Application for the Ooyala Chromecast Integration
          • Starting the Cast Receiver Manager
          • Setting Up the Cast Receiver Manager
          • Setting Up the Cast Message Bus
          • Customizing the Chromecast Receiver User Interface
          • Error Handling
          • Modifying Chromecast Constants
        • Debugging a Chromecast Application
        • Chromecast Integration Glossary
    • API References
      • Backlot REST API
        • About the Backlot REST API
        • HTTP Response Codes
        • Assets
          • Routes and Attributes Common to All Asset Types
          • Asset Properties by Asset Types
          • Types of Assets and Correlation to /v2/assets Qualifiers
          • Video and Audio Assets
          • Remote Assets
            • Adding URLs for an Asset
          • Uploading VR 360 Content
          • Live Streams (Deprecated)
          • YouTube Assets
          • Channel and Channel Set Assets (Deprecated)
          • Custom Metadata
          • Working with Closed Captions
          • Associate Ad Sets with Assets
          • Associate Publishing Rules with Assets
          • Associate Labels with Asset
          • Associate Player with Asset
          • Query Construction
          • Deleted Assets
          • DRM Attributes for Remote Assets (Including Live Streams)
        • Labels
        • Players (Backlot REST API)
          • Managing Players Using the Backlot REST API
          • Upload a Watermark Image Using the Backlot REST API
          • Upload Player Scrubber Image for Player V3 (Deprecated)
          • Managing Player Custom Metadata Using the Backlot REST API
          • Managing Player V3 Third-Party Modules Using the Backlot REST API (Deprecated)
          • Playlists
          • Cross-Device Resume: Getting the Playback Position Using the Backlot REST API
        • Ad Sets
        • Publishing Rules
        • Configurable DRM
          • DRM Policies
          • Associate DRM Policy with an Account
          • Associate DRM Policy with an Asset
        • Syndications
        • Country and Location Codes
      • v3 Analytics (Ooyala IQ) API
        • Parameter Reference
          • Reporting Query String Parameters
          • Dimensions
          • Metrics
          • Filters
          • Codes for Platforms, Devices, and Operating Systems
          • Country and Location Codes
        • HTTP Response Codes and Messages
        • v3 Analytics Reporting API Request Examples
          • How Are My Different Brands Performing?
          • What Geographies Are Driving My Content Traffic?
          • What Filters Can I Use?
          • API Requests: v2 Analytics and v3 Analytics Comparison (Deprecated)
      • Player V3 JavaScript API Reference (Deprecated)
        • Overview of the Player V3 JavaScript API
        • Player V3 JavaScript API Functions
        • Player V3 JavaScript API Parameters (Deprecated)
          • Player V3 Query String Parameters (Deprecated)
          • Player V3 Embedded Parameters (Deprecated)
          • Player V3 Embedded Parameters for Custom Modules (Deprecated)
          • Player V3 Embedded Parameters for Ads (Deprecated)
            • In-Stream Ads Embedded Parameter in Player V3 (Deprecated)
            • FreeWheel Ads Embedded Parameter in Player V3 (Deprecated)
            • Google IMA Ads Embedded Parameters in Player V3 (Deprecated)
            • LiveRail Ads Embedded Parameters in Player V3 (Deprecated)
            • VAST Ads Embedded Parameters in Player V3 (Deprecated)
            • VPAID Ads Embedded Parameters in Player V3 (Deprecated)
        • Player V3 Message Bus Events (Deprecated)
        • Flash-based Player V3 Error Messages (Deprecated)
      • Authorization API Reference
        • Authorization API
        • Player Authorization API for Player V3 (Deprecated)
        • Player Authorization API for Player V4
      • Rights Locker API Reference
        • Rights Locker
        • Rights Locker API Reference
      • Usage RESTful API
    • General Reference
      • Frequently Asked Questions
        • Ad Integration FAQ
        • Ooyala IQ (Analytics) FAQ
        • Ooyala IQ Data Retention Policy FAQ
        • API and SDK FAQ
        • Discovery FAQ
        • External Publishing FAQ
        • Player V4 FAQ
        • Player V3 FAQ (Deprecated)
        • Player Security FAQ
        • Quality of Service FAQ
        • Uploading FAQ
        • Ooyala Live FAQ
      • Errors and Error Handling
        • Errors and Error Handling Overview
        • Handling Errors for Player V4 Using JavaScript
        • Player V3 Errors Overview (Deprecated)
          • Handling Errors for an HTML5 Player V3 Using JavaScript (Deprecated)
          • HTML5-based Player V3 Error Messages (Deprecated)
          • Flash-based Player V3 Error Messages (Deprecated)
          • Player Errors from Other Sources (Deprecated)
        • Dealing with Android Mobile SDK Errors
        • Dealing with iOS Mobile Errors
        • Ingestion Log
      • Country and Location Codes
      • DMA Codes
      • Universal Syndication Template Language
      • Troubleshooting
      • Glossary
    • Supported Standards
      • Supported Ingest Formats
      • Supported Output Formats
      • Supported Content Types
      • Supported Closed Captions
      • Supported Closed Caption DFXP (now TTML) Format
      • Supported Ad Providers
      • Server Side Ad Insertion
      • Functional Support Across Environments for Player V4
      • Supported Streams for Player V4
      • Supported Browsers and Operating Systems for Player V4
      • System Requirements by Platform for Player V4
      • Player V3 Functional Support Across Environments (Deprecated)
      • Player V3 System Requirements by Platform (Deprecated)
      • Player V3 Maximum Bit Rate for the Flash Player (Deprecated)
    • Archive
      • v2 Analytics (Deprecated)
        • Migrating from v2 Analytics (Deprecated)
          • v2/v3 Fundamental Difference: Multidimensional Analysis (Deprecated)
          • Data Migration (Deprecated)
          • How to Export Your Data With the v2 Analytics API (Deprecated)
          • Potential Differences in the Data (Deprecated)
          • Analytics Graphical User Interface (GUI) Differences (Deprecated)
          • v3 Analytics API Differences (Deprecated)
          • Certain "Unique" Metrics Confusing in v2 Analytics (Deprecated)
          • API Requests: v2 Analytics and v3 Analytics Comparison (Deprecated)
        • Converting Analytics JSON to CSV (Deprecated)
        • How to Export Your Data With the v2 Analytics API (Deprecated)
        • Getting the Data Underneath the Analytics Displays (Deprecated)
        • Device Type Mapping (Deprecated)
        • Custom Analytics (Deprecated)
          • Working with Custom Analytics (Deprecated)
          • Recording Facebook Data within Custom Analytics (Deprecated)
        • v2 Analytics API (Deprecated)
          • Considerations about the Analytics API (Deprecated)
          • Displays, Plays, and Play Starts (Deprecated)
          • How to Export Your Data With the v2 Analytics API (Deprecated)
          • Performance (Deprecated)
          • Sharing (Deprecated)
          • Engagement (Deprecated)
          • Delivery (Deprecated)
          • Custom Analytics: Tags (Deprecated)
          • Custom Analytics: Reporting (Deprecated)
          • Common Attributes and Query String Parameters (Deprecated)
      • Ooyala API V1 (Deprecated) to API V2 Migration
        • Attribute Update API (Deprecated)
        • Custom Metadata API (Deprecated)
        • Label Management API (Deprecated)
          • Labels Management: List (Deprecated)
          • Labels Management: Create (Deprecated)
          • Labels Management: Delete (Deprecated)
          • Labels Management: Assign (Deprecated)
          • Labels Management: Rename (Deprecated)
        • Player Management API (Deprecated)
          • Player Management: List (Deprecated)
          • Player Management: Assign (Deprecated)
        • Channel API (Deprecated)
          • Channels: List (Deprecated)
          • Channels: Assign (Deprecated)
          • Channels: Create (Deprecated)
        • Channel Set API (Deprecated)
          • Channel Sets: List (Deprecated)
          • Channel Sets: Assign (Deprecated)
          • Channel Sets: Create (Deprecated)
        • Query API (Deprecated)
        • Thumbnail Query API (Deprecated)
      • Ooyala Backlot API Reference V1 (Deprecated)
        • Differences between API V1 (Deprecated) and API V2
        • Query API (Deprecated)
        • Thumbnail Query API (Deprecated)
        • Attribute Update API (Deprecated)
        • Custom Metadata API (Deprecated)
        • Label Management API (Deprecated)
        • Player Management API (Deprecated)
        • Channel API (Deprecated)
        • Channel Set API (Deprecated)
        • Dynamic Channel API (Deprecated)
        • High Performance API (Deprecated)
        • Backlot API Example Code (Deprecated)
        • Signature Generation (Deprecated)
      • Uploader JavaScript Library (Deprecated)
      • Deprecated: Upload Widget API v1 Reference (Deprecated)
        • Upload Widget Option Reference (Deprecated)
        • Adding Labels (Deprecated)
        • Signature Generation (Deprecated)
        • Widget Events (Deprecated)
        • Widget Functions (Deprecated)
        • Embedding the Ooyala Upload Widget (Deprecated)
        • Upload Completion Ping URL (Deprecated)
        • Upload API Example (Deprecated)
      • V2 Player APIs (Player V2 Deprecated)
        • V2 Player APIs by Language and Category (Player V2 Deprecated)
          • Player ActionScript APIs (Player V2 Deprecated)
            • ActionScript API Summary List (Player V2 Deprecated)
            • Ads ActionScript APIs (Player V2 Deprecated)
            • Assets ActionScript APIs (Player V2 Deprecated)
            • Bitrate and Buffer ActionScript APIs (Player V2 Deprecated)
            • Closed Captioning ActionScript APIs (Player V2 Deprecated)
            • Embed Code ActionScript APIs (Player V2 Deprecated)
            • Error ActionScript APIs (Player V2 Deprecated)
            • Player ActionScript APIs (Player V2 Deprecated)
            • ActionScript Examples (Player V2 Deprecated)
          • Player JavaScript APIs (Player V2 Deprecated)
            • JavaScript API Summary List (Player V2 Deprecated)
            • Ads JavaScript APIs (Player V2 Deprecated)
            • Assets JavaScript APIs (Player V2 Deprecated)
            • Bitrate and Buffer JavaScript APIs (Player V2 Deprecated)
            • Close Captioning JavaScript APIs (Player V2 Deprecated)
            • Embed Code JavaScript APIs (Player V2 Deprecated)
            • Error JavaScript APIs (Player V2 Deprecated)
            • Player JavaScript APIs (Player V2 Deprecated)
            • JavaScript Demo and Examples (Player V2 Deprecated)
          • HTML5 APIs (Player V2 Deprecated)
            • HTML5 API Summary List (Player V2 Deprecated)
            • Assets HTML5 APIs (Player V2 Deprecated)
            • Player HTML5 APIs (Player V2 Deprecated)
            • HTML5 Example and Demo (Player V2 Deprecated)
          • Query String and Pass-Through Parameters (Player V2 Deprecated)
            • Player Query String Parameters (Player V2 Deprecated)
            • Player Pass-Through Parameters (Player V2 Deprecated)
            • Ads Pass-Through Parameters (Player V2 Deprecated)
            • Query String Parameter Examples (Player V2 Deprecated)
        • V2 Player Examples Overview (Player V2 Deprecated)
          • ActionScript Examples (Player V2 Deprecated)
          • JavaScript Demo and Examples (Player V2 Deprecated)
          • HTML5 Example and Demo (Player V2 Deprecated)
          • Query String Parameter Examples (Player V2 Deprecated)
        • Flash-based Player Error Messages
      • Ooyala Discovery Queue (Deprecated)
        • Discovery Queue (Deprecated)
        • Managing Queues (Deprecated)
      • Widevine Classic (Deprecated)
        • Widevine Content Protection (Deprecated)
        • DRM Attributes for Remote Assets (Including Live Streams) (Deprecated)
    • PDFs

About the Backlot REST API

Welcome to the Backlot REST API.

Important: The topics in this section are being migrated to the Ooyala API Docs page.

This guide contains detailed information on each operation or route that can be performed using the Backlot REST APIs. See also the Backlot API Reference.

Parent topic: Backlot REST API
https://help.ooyala.com/sites/all/libraries/dita/en/video-platform/api/overview.html

Was this article helpful?

LEAVE FEEDBACK
Rate this article:
AAA
  • English
  • Español
  • 日本語
  • 한국의
Lookup: Ooyala Help Index ›

Documentation questions or comments? Leave feedback in our community forum.
For all other inquiries, go to to Customer Portal to login and file a ticket..

© 2019 Ooyala, Inc. • Website Privacy Policy • Terms of Service • All Rights Reserved