This web application event occurs when a user submits a search query for which Fluid Topics has retrieved replies.
This event contains the following fields:
| Field | Description |
|---|---|
searchQuery |
An object containing information about the search query. |
terms |
Contains the keywords the user searched for. |
facets |
An object containing information about the search facets. |
key |
The metadata key used as facet. |
type |
Takes one of the following values: VALUE, DATE, RANGE. |
value |
The facet value. |
searchType |
The type of search. Accepts the following values: EVERYWHERE, TITLE_ONLY, NONE. |
searchResponse |
An object containing information about the search response. |
autocorrect |
Indicates whether autocorrect was applied to the user's search query. |
nbResults |
Contains the number of results retrieved for the search query. |
The lastUpdate field is deprecated. Information regarding the last update is included in the DATE or RANGE type of the ft:lastEdition facet.
A table for the most common fields is in Analytics events.
Example:
[
{
"searchQuery": {
"terms": "API",
"facets": [
{
"key": "Category",
"type": "VALUE",
"values": [
"Reference Guides"
]
},
{
"key": "Product",
"type": "VALUE",
"values": [
"Fluid Topics"
]
},
{
"key": "ft:lastEdition",
"type": "DATE",
"dateValue": "LAST_MONTH"
},
{
"key": "FT_Version",
"type": "RANGE",
"from": "5.0",
"to": "5.1"
}
],
"searchType": "EVERYWHERE"
},
"searchResponse": {
"autocorrect": false,
"nbResults": 3674
}
}
}
]