Versions Compared

Key

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

...

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

...

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 items, links, videos and more. 
The Tracking Agent uses AJAX (Asynchronous JavaScript And XML) to send the event to the CardioLog server, and will does not affect the user interaction with the page in any way.

...

  • 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 prefix label 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  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().
  • In order to capture a click on a banner or image that links to an external site, make a call to the CardioLog SendEvent function before redirecting the user to the external destination page. 

...

  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 "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 unique label 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 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 unique label 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.

...

  1. Send a goal event on a Register to a Webinar button:

    Create the goal, and make a call to the CardioLog SendGoal function with the proper Goal ID.

    Info
    iconfalse

    <input type="button" value="REGISTER NOW " onclick="document.__Page.SendGoal(1);" />



    www.intlock.com main page com Main Page REGISTER NOW buttonSurvey Button

    To monitor your goal progress, use the Goal reports, and select the relevant goal in the Visitor Segments > Goal filter of the widget preferences.


    Visitor Segments > Goal 

...

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

Info
iconfalse

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

...

Info
iconfalse

INSERT INTO tab_event_type(id,description)

VALUES(100, 'ItemItems-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:

...

In addition to event objects, the request body may include the following properties:

  • browserType - The user-agent information
  • sessionid - Any string format accepted.
  • un - User IDname. Any string format accepted.

...