Creating Custom Analytics Reports in the Analytics Module
In this topic you will learn how to create custom reports using the Analytics module.
Note: The ability to create custom reports in the Analytics module is only available to Enterprise and Professional publishers.
Note: For users using Internet Explorer, version 10 or later is required.
The Analytics module can be used to generate custom, ad-hoc analytics reports that can be downloaded in comma separated values (.csv) or Microsoft Excel (.xlsx) formats. Reports can also be scheduled to run on a daily, weekly or monthly basis.
The Analytics API is used to retrieve data from the analytics system. The Analytics API can also be used to create your own custom reports. For more information on the Analytics API, see the Video Cloud Analytics API documentation.
To begin creating custom reports, open the Analytics module and click on the Custom link in the left navigation.
Note: You may notice that the number of video views for a given day vary over time. For an explanation on why this may happen, see the Analytics FAQ.
Note: Simultaneous custom report requests within the same account will execute in series. If the reports have large date ranges and many fields are selected, there may be a delay before all the results are returned. A good alternative is to schedule large reports.
Note: the video duration is displayed in seconds
To create a custom report, you will perform the following steps:
- Select accounts
- Select a report type
- Select data groups
- Add a report filter
- Select data fields
- Preview the report
- Configure delivery options
- Request the report
Reporting time zone
Data in custom reports is shown using the account's reporting time zone offset. The reporting time zone can be configured from the Video Cloud Studio home page by going to Account Settings > Analytics > Default Reporting Time Zone. Note that only account administrators have access to the Account Settings.
The reporting time zone is used to calculate day boundaries for reporting data. Changing the reporting time zone setting only affects data going forward, and changes are not applied retroactively. If you change this setting, you may see a flat spot or a spike in your data when looking at day boundaries where the change was applied. Updates to this setting may not take effect immediately, and analytics data may continue to refer to the old setting until the system processes the changes.
If you have access to multiple Video Cloud accounts, you can include data from the current Video Cloud account or from all Video Cloud accounts.
Note: If you only have access to a single Video Cloud account, this option will not display.
If you create a report that includes all accounts and those accounts use different time zones, data is reported using the time zone for that account.
Selecting a report type
Select the type of report:
- One-time - The report will be run once, immediately
- Recurring - The report can be scheduled to run on a daily, weekly or monthly basis
Note: Recurring reports are executed after the analytics reconciliation has taken place, usually 3 to 5 days after the end of a reporting period.
Selecting One-time will run the report one time. A calendar control will appear and you can specify the time period that you want the analytics data to cover. Select a start and end date or select one of the predefined "Quick Dates":
- Last 7 days
- Last 30 days
- This Month - the calendar month to date - for example, if today is March 17, this report will display March 1 - March 17
- Last Month - the previous calendar month - for example, if today is February 14, this report will display January 1 - January 31.
Tip: Start by selecting a smaller date range to confirm the report contains the data you are looking for. When you have confirmed the report data, expand the date range as needed.
Selecting Recurring will run the report on a recurring basis. Select a report Frequency:
- Daily - Report covers an entire day
- Weekly - Report covers an entire week, with a week being defined as Monday through Sunday
- Monthly - Reports covers an entire month
- Enterprise accounts are limited to 20 recurring reports, Professional accounts are limited to 5
- Recurring reports are associated with a user and are available across all accounts the user has access to
- Recurring reports are executed after the analytics reconciliation has taken place, usually 3 to 5 days after the end of a reporting period
Selecting data groups
Data Groups determine the data fields that can be included in the report. The data fields that appear in the Data Fields section are based upon the data groups that are selected. You can select multiple data groups but some combinations are not valid. As data groups are selected, the list of available data groups will be updated to include only the valid groups that can be selected.
Note: The Date data group cannot be combined with any other dimensions.
Data groups and fields
Select data group(s) below to see the fields that can be returned for it. If you select multiple incompatible data groups, you will see a message to that effect.
Fields that can be returned:
from date for this dimension combination:
To add a data group, click the button. To remove a group, click .
Adding a report filter
Filters can be added to limit the amount of data returned. When multiple values for a filter are used, an OR operation will be used. When using multiple filters, an AND operation will be used. In the following example, videos that are tagged (new studio OR video cloud essentials) AND have the custom field Drupal Product Topic VC2 - Getting Started will be returned.
To add a filter, click the button. To remove a filter, click . The following values can be used as filters.
- Video - One or more active video IDs in the account
- Video Tag - One or more video tags
- When filtering by video tag, entering financial services will return all videos that are tagged with financial or services. Entering "financial services" will return videos that are tagged financial services.
- When using multiple tags, videos with ALL the tags will be returned. Entering "financial services", accounting will return all videos that are tagged financial services and accounting.
- Note: the mechanism used to return videos by tag has no sort or paging options.
- Custom Fields - One or more custom fields in the account
- When filtering on custom fields and All My Accounts is selected, the custom field list will include the custom fields from all of your accounts. As custom fields are selected, the list will be filtered to contain only custom fields that are common across all accounts.
- Player - The filter value will vary based upon searching for Brightcove Players vs. Smart Players:
- Brightcove Players - Enter the player URL in this format: players.brightcove.com/account_id/playerID_default
- Brightcove Players used in SDK apps - Use the destination property from the app. The default value for the destination property is bcsdk:// followed by the app's bundle identifier as listed in the app's info.plist file.
- Smart Players - Enter the Player ID
- Source Type = One of the following values:
- Direct (bookmark, typed in URL, or link from email)
- Referral (direct link from some other page)
- Organic Search (ordinary search using some search engine)
- Paid Search (clicking a sponsored link in search results)
- Secure Search (search by a logged-in viewer)
- Device Type - Any of the following values:
- Connected TV/Game Console/Companion Device
- Device OS - Any of the following values:
- Web OS
- OS X
- Mac OS
- Device Manufacturer - Any of the following values:
- Browser Type - Any of the following values:
- Internet Explorer
- All Others
- Country - ISO-3611-1 country code
- Destination Domain - The domain(s) where a video_impression occurred
Selecting data fields
The Data Fields section is used to select the data values that will be included in the report. The list of data fields available is based upon the dimension(s) that were selected. Check All Available Fields to select all fields or manually select the data fields to be returned in the report. Hovering over the info icon next to a data field will display more information about that data field.
If the selected account is configured with custom fields, they can also be selected. If the report includes all accounts, all custom fields from those accounts will be displayed.
Note: For the utilization data, we only report on live seconds streamed, not live bandwidth.
Previewing the report
The Preview section shows the data columns that have been selected, populated with sample data. Click on a column header to sort the data by that column. Click Remove to remove that data item from the report.
Note: The data displayed in the report preview is sample data, not actual data from your Video Cloud account.
Configuring delivery options
Start by giving the report a meaningful name. This is especially important when creating a recurring report.
The Format section is used to select the format of the report data that is downloaded.
- CSV - comma-separated values
- XLSX - Microsoft Excel
Email notifications can be used to notify yourself and other users in your organization when the report is complete. Checking the E-mail me when my report is ready will send an email to the report requester when the report is complete. Additional people can be notified by adding their email addresses to the Notify others text field. When the report is complete, they will receive an email with a link to the report.
Requesting the report
Click the Request Report button to run the report. If the report is a One-time report, the report will be downloaded when it is complete. For Recurring reports, the report will be queued and run when the data is ready. If the start date is before the supported start date based upon the dimension combination(s) selected, an error will be displayed and a new start date should be selected.
See the Selecting data groups section of this topic for a list of supported start dates.
Viewing scheduled reports
To view all recurring reports, click Scheduled Reports in the left navigation. See Managing Scheduled Reports for more information on working with scheduled reports.