The Analytics AddOn includes the ability to capture custom data and transform that data for storage in a third party system, or provide a custom report.
Custom data is defined as:
- Any analytics events sent from the Extension API (http://www.hapyak.com/docs/hapyak-iframe-api/#Analytics)
- Any variables set via query parameters using the "hapyak_[variable_name]=[value]" syntax. (Often used for in video Personalization techniques)
Since 3rd parties systems, such as Google Analytics, cannot accommodate the exact structure of analytics events and properties as HapYak, transformation to summarize the data is typically required. Each 3rd party system will require different rules to transform the data, but generally, the information is summarized to record Clicks on Links, Navigation within the Video, and Questions Answered.
All other systems, including cases where HapYak is used to generate a custom report, require custom code to perform the transformations. As a licensee of the Analytics AddOn, our team will work with you to gather the requirements and implement the configuration.
Any custom report will be in the form of an API end-point that can return data formatted as JSON or CSV. Both Microsoft Excel and Google Spreadsheets are capable of displaying the CSV-formatted reports for sharing and analysis.
The Analytics API allows you to write code that intercepts HapYak tracking events, which you can then send to a non-HapYak repository. This manifests in our Viewer API as the onTrackingEvent callback handler; details here. Developers will use this API to develop their own connection to Google Analytics, Omniture - and other web tracking packages.
The Reporting API allows you to pull standard HapYak reports, from data stored in our system. Details here.
The Analytics AddOn covers three cases that fundamentally extend the capabilities of the Analytics API and Reporting API.
Case 1: Use of custom data. Any values, properties, events that are not created by the out-of-the-box features are considered "custom". Any use of the Extension API to track activity in a custom annotation falls into this category.
Case 2: Use of custom reports. If you use custom data, you will need a custom report. Some customers have standard data, but need it exported or delivered in a special way, which also falls into this category.
Case 3: Use of our pre-packaged 3rd party connectors. Google Analytics, Brightcove Audience and MixPanel are all pre-packaged connectors to the Analytics API. Customers use this as a convenience, since they could otherwise implement the same functionality themselves.