> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ooyala Advanced Connector

## Intro

Ooyala provides online video analytics and monetization solutions that boost revenues from video.  For more information about the Ooyala API, visit their website. ([http://support.ooyala.com/developers...ics\_v3\_metrics](http://support.ooyala.com/developers/documentation/api/analytics_v3_api_reporting_metrics.html#analytics_v3_metrics "http://support.ooyala.com/developers/documentation/api/analytics_v3_api_reporting_metrics.html#analytics_v3_metrics") )

The Ooyala connector is a "Cloud App" connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking **Cloud App** in the toolbar at the top of the window.

There is also a simplified version of the Ooyala connector. This connector is almost identical but does not include the "Ooyala IQ Analytics v.3" report. For more information about this version, see [Ooyala Connector](/s/article/360042931154 "Ooyala Connector").

You connect to your Ooyala account in the Data Center. This topic discusses the fields and menus that are specific to the Ooyala connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

<table class="mt-responsive-table" data-aura-rendered-by="33:195;a"><tbody><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Use Cases </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"> Use this connector to monitor viewer habits by device type, platform, screen size, and playthrough rate. </td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Metrics </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Most viewed videos </p></li><li><p> Total video views </p></li><li><p> Total vs. unique views </p></li><li><p> Video displays/loads/starts </p></li><li><p> Video playthrough rate percentage </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Company Roles </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Marketing director </p></li><li><p> Marketing manager </p></li><li><p> Training video producer </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Average Implementation Time </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 1 hour </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Ease of Use (on a 1-to-10 scale with 1 being easiest) </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 3 (higher when using the "Ooyala IQ Analytics v.3" report) </p></td></tr></tbody></table>

## Best Practices

* Retrieve account/brand performance data for account over time.
* View trends to determine viewer behaviors.
* Determine analytics regarding device types and platforms to optimize viewing experience.

## Prerequisites

To connect to your Ooyala account and create a DataSet, you must have an Ooyala API Key and API Secret. You can obtain these credentials by doing the following:

1. Log into your account at [https://backlot.ooyala.com](https://backlot.ooyala.com "https://backlot.ooyala.com").
2. Click the **Account** button in the toolbar at the top of the screen.
3. Click **Developers** in the subtab row under the main toolbar.

The API Key is immediately visible in this tab. To show the API Secret, click **Display API Secret**.

## Connecting to Your Ooyala Account

This section enumerates the options in the **Credentials** and **Details** panes in the Ooyala Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Ooyala account. For information about obtaining these credentials, see "Prerequisites," above.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Field </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter the API Key for your Ooyala account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Secret </p></td><td colspan="1" rowspan="1"><p> Enter the API Secret for your Ooyala account. </p></td></tr></tbody></table>

Once you have entered valid Ooyala credentials, you can use the same account any time you go to create a new Ooyala DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Report** menu in which you select a report type. Depending on the report type you select, other parameters may be required.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select an Ooyala report. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Account Performance </p></td><td colspan="1" rowspan="1"><p> Returns perfromance metrics for the authenticated user's account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Brand Performance </p></td><td colspan="1" rowspan="1"><p> Returns performance metrics based on brands for the authenticated user's account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Performance Analytics for Device Types </p></td><td colspan="1" rowspan="1"><p> Returns performance metrics for device types. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Performance Analytics for Platforms </p></td><td colspan="1" rowspan="1"><p> Returns performance metrics per platform. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Get Total Bytes Delivered </p></td><td colspan="1" rowspan="1"><p> Returns total bytes delivered within a fixed period of time. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List All Assets </p></td><td colspan="1" rowspan="1"><p> Returns a list of videos and other assets for the authenticated user's account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List All Asset Analysis </p></td><td colspan="1" rowspan="1"><p> Returns performance metrics for each asset. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Most Popular Videos </p></td><td colspan="1" rowspan="1"><p> Returns a list of the most popular videos in descending order. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Plays By Country </p></td><td colspan="1" rowspan="1"><p> Returns performance metrics by specified country. </p></td></tr><tr><td colspan="1" rowspan="1"><p> List Videos with Most Momentum </p></td><td colspan="1" rowspan="1"><p> Returns a list of videos with the most momentum in descending order. </p></td></tr><tr><td colspan="1" rowspan="1"> Ooyala IQ Analytics v.3 </td><td colspan="1" rowspan="1"> Returns customized data based on selected dimensions and metrics as well as applied filters. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Label </p></td><td colspan="1" rowspan="1"><p> Select the label you want to retrieve data for. </p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Duration </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Specify whether the data in this report is for a single date or a range of dates. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Report Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Specify whether the data is for a specific or relative date. Choose <b> Relative </b> if you always want the report to retrieve data for a given number of days back (which you specify in <b> Days Back </b> ) from the current date. For example, if you enter </span><span class="mt-font-courier-new"><span class="s3"> 5 </span></span><span class="s1"> for <b> Days Back </b> and set the DataSet to update daily, each new day the report will update to show information for the date 5 days in the past. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select Specific Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select the date you want to retrieve data for. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Days Back </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Enter the number of days back from the current date that will be presented in the report. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Start Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Specify whether the first date in your date range is a specific or relative date. Choose <b> Relative </b> if you always want the report to retrieve data for a given number of days back (which you specify in <b> Days Back to Start From </b> ) from the current date. If you choose <b> Relative </b> here, you should also choose <b> Relative </b> for <b> End Date </b> and specify a value for <b> Days Back to End At </b>. </span></p><p class="p1"><span class="s1"> For example, if you enter </span><span class="mt-font-courier-new"><span class="s3"> 10 </span></span><span class="s1"> for <b> Days Back to Start From </b> and </span><span class="mt-font-courier-new"><span class="s3"> 5 </span></span><span class="s1"> for <b> Days Back to End At </b> and you set the DataSet to update daily, each new day the report will update to show information for 5 to 10 days in the past. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> End Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Specify whether the last date in your date range is a specific or relative date. Choose <b> Relative </b> if you always want the report to retrieve data for a given number of days back (which you specify in <b> Days Back to End At </b> ) from the current date. If you choose <b> Relative </b> here, you should also choose <b> Relative </b> for <b> Start Date </b> and specify a value for <b> Days Back to Start From </b>. </span></p><p class="p1"><span class="s1"> For example, if you enter </span><span class="mt-font-courier-new"><span class="s3"> 10 </span></span><span class="s1"> for <b> Days Back to Start From </b> and </span><span class="mt-font-courier-new"><span class="s3"> 5 </span></span><span class="s1"> for <b> Days Back to End At </b> and you set the DataSet to update daily, each new day the report will update to show information for 5 to 10 days in the past. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select Specific Start Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select the first date in your date range. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select Specific End Date </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Select the last date in your date range. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Days Back to Start From </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Enter the number of days before the current date to use as the start date. </span></p><p class="p1"><span class="s1"> For example, if you enter </span><span class="mt-font-courier-new"><span class="s3"> 10 </span></span><span class="s1"> for <b> Days Back to Start From </b> and </span><span class="mt-font-courier-new"><span class="s3"> 5 </span></span><span class="s1"> for <b> Days Back to End At </b> and you set the DataSet to update daily, each day the report updates to show information for a 5-day range, starting 10 days ago and ending 5 days ago. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Days Back to End At </span></p></td><td colspan="1" rowspan="1"><p class="p1"><span class="s1"> Enter the number of days before the current date to use as the end date. </span></p><p class="p1"><span class="s1"> For example, if you enter </span><span class="mt-font-courier-new"><span class="s3"> 10 </span></span><span class="s1"> for <b> Days Back to Start From </b> and </span><span class="mt-font-courier-new"><span class="s3"> 5 </span></span><span class="s1"> for <b> Days Back to End At </b> and you set the DataSet to update daily, each day the report updates to show information for a 5-day range, starting 10 days ago and ending 5 days ago. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Period Type </p></td><td colspan="1" rowspan="1"><p> Select the period type for the report data. For example, if you entered <span class="mt-font-courier-new"> 30 </span> for <b> Start Day </b> and selected <b> Month </b> for <b> Report Period Type </b>, and today's date was September 15, data would be returned for the month of August. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Breakdown </p></td><td colspan="1" rowspan="1"><p> Select the time unit the report data will be broken down by. For example, if you selected <b> Week </b>, there will be a row in the report for each individual week. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Include Sub Account </p></td><td colspan="1" rowspan="1"><p> Specify whether sub accounts are to be included. </p></td></tr><tr><td colspan="1" rowspan="1"> Device Type </td><td colspan="1" rowspan="1"> Select the device type you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Filters (Optional) </td><td colspan="1" rowspan="1"><p> Enter filters using the following syntax: </p><p><span class="mt-font-courier-new"> filter\_type1=='filter\_value1',filter\_type2=='filter\_value2'... </span></p><p> For example: </p><p><span class="mt-font-courier-new"> country=='CA',device\_type=='mobile' </span></p><p> For more information, visit <a href="http://help.ooyala.com/video-platform/api/analytics_v3_api_reporting_filters.html#analytics_v3_filters" target="_blank"> [http://help.ooyala.com/video-platform/api/analytics\_v3\_api\_reporting\_filters.html#analytics\_v3\_filters](http://help.ooyala.com/video-platform/api/analytics_v3_api_reporting_filters.html#analytics_v3_filters) </a></p></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Troubleshooting

Check that date ranges are valid for the accounts/videos.
