Page History
...
The CardioLog tracking agent exposes allows for a client-side API for sending to send custom events, and easily monitoring clicks on a button or a banner, playing videosmonitor button and banner clicks, video plays, or interactions with other types of UI components. On any monitored page, you can call the following JavaScript methodsfunctions:
- The SendEvent JavaScript Function
- The SetReferer JavaScript Function
- The SendGoal JavaScript Function
| Anchor | ||||
|---|---|---|---|---|
|
This function allows for sending you to send events via the client agent. The Agent uses Ajax AJAX (Asynchronous JavaScript and And XML) to send the event to the 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 (such as eg., "Visit"," "Search," or custom event types).
- URL - Required. This is usually typically the URL of the visited page, but can be any text that represents an action (make sure to define . We recommend defining a unique prefix for each logical group of objects for optimal reports) - limited 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. In built Built-in events it is reserved by the the reserve this string for the system. For example - , in a "Visit" event it is used to store stores the referrer information, ; in a "Search" event it is used to store 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. In built Built-in events it is reserved by the the 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. (e.g. 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.
...
Define a unique referrer name that will be displayed in reports, such as __referrer=email_promotion_12_Dec_2008
...
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.
<log>
<status id='0'>OK</status>
<event id='211022'/>
</log>
</agent>
In case of an error, the XML response will include the error description:
<log>
<status id='-1'>Invalid Path</status>
</log>
</agent>
| Anchor | ||||
|---|---|---|---|---|
|
The SendEvent method supports the following event types:
...
- 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.
| Anchor | ||||
|---|---|---|---|---|
|
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).
...
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).
...
The data section for Table reports is ready for HTML deployment.
<prefs>
<showhelp>false</showhelp>
<showpreferences>false</showpreferences>
<timeframe>36000000000</timeframe>
<timeInterval>36000000000</timeInterval>
<maxrows>10</maxrows>
<mincount>1</mincount>
<reporttype>120</reporttype>
<columns>
<column id="title" title="Title" width="35%" type="SPPage" />
<column id="url" title="Url" width="0" type="hidden" />
<column id="views" title="Views" sorted="true" width="15%" type="number" />
<column id="users" title="Unique Users" sorted="false" width="20%" type="number" />
<column id="avgDuration" title="Duration" sorted="false" width="15%" type="string" />
<column id="exitRate" title="Exit Rate" sorted="false" width="15%" type="number" />
</columns><ctitle>Page Views</ctitle><chartType>static</chartType><adgroup></adgroup><adgroupname></adgroupname><categories></categories><entityId>0:b0426e68-8f34-4eb2-8702-012d5de1c143</entityId><entityName>All</entityName><entityTree>0</entityTree>
</prefs>
<thead>
<td type='SPPage' width='35%' id='title'>Title</td>
<td type='hidden' width='0' id='url'>Url</td>
<td type='number' width='15%' sorted='true' direction='-1' id='views'>Views</td>
<td type='number' width='20%' id='users'>Unique Users</td>
<td type='string' width='15%' id='avgDuration'>Duration</td>
<td type='number' width='15%' id='exitRate'>Exit Rate</td>
</thead>
<tbody from='0' to='10' total='10'>
<tr>
<td>bl_SecondaryNav_Divider.jpg</td>
<td>http://scotland:81/Style Library/Images/bl_SecondaryNav_Divider.jpg</td>
<td>3</td>
<td>3</td>
<td>00:00:04</td>
<td>0%</td>
</tr>
<tr>
<td>Links</td>
<td>http://scotland:81/Lists/Links/AllItems.aspx</td>
<td>3</td>
<td>3</td>
<td>00:00:02</td>
<td>0%</td>
</tr>
<tr>
<td>Workflow Tasks</td>
<td>http://scotland:81/News/WorkflowTasks/AllItems.aspx</td>
<td>3</td>
<td>3</td>
<td>00:00:07</td>
<td>0%</td>
</tr>
<tr>
<td>Total Problems</td>
<td>http://scotland:81/Reports/Lists/Sample Dashboard KPI Definitions/DispForm.aspx?ID=1</td>
<td>3</td>
<td>3</td>
<td>00:00:05</td>
<td>0%</td>
</tr>
</tbody>
<startTime>1/1/0001 12:00:00 AM</startTime><endTime>1/1/0001 12:00:00 AM</endTime><rules>1</rules></table>]]>
</data>
</call>
</report>
</xml>
...
The Meter data is displayed in the value node.
<report>
<call controlId="412" action="get" cached="True">
<controlTitle>Meter</controlTitle><title>Page Views</title>
<prefs>
<prefs><showhelp>false</showhelp><showpreferences>false</showpreferences><timeframe>36000000000</timeframe><timeInterval>36000000000</timeInterval><minvalue>0</minvalue><maxvalue>100</maxvalue><undershoot>0</undershoot><overshoot>100</overshoot><ctitle>Page Views</ctitle><chartType>static</chartType><adgroup></adgroup><adgroupname></adgroupname><categories></categories><entityId>0:b0426e68-8f34-4eb2-8702-012d5de1c143</entityId><entityName>All</entityName><entityTree>0</entityTree></prefs>
</prefs>
falsefalse3600000000036000000000101120Page Viewsstatic0:b0426e68-8f34-4eb2-8702-012d5de1c143All0 Title Url Views Unique Users Duration Exit Rate bl_SecondaryNav_Divider.jpghttp://scotland:81/Style Library/Images/bl_SecondaryNav_Divider.jpg 3 3 00:00:04 0% Links http://scotland:81/Lists/Links/AllItems.aspx 3 3 00:00:02 0% Workflow Taskshttp://scotland:81/News/WorkflowTasks/AllItems.aspx 3 3 00:00:07 0% Total Problems http://scotland:81/Reports/Lists/Sample Dashboard KPI Definitions/DispForm.aspx?ID=1 3 3 00:00:05 0% 1/1/0001 12:00:00 AM1/1/0001 12:00:00 AM1]]></data>
</call>
</report>
</xml>
...