An on-site search represents an action where a user invokes a search feature or faceted navigation. The use of the feature typically results in a filtered set of products or content being offered to the user.

Configuration

Required fields

Field	Values	Definition
`category`	String. Valid value - `Behavior`	The category of the signal. For behavioral signals the category should always be “Behavior”.
`name`	String	The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals.
`signalType`	String. For on-site search signals, use `onSiteSearch`.	The type of signal being sent. Must be from the set of supported signals.
`searchTerm`	String	The string term that the customer searched for
`numberOfResults`	Number	The number of results that matched the search term

Optional fields

Field	Values	Definition
`effect`	String. Valid values: - `negative` - `positive`	Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.
`signalCustomAttributes`	String	Allows for custom attributes that are not predefined by the product

Here is an example:

var PageSignal = {
    signalType: "onSiteSearch",
    name: "onSiteSearch generated by web site",
    category: "Behavior",
    searchTerm: "", // Required
    numberOfResults: 0, // Required
    effect: "", // Required
    signalCustomAttributes: []
}
TLT.logSignal(PageSignal); // Method to push the data to Connect

Sample payload

{
  "signalType": "onSiteSearch",
  "name": "onSiteSearch from product page",
  "category": "Behavior",
  "searchTerm": "frame",
  "numberOfResults": "4",
  "effect": "positive"
}