Events

Different types of events can be generated using this bot. This is the documentation on how to build them.

List of events

  1. Search event
  2. Click event
  3. SearchAndClick event
  4. Custom event
  5. TabChange event
  6. FacetChange event
  7. SetOrigin event
  8. PageView event

0. Generic event

Parameter Type Usage
type string The type of the event
arguments Object The arguments of the event, they are different for each type of events

1. Search event

Represents one query sent to the index. Typically the submit of the search bar, search as you type, etc.

"type" : "Search"

Arguments Type Usage
queryText string The query to send. Leave "blank" for a random query
goodQuery boolean If the random query should be a good or a bad query
caseSearch boolean If the query comes from a Case Creation interface
inputTitle string The title of the input that triggered the search if it was a case search
customData object Custom data to be sent alongside the event.

Example

{
    "type" : "Search",
    "arguments" : {
        "queryText" : "",
        "goodQuery" : true,
        "caseSearch" : true,
        "inputTitle" : "Product",
        "customData" : {
            "hasclicks": true
        }
    }
}
Back to top

2. Click Event

Represents a click on a document that was returned by a query. Can represent either a document open or a quickview.

"type" : "Click"

Arguments Type Usage
docNo number The rank of the document to click (0 base, put -1 for random)
offset number An offset used in random document clicking
probability number The probability that the user will click (between 0 and 1)
quickview boolean If the click is a quickview or not (default, false)
customData object Custom data to be sent alongside the event.

Example

{
    "type" : "Click",
    "arguments" : {
        "docNo" :-1,
        "offset" : 0,
        "probability" : 0.45,
        "quickview" : true,
        "customData" : {
            "hasclicks": true
        }
    }
}
Back to top

3. SearchAndClick event

Use when you want to click on a specific document after a specific search. Ties a search and a click event together.

"type" : "SearchAndClick"

Arguments Type Usage
queryText string The query to send. Not recommended to use with random query.
docClickTitle string The title of the document you want to click on.
probability number Between 0 and 1, the probability the user will click
quickview boolean If the click is a quickview instead of a document open (default false)
caseSearch boolean If the event is on a Case Creation interface (default false)
inputTitle string If it's a case creation event, which input triggered the search
customData object Any custom data to send with the event

Example

{
    "type" : "SearchAndClick",
    "arguments" : {
        "queryText" : "specific query",
        "caseSearch": true,
        "inputTitle": "Subject",
        "probability" : 0.85,
        "docClickTitle" : "specific title"
    }
}
Back to top

4. Custom event

A custom event sent to the analytics, contains custom data.

"type" : "Custom"

Arguments Type Usage
actionType string The event type of this custom event
actionCause string The cause of this event, also the event value
customData object Any custom data to send with the event

Example

{
    "type" : "Custom",
    "arguments" : {
        "actionCause" : "submitButton",
        "actionType" : "caseCreation",
        "customData" : {
            "hasclicks": false,
            "product" : "XBR6 TV"
        }
    }
}
Back to top

5. TabChange event

Represents when the user changes the tabs on top of the result list in a search page.

"type" : "TabChange"

Arguments Type Usage
tabName string The name of the tab that the user switched to. This will also change originLevel2.
tabCQ string The constant query applied by this tab to the queries

Example

{
    "type" : "TabChange",
    "arguments" : {
        "tabName" : "YOUTUBE",
        "tabCQ" : "@sysfiletype==\"youtubevideo\""
    }
}
Back to top

6. FacetChange event

Represents an event sent when the user chooses a value in a facet.

"type" : "FacetChange"

Arguments Type Usage
facetTitle string The title of the facet that was selected
facetValue string The value that was selected in the facet
facetField string The field bound to the facet

Example

{
    "type" : "FacetChange",
    "arguments" : {
        "facetTitle": "Type",
        "facetValue": "Message",
        "facetField": "@objecttype"
    }
}
Back to top

7. SetOrigin event

An event to tell the bot to change the origin of the events (use this when the user moved between search pages for example)

"type" : "SetOrigin"

Arguments Type Usage
originLevel1 string The new originLevel1
originLevel2 string The new originLevel2
originLevel3 string The new originLevel3

Example

{
    "type" : "SetOrigin",
    "arguments" : {
        "originLevel1" : "Example1",
        "originLevel2" : "Example2",
        "originLevel3" : "Example3"
    }
}
Back to top

8. PageView event

An event when a user visits a page.

"type" : "View"

Arguments Type Usage
pageuri string The uri of the page currently visited
pagereferrer string The uri of the page referrer if available
pagetitle string The title of the page

Example

{
    "type" : "View",
    "arguments" : {
        "pageuri" : "https://example.com",
        "pagereferrer" : "https://www.google.com",
        "pagetitle" : "Page Example"
    }
}
Back to top