Versions Compared

Key

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

...

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:
1. If URL has more than 1 query parameter, limit them to one
2. If it's a document - then it should be the document URL

1000 chars

"https://company.sharepoint.com/Home/Home.aspx?id=1"

qsstringQueryString of URL2000 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”

servertimeDateTimeServer time.  "2019-04-22 07:59:57"
servertimeoffsetstringServer 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.loadtimeint

Only for "Pageview" event:

Time it takes for the page to load in milliseconds

32-bit integer0

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"

spint

Only for "Search Result Click" event:
Position of search result on search result page

32-bit integer5
srint

Only for "Search" and "Search Result Click" events:

Total amount of search results on search results page

32-bit integer6
ststring

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

...