quick-suggest
A ping representing a single event happening with or to a QuickSuggest.
Distinguishable by its ping_type.
Does not contain a client_id, preferring a context_id instead.
Metadata
| Source | mozilla/gecko-dev/browser/components/urlbar/pings.yaml#L8 |
| First Added | 2023-06-27 00:05:16 |
| Includes Client Identifier | No |
| Bugs | |
| Data reviews | |
| Notification Emails |
Commentary
No commentary for this ping, add some?
Server Knobs Configuration
| Sampling Configuration Snippet | Click the button to copy a snippet for use in a Mozilla Experimenter configuration. |
Access
| BigQuery | firefox_desktop.quick_suggest | Data Catalog
| firefox_desktop.quick-suggest 🔒 |
| Looker
| quick_suggest 🔒 | STMO |
Metrics
| Name | Type | Expiration | Description |
|---|---|---|---|
quick_suggest.advertiser Firefox :: Address Bar | string | never | The name of the advertiser providing the sponsored TopSite.
|
quick_suggest.block_id Firefox :: Address Bar | string | never | A unique identifier for the suggestion (a.k.a. a keywords block).
|
quick_suggest.context_id Firefox :: Address Bar | uuid | never | An identifier to identify users for Contextual Services user interaction pings.
|
quick_suggest.iab_category Firefox :: Address Bar | string | never | The suggestion's category. Either "22 - Shopping" or "5 - Educational".
|
quick_suggest.improve_suggest_experience Firefox :: Address Bar | boolean | never | Whether the "Improve Suggest Experience" checkbox is checked.
|
quick_suggest.is_clicked Firefox :: Address Bar | boolean | never | Whether this quicksuggest-impression ping was for an item that was clicked.
|
quick_suggest.match_type Firefox :: Address Bar | string | never | Whether this was a best/top match or not. Either "best-match" or "firefox-suggest".
|
quick_suggest.ping_type Firefox :: Address Bar | string | never | The ping's type. In other situations might be designated by an event's name or an interaction field. E.g. "quicksuggest-impression", "quicksuggest-block", "quicksuggest-click".
|
quick_suggest.position Firefox :: Address Bar | quantity | never | The position (1-based) of the QuickSuggest item being interatcted with.
|
quick_suggest.reporting_url Firefox :: Address Bar | url | never | The url to report this interaction to.
|
quick_suggest.request_id Firefox :: Address Bar | string | never | A request identifier for each API request to Merino. Only present for suggestions provided by Merino.
|
quick_suggest.source Firefox :: Address Bar | string | never | The source of the interaction. E.g. "urlbar".
|
quick_suggest.suggested_index Firefox :: Address Bar | string | never | A stringified integer value that is the intended index of the suggestion being interacted with. If suggested_index_relative_to_group is true, the index is relative to the "Firefox Suggest" group; otherwise the index is relative to the entire list of suggestions. Non-negative values (starting at 0) are relative to the start/top of the group/list; negative values are relative to the end/bottom of the group/list.
|
quick_suggest.suggested_index_relative_to_group Firefox :: Address Bar | boolean | never | Whether suggested_index is relative to the "Firefox Suggest" group. If false, it is relative to the entire list of suggestions.
|
app_build glean-core 📦 | string | never | The build identifier generated by the CI system (e.g. "1234/A").
If the value was not provided through configuration,
this metric gets set to Unknown.
|
app_channel glean-core 📦 | string | never | The channel the application is being distributed on.
|
app_display_version glean-core 📦 | string | never | The user visible version string (e.g. "1.0.3").
If the value was not provided through configuration,
this metric gets set to Unknown.
|
architecture glean-core 📦 | string | never | The architecture of the device, (e.g. "arm", "x86").
|
build_date glean-core 📦 | datetime | never | The date & time the application was built.
|
client_id glean-core 📦 | uuid | never | A UUID uniquely identifying the client. |
Page
1
of
2
(1
-
20
on
40
items)