Page History
...
- Track visitor actions within the browser such as button and banner clicks, form field data entry, video plays, and more by implementing some simple JavaScript.
- Monitor internal E-mail campaigns.
- Send events to CardioLog from any application using the CardioLog Events API web service.
- Create custom events and build custom reports using the CardioLog SDK.
- Build applications that request data from the CardioLog reporting engine using the Data Export API, refine the results, display them anywhere you prefer, and brand your data using your organization's style and logos.
- Track visitor actions from non-browser applications, including mobile apps.
Contents
- CardioLog Client-Side API
- The SendEvent JavaScript Function
- The SetReferer JavaScript Function
- The SendGoal JavaScript Function
- Monitoring Internal E-Mail Campaigns using Using the __referrer Parameter
- CardioLog Server-Side API
- The SendEvent Method
- Event Types
- Creating Custom Event Types
- Non-Browser Apps
- The REST API
- Data Export API
- The CardioLog Report XML Schema
| Anchor | ||||
|---|---|---|---|---|
|
The CardioLog tracking agent allows for a client-side API to send custom events, and easily monitor button and banner clicks, video plays, or interactions with other UI components. On any monitored page, you can call the following JavaScript functions:
- The SendEvent JavaScript Function
- The SetReferer SetReferrer JavaScript Function
- The SendGoal JavaScript Function
| Anchor | ||||
|---|---|---|---|---|
|
...
Note: when calling the "SendEvent" function within a different frame from where it is defined, make sure to reference the frame object containing it. For example, by using parent.document.__Page.SendEvent()
| Anchor | ||||
|---|---|---|---|---|
|
You can monitor clicks on UI elements such as banners, buttons, navigation menu entries, links, etc. In order to capture a click on a banner that links to an external site, make a call to the CardioLog SendEvent function before redirecting the user to the external destination page. IF the banner was implemented with simple HTML, you can insert this code:
...
Please note that CardioLog automatically tracks outbound links from SharePoint sites to external destinations. To see how many times your links were clicked, use the The CardioLog API report.
| Anchor | ||||
|---|---|---|---|---|
|
When users navigate internal links, you can monitor both the referring navigation component such as banners or menu items, along with the referring page. The SetReferrer function allows you to set custom page referrer details that are sent to the CardioLog server via following events (using SendEvent).
...
- Id - Required. The custom page referrer details. This can be any string representation. We recommend defining a unique prefix for each logical group of objects for optimized reports.
- Param 1 - Optional. Used to store additional information about the event, typically for custom reports.
| Anchor | ||||
|---|---|---|---|---|
|
In order to capture the referring UI component before redirecting the user, make a call to the CardioLog SetReferrer function. Assuming the banner was implemented with simple HTML, this is a code example:
...
How many visitors accessed my page through a UI referrer? To see how many visitors arrived on your page through your UI referrer, use the The CardioLog API report, and select the page in the Website Item URL field.
| Anchor | ||||
|---|---|---|---|---|
|
The SendGoal function allows for you to send JavaScript based goals via the client agent. The Agent uses AJAX (Asynchronous JavaScript and XML) to send the goal event to the server, and does not affect the user's experience with the page in any way.
...
- Goal ID - Required. Note: Goals are created in The CardioLog API. After creating the goal, the Goal ID can be found in the tab_goals table (column - id) in the CardioLog database.
| Anchor | ||||
|---|---|---|---|---|
|
In order to identify a JavaScript based goal, such as signing up for a newsletter, define the goal, and make a call to the CardioLog SendGoal function.
...
Goal Reports: To monitor your goal progress, use the Goal reports, and select the relevant goal in the Visitor Segments > Goal field of the widget preferences.
| Anchor | ||||
|---|---|---|---|---|
|
...
Using the __referrer Parameter
The CardioLog Client-Side API supports identifying and monitoring external locations. You can use the _referrer parameter whenever you publish a link to your monitored environment and you wish to track the source of the referring page. This is most commonly used in email or social media. For example, if you have included an internal link in a promotional email add the __referrer parameter to track the number of users who visited your site via this link. Define a unique referrer name that will be displayed in reports, such as __referrer=email_promotion_Dec_2016 in order to display the link accordingly:
...
By using the CardioLog Server-Side API, CardioLogAPI/Events.asmx web service, and the SendEvent method, you can send view, duration and search events, custom events, and track the URL of the referrer page.
| Anchor | ||||
|---|---|---|---|---|
|
The SendEvent method in the CardioLogAPI/Events.asmx web service accepts the following parameters:
...
You can create custom event types and build custom reports using the CardioLog SDK. The custom event types can be used in the SendEvent function, for both Client-Side and Server-Side APIs. For example, if your website is a sales site and you wish to track each saleproduct sold, and then you can create a report on the number of items sold, and create a custom event type in CardioLog named "ItemItems-Sold."
1. Add the custom event type to the CardioLog database by executing the following query against the CardioLog database:
...
VALUES(100, 'Item-Sold')
GO
ID - must be 100 or higher
Description - event type title
2. Add the custom event type to the CardioLog tracking agent events array - edit the __eEvents array and add the custom event type in:
For MOSS 2007 only:
[CardioLog installation directory]\CardioLogAgent\MOSS2007_1.2.js
For SharePoint 2010 only:
[CardioLog installation directory]\CardioLogAgent\SP2010_1.2.js
For SharePoint 2013 only:
[CardioLog installation directory]\CardioLogAgent\SP2013_1.2.js
For SharePoint 2016 only:
[CardioLog installation directory]\CardioLogAgent\SP2016_1.2.js
Note: If you have implemented the Tracking Agent using the CardioLog Analytics SharePoint Feature on your WFE (Web Front End), edit the __eEvents array and add the custom event type accordingly:
For MOSS 2007 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\CardioLogAgent\MOSS2007_1.2.js
For SharePoint 2010 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\SP2010_1.2.js
For SharePoint 2013 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\SP2013_1.2.js
For SharePoint 2016 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\SP2016_1.2.js
__eEvents = {
Visit: { id: 0, name: "Visit" },
Leave: { id: 1, name: "Leave" },
Search: { id: 2, name: "Search" },
SearchResultItem: { id: 4, name: "SearchResultItem" },
SearchResultClick: { id: 5, name: "SearchResultClick" },
External: { id: 10, name: "External" },
Goal: { id: 20, name: "Goal" },
"Goal-Test": { id: 21, name: "Goal-Test" },
Test: { id: 22, name: "Test" },
Score: { id: 23, name: "Score" },
Ping: { id: 24, name: "Ping" },
Item-Sold: { id: 100, name: "Item-Sold" },
Unknown: { id: -1, name: "Unknown" }
};
3. Implement the call to the SendEvent function when an item is sold (using our Client-Side API or Server-Side API).
4. Create a custom report to display the number of items sold using the CardioLog SDK.
Non-Browser (Mobile) Apps
Since nonMobile apps and other non-browser apps , such as mobile apps, don't contain HTML pages, therefore, developers simply must determine when their apps should trigger page view requests. CardioLog Analytics can then aggregates aggregate this data in reports to display the number of visitspage views, unique visitors, session length, bounce rates, etc. This data gives insight into how users interact with the client app.
Developers can also track visitor actions that don't correspond directly to page views using other Event types. These user actions can include views of embedded videos, button clicks, downloads and more. App developers This data can then use this data to be used to understand which features are most popular, and inform make informed decisions about which the features that should be promoted or prioritized for further development.
...