With the CardioLog API you can:

• 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
• Monitoring Banner Clicks
• The SetReferer JavaScript Function
• Monitoring UI Referrers
• The SendGoal JavaScript Function
• Monitoring JavaScript-Based Goals
• Monitoring Internal E-Mail Campaigns 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

CardioLog Client-Side API

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 JavaScript Function
• The SendGoal JavaScript Function

The SendEvent JavaScript Function

This function allows you to send events via the client agent. The Agent uses AJAX (Asynchronous JavaScript And XML) to send the event to the server, and will not affect the user interaction with the page in any way.

Code sample for sending a page view event:

The SendEvent function accepts the following parameters:

• • Event Type - Required. The event type title (eg., "Visit," "Search," or custom event types).
  • URL - Required. This is typically the URL of the visited page, but can be any text that represents an action. We recommend defining a unique prefix for each logical group of objects for streamlined reports. This string is limited to 1000 characters.
  • Param 1 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 1000 characters. Built-in events reserve this string for the system. For example, in a "Visit" event it stores the referrer information; in a "Search" event it stores the search term.
  • Param 2 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 50 characters. Built-in events reserve this string for the system. For example, in a "Search" event it is used to store the number of results.

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()

Monitoring Banner Clicks

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:

<a href="http://www.google.com" onclick="document.__Page.SendEvent('Visit', 'Banners > My Links > externalsite.com');"><img src="google_logo.gif"></a>

In our example, when a user clicks on the banner CardioLog will send an event of type "Visit" to the server, specifying which banner has been clicked by the user before redirecting to "externalsite" (ie., "Banners > My Links> externalsite.com"). We recommend defining a unique prefix for each group of UI components that will be displayed in reports (in this case, "Banners") .

How many times were my banners clicked? To see how many times your banners were clicked, use the Events report (chart or table), and select "Banners" in the Website Item field.

Who clicked on my banners? To see who clicked on your banners, use the Visitors by Events report (chart or table), and select "Banners" in the Website Item URL field.

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 External Destinations report.

The SetReferrer JavaScript Function

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).

Code Sample:

<a href="http://mysite/rnd/index.aspx" onclick="document.__Page.SetReferrer('Banners > MySite > Research and Development');"><img src="rnd.gif"></a>

 The SetReferrer function accepts the following parameters:

• • 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.

Monitoring UI Referrers

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:

<a href="http://mysite/rnd/index.aspx" onclick="document.__Page.SetReferrer('Banners > MySite > Research and Development');"><img src="rnd.gif"></a>

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 Internal Traffic Sources report, and select the page in the Website Item URL field.

The SendGoal JavaScript Function

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.

Code Sample:

<input type="button" value="Signup to Newsletter" onclick="document.__Page.SendGoal(1);" />

 The SendGoal function accepts the following parameter:

• • Goal ID - Required. Note: Goals are created in Goals. After creating the goal, the Goal ID can be found in the tab_goals table (column - id) in the CardioLog database.  

Monitoring JavaScript Based Goals

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.

Assuming the signup button was implemented using simple HTML, the following code sample should work:

<input type="button" value="Signup to Newsletter" onclick="document.__Page.SendGoal(1);" />

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.

Monitoring Internal E-Mail Campaigns 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:

http://myportal/sites/rnd/default.aspx?__Referrer=email_promotion_Dec_2016

How many visitors arrived on my page through my email campaign? To see how many visitors arrived on your page through your email campaign, use the Internal Traffic Sources report, and select the relevant page in the Website Item URL field.

CardioLog Server-Side API

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.

The SendEvent Method

The SendEvent method in the CardioLogAPI/Events.asmx web service accepts the following parameters:

• • UserName - Optional. The user associated with the event. If not passed, the method will use the current user credentials.
  • SessionID - Required. The unique session ID associated with the event.
  • Event Type - Required. The event type ID number
  • URL - Required. The URL of the page where the event occurred.
  • UserAgent - Optional. The user details including browser type and OS version.
  • ClientIP - Optional. The user IP address.
  • Param1 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 1000 characters. Built-in events reserve this string for the system. For example, in a "Visit" event it stores the referrer information; in a "Search" event it stores the search term.
  • Param2 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 50 characters. Built-in events reserve this string for the system. For example, in a "Search" event it is used to store the number of results.

After the event is sent, the web service XML response will include the event identifier for future use, which you can later use to send events related to this event accordingly:

<agent>

 <log>

 <status id='0'>OK</status>

 <event id='211022'/>

 </log>

 </agent>

 In case of an error, the XML response will include the error description:

<agent>

<log>

 <status id='-1'>Invalid Path</status>

 </log>

 </agent>

Event Types

The SendEvent method supports four event types. The ID number is used in the Server-Side API. The Event Type Title is used in the Client-Side API.

• View - Individual page request, or element clicked
  • Event Type ID - 0
  • Event Type Title - "Visit"

To set the page referrer, use the following optional parameters to track the source of the page:

• Param1 -The related view event ID or a string representing referrer types such as navigation toolbars, campaigns, banners, etc.
• Param2 -The referrer page URL

Referrer pages can be retrieved in CardioLog with the "Navigation" visual controls.

