| 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 results in another language" |
|---|
| enum | | "start" |
| "results" |
| "didyoumean" |
| "autoswitch" |
| "langswitch" |
| "error" |
| "click" |
| "cancel" |
|
|---|
| 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 |
|---|
|
|---|
| type_of_search | | 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." |
|---|
| 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." |
|---|
| type | "integer" |
|---|
| required | false |
|---|
|
|---|
| invoke_source | | description | "The source from which the Search interface was invoked: 0 - Main article toolbar, 1 - Widget, 2 - Share intent, 3 - Process-text intent, 4 - Floating search bar in the feed, 5 - Voice search query, 6 - Search shortcut." |
|---|
| type | "integer" |
|---|
| required | true |
|---|
|
|---|
| language | | description | "Language data for this event.
Depends on action:
- 'start': languages available for user to switch between
- 'langswitch': previous>new (e.g. So tapping on English when viewing German search results, the value would be "de>en")
- otherwise: language code of the search results shown to the user" |
|---|
| type | "string" |
|---|
| required | true |
|---|
|
|---|
| 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 |
|---|
|
|---|
| client_dt | | description | "Client-side ISO-8601-formatted date-time at which this event occurred." |
|---|
| type | "string" |
|---|
| required | true |
|---|
|
|---|
