Intro
Brightcove is a leading online video hosting platform and video player solution. To learn more about the Brightcove API, visit their page (https://support.brightcove.com).
You connect to your Brightcove account in the Data Center. This topic discusses the fields and menus that are specific to the Brightcove 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.
Prerequisites
To connect to your Brightcove account and create a DataSet, you must have the following:
-
A Brightcove client ID
-
A Brightcove client secret
For information about obtaining these credentials, see https://support.brightcove.com/managing-api-authentication-credentials.
Connecting to Your Brightcove Account
This section enumerates the options in the Credentials and Details panes in the Brightcove 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.
Credentials Pane
This pane contains fields for entering credentials to connect to your Brightcove account. The following table describes what is needed for each field:
Field |
Description |
---|---|
Client ID |
Enter your Brightcove client ID. |
Client Secret |
Enter your Brightcove client secret. |
Once you have entered valid Brightcove credentials, you can use the same account any time you go to create a new Brightcove 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.
Details Pane
This pane contains a primary Reports menu, along with various other menus for configuring your report.
Menu |
Description |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report |
Select the Brightcove report you want to run.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Account IDs | Enter a comma-separated list of Video Cloud account IDs you want to retrieve information for. For example: 12345,98765,10293 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Dimensions |
Select all of the dimensions you want to retrieve information for. The following table lists and describes all of the available dimensions:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fields |
Select all fields to include in your report. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Other Fields |
Enter a comma-separated list of custom or calculated fields for your report. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Where | Enter an optional WHERE clause to filter the result set. See the "Dimensions" table above for filter values for each dimension.The general syntax for this field is dimension1==value1;dimension2==value2. For example, if you had selected video and device_type as dimensions, you could enter filters for both using a query like the following:
video==123456789;device_type==tablet Commas are treated as logical ORs, and semicolons as logical ANDs. For example, the query video==1234,5678;player=9876 is interpreted as "where video=1234 OR 5678 AND player=9876." Using the special where=video.q=={property}:{value} filter, you can limit your report to a specific set of videos based on a variety of properties, including all of the following:
Examples: Tags: video.q==tags:foo,bar |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Player | Select the video player you want to retrieve information for. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Duration |
Select whether you want to pull data for a specific date or a date range. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Report Date |
Select whether the report data is for a specific date or for a relative number of days back from today. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific Date |
Select the date for the report. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back |
Enter the number of past days that should appear in the report. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Start Date |
Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in End Date. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
End Date |
Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in Start Date. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific Start Date |
Select the first date in your date range. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific End Date |
Select the second date in your date range. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back to Start From |
Enter the number of the farthest day back that should be represented in the report. Combine with Days Back to End At to create a range of represented days. For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back to End At |
Enter the number of the most recent day back that should be represented in the report. Combine with Days Back to Start From to create a range of represented days. For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago. |
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.
Comments
0 comments
Please sign in to leave a comment.