"Track user actions when using the search interface."
properties
action
description
"Which particular action triggered this event:
- start: the user started a search
- results: search results were shown to the user as a result of explicit user input
- didyoumean: the user clicked the 'did you mean' link shown above full-text results
- autoswitch: the user got no results from a prefixsearch, and was automatically switched to fulltext mode
- error: the user was presented with an error
- click: the user clicked on a search result
- cancel: the user aborted their search by clicking cancel or hitting back
- langswitch: when the user switches to search or see results in another language"
enum
"start"
"results"
"didyoumean"
"autoswitch"
"error"
"click"
"cancel"
"langswitch"
type
"string"
required
true
source
description
"The source from which the search interface was invoked."
enum
"top_of_feed"
"search_tab"
"article"
"unknown"
type
"string"
required
true
position
description
"The position of the search result that was selected, from the list that was presented to the user (used with the 'click' action)."
type
"integer"
required
false
search_type
description
"The type of search that was run (used with 'results' and 'error'):
- prefix: prefix (title only) search
- full: full-text search"
type
"string"
required
false
number_of_results
description
"The number of results that the user was shown as a result of their input (used with 'results')."
type
"integer"
required
false
time_to_display_results
description
"The number of milliseconds it took, from the app's/user's point of view, between sending the query and actually displaying the results (used with 'results')."
type
"integer"
required
false
session_token
description
"Session token for this search funnel"
type
"string"
required
true
app_install_id
description
"Randomly generated UUID that is unique to each app install, which can be used to cross-reference the same app install across different schemas."
type
"string"
required
true
primary_language
description
"User's primary language."
type
"string"
required
true
is_anon
description
"True if user has not logged in."
type
"boolean"
required
true
event_dt
description
"Client-side ISO-8601-formatted date-time at which this event occurred."
type
"string"
required
true
session_id
description
"A unique identifier randomly generated per user session. Please note that this is different from the search funnel token."