• Duration - Time spent on a page or element (in seconds).

• Event Type ID - 1
• Event Type Title - "Leave"
• URL - The related view event URL.
• Param1 - Duration in seconds.
• Param2 - The related view event ID.

• Search - Onsite (internal) search
  • Event Type ID - 2
  • Event Type Title - "Search"
  • URL - The related view event URL.
  • Param1 - Search keyword/phrase.
  • Param2 - Number of search results.

Search events can be viewed in CardioLog in the Onsite Searches report, popular search terms are displayed in the Onsite Search Phrases report.

• Search Result Click -
  • Event Type ID - 5
  • Event Type Title - "SearchResultClick"
  • URL - The search result URL.
  • Param1 - The search result position within search results.
  • Param2 - The related search event ID.

Creating Custom Event Types

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 (in both Client-Side and Server-Side APIs).

For example, if your website is a sales site and you wish to track each sale, and then create a report on the number of items sold, you can create a custom event type in CardioLog named "Item-Sold":

1. Add the custom event type to the CardioLog database by executing the following query against the CardioLog database:

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

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

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 Apps

Since non-browser apps, such as mobile apps, don't contain HTML pages, developers simply determine when their apps should trigger page view requests. CardioLog Analytics then aggregates this data in reports to display the number of visits, 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 can then use this data to understand which features are most popular and inform decisions about which features should be promoted or prioritized for further development.

The REST API

In order to track visitor actions for non-browser apps, developers must send usage event objects to the CardioLogAgent web application through HTTP POST requests in JSON format. The JSON string must be embedded in the request body. The POST response is provided in JSON format as well.

• The request must include a "Content-Type: application/json" header
• The request may optionally include an "Accept: application/json" header

The Event Object

CardioLog Analytics usage event objects have the following properties:

• u - URL of the page the event is related to. For example, in a "View" event, the URL will be the current page, while in search result click it will be the URL of the result clicked.
• X - Holds the following information:
• In Search event - the search term
• In View event:
• If __Referrer parameter was passed to this page, its value 
• If there is a Referrer cookie, sends the ReferrerReason cookie value 
• If this is the first page the user views in this session, send "First In Session" and append the data from __Referreragent
• In Duration event - time on page (in seconds)
• Y - Holds the following information:
• In Search event - Number of total results
• In Visit event - If there is a Referrer cookie, send its content
• In Duration event - last visit event id
• Z - In Search event - First result on page (number of result)
• RI - Last event id
• et - Event type code (for example, Goal event is 20, Leave event is 1 etc.)
• events - The event can have sub events sent with it (for example, when a search event is sent or when there are saved events).

The JSON request format

The full JSON request format is as follows:

{
    "events": {
      "event": [
        {
          "u": "http://www.intlock.com/",
          "X": "|referral|blog.intlock.com|/about/||",
          "et": 0,
          "RI": 564940
        },
        {
          "X": "1",
          "Y": "7",
          "et": 23,
          "RI": 0
        }
      ]
    },
    "browserType": "Apple-iPhone5C2/1001.525",
    "sessionid": "861529144.325047542",
    "un": "INTLOCK\\tomj"
}

The API URL

The API URL for a SharePoint site is:

https://[SharePoint WFE]/_layouts/CardioLogAgent/tunnel.aspx?random= 895.3324414324015

• Replace [SharePoint WFE] with your SharePoint URL address
• The random param is used as a cache buster

Data Export API

With the Data Export API you can develop client applications to retreive data from the CardioLog reporting engine, and refine the results of the request using query parameters. It allows for more flexibility and customization than the CardioLog UI, giving you a great deal of freedom over how to display your reports, in terms of their design, filters and data content, and where the reports are displayed. It's also possible to brand your data with your organization's colors and logos to really take ownership of it.

The CardioLog reporting engine generates the report in XML format and as a chart image.

Use the Reports API Helper to generate a URL which can be embedded in a client application. When calling this URL the report will be generated based on the selected parameters.

1. Browse: http://<cardiolog_server>:<port>/CardioLog/CLReport/ReportsAPIHelper.aspx

1. Select a Report.
2. Select the report parameters - Date Range, Time Interval, Website Item, Users and Groups
3. Check Generate Chart Image to create an image and set its Width and Height (pixels).
4. Click Get URL to generate the report URL
5. Click Generate Report to generate the report.
6. Click Show Advanced Options  and Get Report Preferences to modify report preferences.

The CardioLog Report XML Schema

The CardioLog report XML contains a preferences (prefs node) and a data section (data node).

Chart

The chart x-axis values are displayed in the categories node, while y-axis values are displayed in the dataset node (each chart series is represented by a dataset node).

Table

The data section for Table reports is ready for HTML deployment.

Meter

The Meter data is displayed in the value node.

Examples:

1. How to add values to the chart image

2. How to display the page views meter value

<script>
function getPageViews() {

// 1. Call the web service "http://cardiologservername:port/CardioLog/clreport/reportsapi.aspx" with the parameters "action=xml&controlId=3015&timeframe=77760000000000&urls=&usersAndGroups=&categoryId="

// 2. Create an XML file from the response and find the <data> node: selectSingleNode("//data").text;

// 3. Find the <value> node value with regex. Example: