Page History
...
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. Mandatory. | 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. Mandatory. | 10 chars | "39E186A874" |
a.username | string | Full user account name. Mandatory. | 256 chars | "i:0#.f|membership|username@company.onmicrosoft.com" |
u | string | Full URL path where the event occurred on or derived from: | 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. |
...