Page History

Table of Contents
maxLevel 3

CardioLog SaaS Client-Side API

The CardioLog SaaS Tracking Agent offers a client-side API to send events, and track button clicks, banner clicks, navigation menu links or interactions with other UI components that display content dynamically (without redirecting to the content page URL). 

...

You can call the sendEvent JavaScript function on any monitored page to send events to CardioLog SaaS via the client browser. 

The SendEvent function accepts the following parameters:

• eventName - Required. The event type name (eg., 'pageview').
• URL - Required. The SharePoint content URL.

Code Sample

Send a click event on a DOWNLOAD button:

...

...

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 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:

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

...

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

1. Event Type ID - 1
2. Event Type Title - "Leave"
3. URL - The related view event URL.
4. Param1 - Duration in seconds.
5. 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.

...

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 product sold, and then you can create a report on the number of items sold, and create a custom event type in CardioLog named "Items-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:

...

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.

...

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:

...

• Search event - The search term
• View event:
• If __Referrer parameter was passed to this page, __Referrervalue 
• If there is a Referrer cookie, sends the ReferrerReason cookie value 
• If this is the first page the user views in this session, sends "First In Session" and appends the data from __Referreragent
• Duration event - Time on page in seconds

...

• In Search event - Number of total results
• In Visit event - If there is a Referrer cookie, sends its content
• In Duration event - Last visit event ID

...

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 default 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

With the CardioLog SaaS API you can:

• Track visitor actions within the browser such as button and banner clicks, form field data entries and more by implementing some simple JavaScript using the client-side API.
• Send custom events to CardioLog from any application using the server-side API.
• Track visitor actions from non-browser applications, including mobile apps, using the server-side API.