Page History
The CardioLog SaaS Tracking Agent offers a client-side API to send custom events using JavaScript, such as button clicks, banner clicks, navigation links or interactions with other UI components that display content dynamically (without redirecting to the actual content page URL).
| Table of Contents | ||
|---|---|---|
|
The sendEvent JavaScript Function
You can call the sendEvent JavaScript function on any SharePoint monitored page in SharePoint (which includes the CardioLog SaaS Tracking Agent) to send events to CardioLog SaaS via the client browser.
...
The sendEvent function accepts the following parameters:
data - Required. The event data in JSON format. For example:
| Code Block |
|---|
{
"e":"Custom event", |
...
"eid":"E17221E709", "rid":"574DDE84E2", "sid":"4FC2D09FB6", "a":{ "username":"i:0#.f|membership|admin@company.onmicrosoft.com" }, "data":{ "timeonpage":"65030", "loadtime":"0" }, "u":" |
...
https:// |
...
company. |
...
sharepoint.com/ |
...
SitePages/Home.aspx", "qs":"", "ct":"2018-11-08 15:42:00", "ctoffset":"+02:00", "servertime":"2018-11-08 07:42:00", "servertimeoffset":"-06:00", "metaData": { "price": 5, "name": " |
...
Some item" } } |
...
eventCallback - Optional. Function to be executed after the event is sent.
Parameter Name | Type | Description | Max Data Length | Example |
e | string | Event name. Mandatory. | 50 chars | "Pageview", "Search", "Search Result Click", "External Click", "Search Result Preview", "Duration", "Custom Event" |
eid | string | Event ID. | 10 chars | "E7878CEF2A" |
rid | string | Related Event Id (ID of previous 'Pageview' event). | 10 chars | "02E0D73FBF" |
sid | string | Session Id. Should be same for all events within same browser session. | 10 chars | "39E186A874" |
a.username | string | Full user account name. | 256 chars | "i:0#.f|membership|username@company.onmicrosoft.com" |
u | string | Full URL path where the event occurred on or derived from: |
...
If URL has more than 1 query parameter, limit them to one | 1000 chars | "https://company.sharepoint.com/Home/Home.aspx?id=1" | ||
| qs | string | QueryString of URL | 2000 chars | "?id=1&q=2#s=1" |
ct | DateTime | Client time. |
| "2019-04-22 16:59:57" |
ctoffset | string | Client time offset. | 6 chars | “+03:00” |
| servertime | DateTime | Server time. | "2019-04-22 07:59:57" | |
| servertimeoffset | string | Server time offset. | 6 chars | "-06:00" |
data.timeonpage | int | Time spent on page (after page is closed or URL is changed) in milliseconds | 32-bit integer | 65030 |
| data.loadtime | int | Only for "Pageview" event: Time it takes for the page to load in milliseconds | 32-bit integer | 0 |
ua | string | User Agent | 450 chars | "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36" |
| sp | int | Only for "Search Result Click" event: | 32-bit integer | 5 |
| sr | int | Only for "Search" and "Search Result Click" events: Total amount of search results on search results page | 32-bit integer | 6 |
| st | string | Only for "Search" and "Search Result Click" and "Search Result Preview" events: Search term | 255 chars | "documents" |
| metadata | A list of parameters and their values. |
...
| 255 chars for key and value |
Code Sample
In this example, when a user clicks on the DOWNLOAD button on the home page, a popup window is opened with the download form:
Download Button
Download Form
...
In order to confirm that the event was sent successfully, open the browser Network tab and confirm that the request to the CardioLog Analytics SaaS events service (/cardiolog/api/client/events) returned the 200 status code.
Note: It is highly recommended to use the following code (or similar) to ensure that all the calls to the CardioLog API sendEvent function are executed and no events are lost (in case the CardioLog API object is not yet loaded on the page).
| Info | ||
|---|---|---|
| ||
(function (CardioLogAgent) {
if (CardioLogAgent.API) {
return;
}
var WAIT_FOR_SEC = 10;
var WAIT_CHECK_INTERVAL_MSEC = 500;
function createSendEventProxy() {
var proxy = {
calls: [],
fn: function (data, callback) {
proxy.calls.push({ data: data, callback: callback });
}
};
return proxy;
}
var sendEventProxy = createSendEventProxy();
var totalAttemptsCount = Math.ceil(WAIT_FOR_SEC * 1000 / WAIT_CHECK_INTERVAL_MSEC);
function waitForSendEventInit(attemptNumber) {
if (attemptNumber >= totalAttemptsCount) {
return;
}
window.setTimeout(function () {
if (CardioLogAgent.API.sendEvent === sendEventProxy.fn) {
waitForSendEventInit(attemptNumber + 1);
} else {
var call;
while ((call = sendEventProxy.calls.shift())) {
CardioLogAgent.API.sendEvent(call.data, call.callback);
}
}
}, WAIT_CHECK_INTERVAL_MSEC);
}
CardioLogAgent.API = { sendEvent: sendEventProxy.fn };
waitForSendEventInit(0);
})(window.CardioLogAgent || (window.CardioLogAgent = {})); |
Monitoring Internal Traffic Sources
Referrer Parameter
To monitor SharePoint content that is accessed via external applications, you can add the referrer parameter to the URL whenever you publish a link to a SharePoint page and you wish to track the source of the referring application or page.
This is most commonly used in email or social networks such as Teams or Viva Engage (Yammer).
For example, if you have included an internal SharePoint page link in an email, add the referrer parameter to the URL to track the users who visited your site via this link. Define a unique referrer value that will be displayed in reports, such as referrer=email_promotion_Dec_2023 in order to display the link accordingly:
| Code Block |
|---|
https://intlock.sharepoint.com/sites/blogs/ceo_blog.aspx?referrer=email_promotion_Dec_2023 |
UTM Parameters
To track and analyze the performance of internal campaigns and understand which marketing efforts are driving traffic to your SharePoint site, you can use UTM parameters.
You can add any of the following UTM parameters to the end of a URL:
utm_source: This parameter identifies the source of your traffic. It typically indicates where the link was placed, such as a specific website, newsletter, or social media platform.
utm_medium: This parameter specifies the medium through which the traffic is coming, such as email, social, or search.
utm_campaign: Campaigns are specific promotions or marketing initiatives that you want to track separately. This parameter allows you to identify the campaign associated with the URL.
utm_term: This parameter is used primarily for paid or promoted search campaigns, allowing you to specify the keywords associated with your campaign. It's less commonly used in other marketing channels.
utm_content: This parameter is used to differentiate between different pieces of content within the same campaign or source. For example, you can use it to track different versions of a banner or a link within an email.
For example, if you are sending out a monthly newsletter via email promoting a product launch event that was published in your SharePoint News section, add the following UTM parameters to the news article URL:
| Code Block |
|---|
https://intlock.sharepoint.com/sites/news/product_launch.aspx?utm_source=newsletter&utm_medium=email&utm_campaign=product_launch_dec_2023 |
By adding these UTM parameters to your URL, you can track the effectiveness of your campaigns with greater granularity. When someone clicks on a URL containing UTM parameters and visits your site, the data is captured in CardioLog Analytics SaaS allowing you to analyze and measure the performance of each campaign, source, and medium separately. This information is valuable for optimizing your marketing strategies and understanding which channels are generating the most traffic and engagement.
How to see this data in the reports?
To find out how many visitors reached your SharePoint page from a specific referring application or internal campaign, select the relevant page under the Page URL filter in the out-of-the-box Navigation Overview report, and view the results in the Internal Traffic Sources table visual.
Navigation Overview
You can also filter any other report page by the referrer parameter or UTM parameters.
The referrer parameter and the UTM parameters' values are available in the CardioLog Analytics SaaS dataset in Power BI in the following tables:
- SharePoint Usage table which stores all URL parameters in one string in the QueryString field.
- SharePoint Usage | Url Parameters table which stores all URL Parameters in key-value pairs, in the Key and Value fields.
To access the CardioLog Analytics SaaS dataset, edit your report and locate the relevant tables and fields under the Data section.
Edit Mode