Platform API Code Samples This is a compilation of all platform API code samples for quick reference. You can also find links to the samples within the docs for each API. Concurrent Viewers for Live Events This sample uses the Get Live Analytics time-series endpoint of the Analytics API to generate a report on concurrent viewers for a live event based on different time intervals. Daily Analytics Report Generator Generate a daily analytics report on all the videos in an account for the earliest date that data is available to the current date, in CSV format. Destinations Report Generate two analytics reports: 1) a listing of all the URLs where videos have been viewed; 2) a listing of all your players where videos have been viewed, along with the domain the player resides on. Geographical Analytics Report Generate a report of views by country using the Analytics API Analytics by Country and Day In this sample, you will learn how to create a report showing the total video views by country for each day over a selected period. You can also filter the returned data by date and/or country. Video Engagement Graph Generate an engagement graph for a video in your account. Video Report by Player and Day In this example, we will create a report on all videos in the account, grouped by player. Unique Users by Day In this example, we will create a report on unique users and videos views by day for an account. Video Report by Tags In this sample, you will learn how to get reports on videos by the tags assigned to them and return the results in JSON or CSV format. Video Report by Reference ID This sample allows you to get reports on videos by the video reference ID. CMS API Tester Get started with the CMS API by looking at some of the common request types and the data they return. Add Custom Field to Multiple Videos In this sample, you will learn how to create a UI for custom fields and add a custom field to multiple videos. Analytics by Playlists In this sample, you will learn how to use the CMS API and Analytics API together to select a playlist from your account and get analytics data for all the videos in the playlist. Identifying Low-Performing Content In this sample, you will learn how to use the CMS API and the Analytics API together to compile a list of videos with less than five views over the past 1-6 months. Recently Added Videos In this sample, you will learn how to get Analytics data for videos that have been added to Video Cloud over some recent period (which you define in the inputs). Data Collection Sample In this sample, you will learn how to send information to the Data Collector so that you can get analytics data for videos that are not viewed in a Brightcove web or SDK player. Add Cue Points In this sample, you will learn how to add cue points to a video programmatically using the CMS API. Add Multiple Affiliate Accounts for Media Sharing This sample uses the CMS API via JavaScript and a proxy (PHP) to add multiple affiliate accounts for media sharing. Share Multiple Videos This sample uses the CMS API via JavaScript and a proxy (PHP) to share multiple videos with one or more affiliate accounts. Media Shared from Report This sample provides a report in CSV format on videos that have been shared from an account. Media Shared to Report This sample generates a report on all videos that were shared to a Video Cloud account. Update Videos In this sample, you will learn how to update metadata for multiple videos using the CMS Ingest API. Video Report Generator This sample uses the CMS API to generate a report on all the videos in your account in CSV format. It fetches the video data in batches of 100, so if there is an API timeout or some other error, you will still have some of the data. Update Geo Properties In this sample, you will learn how to update the geo-filtering properties for all videos in an account. Download Links In this sample, you will learn how to use the CMS API to generate a table of download links for the best MP4 renditions of your videos. RSS Podcast Feed for iTunes In this sample, you will learn how to use the CMS API to generate an RSS podcast feed for Apple iTunes. Video Sitemap Generator This sample demonstrates how you can generate a video sitemap using the CMS API. MRSS Feed from Playlist In this sample, you will learn how to use the CMS API to generate an MRSS feed based on MRSS specification. MRSS Generator In this sample, you will learn how to use the CMS API to generate an MRSS feed based on MRSS specification. Video Search App In this sample, you will learn how to create a video search application using the CMS API. To get access tokens and make the API calls, it uses a proxy built by Brightcove Learning services. Video Schema Builder This sample generates a VideoObject Schema in either Microdata or JSON-LD format. Including a schema with your video provides information to search engine indexers and enhances SEO. Video Renditions Inspector In this topic, you will learn to use the CMS API to inspect the renditions for all videos in an account. Video Reports by Delivery Type In this topic, you will learn to use the CMS API to report on videos of different delivery types. Report on Audio-Only Content If you have audio-only content in your video library, you might find it useful to run a report displaying just those audio-only videos. This sample shows you how to do that. Add Scheduled Videos In this sample, you will learn how to schedule videos to become available at some future time, so that they aren't accidentally played before they should be. Dynamic Ingest API Tester This quick start will help familiarize you with operations available via the Dynamic Ingest API. Adding Text Tracks In this sample, you will learn how to build an app to add assets to existing videos using Dynamic Ingest. Ingesting Low Priority Videos In this sample you will learn how to send multiple ingest jobs to the low priority queue. Ingesting Videos (Dynamic Delivery) In this sample, you will learn how to ingest multiple videos using the Dynamic Ingest API. To get access tokens and make the API calls, it uses a proxy built by Brightcove Learning services. Re-transcoding Videos (Dynamic Delivery) In this sample, you will learn how to retranscode multiple videos using the Dynamic Ingest API. To get access tokens and make the API calls, it uses a proxy built by Brightcove Learning services. Replacing Videos (Dynamic Delivery) In this sample, you will learn how to replace videos using the Dynamic Ingest API. Note that the API does not support operations on multiple videos - the code here simply loops over a data set to replace the videos one by one. Ingesting Videos (Legacy Ingest) In this sample, you will learn how to ingest multiple videos using the Dynamic Ingest API. To get access tokens and make the API calls, it uses a proxy built by Brightcove Learning services. Re-transcoding Videos (Legacy Ingest) In this sample, you will learn how to retranscode multiple videos using the Dynamic Ingest API. To get access tokens and make the API calls, it uses a proxy built by Brightcove Learning services. Replacing Videos (Legacy Ingest) In this sample, you will learn how to replace videos using the Dynamic Ingest API. Note that the API does not support operations on multiple videos - the code here simply loops over a data set to replace the videos one by one. Create Custom Dynamic Delivery Profile In this sample, you will learn how to create a custom Dynamic Delivery profile using the Ingest Profiles API. Create Custom Context Aware Encoding Profile In this sample, you will learn how to create a custom Context Aware Encoding profile using the Ingest Profiles API. Get All Profiles for an Account This sample shows you how to retrieve all the Ingest Profiles for an account, and also filter out some the items you may not want to display. Set Default Profile In this code sample, you will learn how to use the Ingest Profiles API to set the default ingest profile for multiple accounts. Add Profile to Multiple Accounts This sample app allows you to add a custom ingest profile to multiple Video Cloud accounts. You can either create a new profile and add it to all accounts, or select a profile from one account and add it to the other accounts. Set Default Profile In this code sample, you will learn how to use the Ingest Profiles API to set the default ingest profile for multiple accounts. Create Client Credentials This sample allows you to create create client credentials for one or more accounts, assigning them the API permissions you choose. Get an Access Token This sample retrieves an access token from the Brightcove OAuth API from a web app, sending the request through a proxy. JSON/MRSS Feed from a Playlist In this sample, you will learn how to retrieve a playlist using the Playback API and generate a JSON or MRSS video feed from the data. MRSS Generator In this sample, you will learn how to use the Playback API to generate an MRSS feed based on the MRSS specification. Create Policy Key In this quick start you use a simple web app to create a policy key. There is an option to search-enable the key. Get Started with the Ingest Profiles API Try a variety of API request on your own account or a sample Brightcove Account. Create a Player In this example, you enter your account information. As well, you enter a URL to media and the media type, or a Video Cloud video id. On click of the button, a player will be created and selected information about the player displayed. Display Players The sample shows how to retrieve a list of all players for a Brightcove account and display some details of the player as well as a preview of it in the page. Last Viewed Player Statistics Reports using the player's last_viewed data.Each player has associated with it an array that contains a record of how many times a player was loaded. This information is stored in an array name last_viewed. Delete Players The sample shows how to retrieve a list of all players and delete one a user selects (it doesn't actually delete the player, but shows you how). Python Code for a GET Request The sample shows how to retrieve videos using the CMS API. Python Code for Dynamic Ingest The sample shows how to create a Video Cloud video and ingest the video source file. Quick Start: Social API This quick start allows you to see the available requests for the Social API, and their responses, using either your own account or a Brightcove Learning Services sample account.
Contact Support
System Status
