Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The CardioLog Tracking Agent allows for a client-side API to send events, and easily monitor button and clicks, banner clicks, or interactions with other UI components. On any monitored page, you can call the following JavaScript functions:

...

The SendEvent function allows you to send events via the client browser. Using this function you can monitor clicks on UI elements such as buttons, banners, navigation menu entriesitems, links, etcvideos and more
The Tracking Agent uses AJAX (Asynchronous JavaScript And XML) to send the event to the CardioLog server, and will not affect the user interaction with the page in any way.

...

The SendEvent function accepts the following parameters:

  • Event Type - Required. The event type title (eg., 'Visit' or custom event types).
  • Event Title - Required. This can be any text that represents the event or 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.
  • 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.

Notes: 

  • 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 parentusing parent.document.__Page.SendEvent().
  • 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. 

 


Code Samples
  1. Send a click event on a DOWNLOAD button:

    Info
    iconfalse

    <input type="button" value="DOWNLOAD" onclick="document.__Page.SendEvent('Visit', 'Main Page Buttons > DOWNLOAD');" />



    www.intlock.com main page DOWNLOAD button

    In this example, when a user clicks on the DOWNLOAD button CardioLog will send an event of type 'Visit' to the server, specifying which button has been clicked by the user (ie., 'Main Page Buttons > DOWNLOAD'). We recommend defining a unique prefix for each group of UI components that will be displayed in reports (in this case, 'Main Page Buttons').

    To see how many times the button was clicked, use the Events report (chart or table), and type 'Main Page Buttons' in the Website Item field.
    To see who clicked on the button, use the Visitors by Events report (chart or table), and type 'Main Page Buttons' in the Website Item field.

  2. Send a click event on a banner that links to an external site:

    Info
    iconfalse

    <a href="http://www.intlock.comonclick="document.__Page.SendEvent('Visit', 'Banners > Intlock Website');"><img src="intlock_logo.gif"></a>



    support.intlock.com main page Intlock logo

    In this 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 "www.intlock.com" (ie., "Banners > Intlock website"). We recommend defining a unique prefix for each group of UI components that will be displayed in reports (in this case, "Banners").

    To see how many times the banner was clicked, use the Events report (chart or table), and type 'Banners' in the Website Item field.
    To see who clicked on the banner, use the Visitors by Events report (chart or table), and type 'Banners' in the Website Item field.

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

...