summaryrefslogtreecommitdiffstats
path: root/browser/components/urlbar/metrics.yaml
blob: 173ee08a10a36728717ba92c56e403092dceaa96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - "Firefox :: Address Bar"

urlbar:
  abandonment:
    type: event
    description: Recorded when the user abandons a search (blurring the urlbar).
    extra_keys:
      abandonment_type:
        description: >
          Records the reason that resulted in an abandonment. The possible
          values are: `blur` and `tab_switch`.
        type: string
      sap:
        description: >
          `sap` is the meaning of `search access point`. It records where the
          user started the search action from. The possible values are: `urlbar`
          , `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
        type: string
      interaction:
        description: >
          How the user started the search action. The possible values are:
          `typed`, `pasted`, `topsite_search` (clicked on a topsite search
          shortcut), `topsites` (selected a topsite result with empty search
          string), `returned` (The user abandoned a search, then returned to it)
          , `restarted` (The user abandoned a search, then returned to it,
          cleared it and typed a completely different string), `refined` (The
          user abandoned a search, then returned to it, and partially modified
          the string), `persisted_search_terms` (The user returned to a previous
          successful search that persisted terms in the urlbar),
          `persisted_search_terms_restarted` (The user returned to a previous
          successful search that persisted terms in the urlbar, then cleared it
          and typed a completely different string) and
          `persisted_search_terms_refined` (The user returned to a previous
          successful search that persisted terms in the urlbar, and partially
          modified the string).
        type: string
      search_mode:
        description: >
          If the urlbar is in search mode, thus restricting results to a
          specific search engine or local source, this is set to the search mode
          source. The possible sources are: `actions`, `bookmarks`, `history`,
          `search_engine`, and `tabs`. If search mode is active but the source
          did not fall into any of these categories, this will be `unknown`. If
          search mode is not active, this will be an empty string.
        type: string
      search_engine_default_id:
        description: >
          The telemetry id of the search engine.
          Reflects `search.engine.default.engine_id`.
        type: string
      n_chars:
        description: >
          The length of string used for the search. It includes whitespaces.
        type: quantity
      n_words:
        description: >
          The length of words used for the search. The words are made by
          splitting the search string by whitespaces, thus this doesn’t support
          CJK languages. For performance reasons a maximum of 255 characters are
          considered when splitting.
        type: quantity
      n_results:
        description: >
          The number of results shown to the user. If this is high the results
          list below may be truncated due to technical limitations. Also note in
          that case not all the results may be physically visible due to the
          screen size limitation.
        type: quantity
      groups:
        description: >
          Comma separated list of result groups in the order they were shown to
          the user. The groups may be repeated, since the list will match 1:1
          the results list, so we can link each result to a group. The possible
          group names are: `heuristic`, `adaptive_history`, `search_history`,
          `search_suggest`, `search_suggest_rich`, `trending_search`,
          `trending_search_rich`, `top_pick`, `top_site`, `remote_tab`,
          `addon`, `general`, `suggest`, `about_page` and `suggested_index`. If
          the group did not fall into any of these, this will be `unknown` and
          a bug should be filed to investigate it.
        type: string
      results:
        description: >
          Comma separated list of result types in the order they were shown to
          the user. The `unknown` type should not occur and indicates a bug. The
          possible types are:
          `action`,
          `addon`,
          `autofill_about`,
          `autofill_adaptive`,
          `autofill_origin`,
          `autofill_unknown`,
          `autofill_url`,
          `bookmark`,
          `calc`,
          `clipboard`,
          `fxsuggest_data_sharing_opt_in`,
          `history`,
          `intervention_clear`,
          `intervention_refresh`,
          `intervention_unknown`,
          `intervention_update`,
          `keyword`,
          `merino_adm_sponsored`,
          `merino_amo`,
          `merino_top_picks`,
          `merino_wikipedia`,
          `recent_search`,
          `remote_tab`,
          `rs_adm_nonsponsored`,
          `rs_adm_sponsored`,
          `rs_amo`,
          `rs_mdn`,
          `rs_pocket`,
          `rust_adm_nonsponsored`,
          `rust_adm_sponsored`,
          `rust_amo`,
          `rust_mdn`,
          `rust_pocket`,
          `rust_yelp`,
          `search_engine`,
          `search_history`,
          `search_suggest`,
          `search_suggest_rich`,
          `tab`,
          `tab_to_search`,
          `tip_dismissal_acknowledgment`,
          `tip_onboard`,
          `tip_persist`,
          `tip_redirect`,
          `tip_unknown`,
          `top_site`,
          `trending_search`,
          `trending_search_rich`,
          `unit`,
          `url`,
          `weather`
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800414
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800414#c2
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247#c3
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  engagement:
    type: event
    description: Recorded when the user executes an action on a result.
    extra_keys:
      sap:
        description: >
          `sap` is the meaning of `search access point`. It records where the
          user started the search action from. The possible values are: `urlbar`
          , `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
        type: string
      interaction:
        description: >
          How the user started the search action. The possible values are:
          `typed`, `pasted`, `topsite_search` (clicked on a topsite search
          shortcut), `topsites` (selected a topsite result with empty search
          string), `returned` (The user abandoned a search, then returned to it)
          , `restarted` (The user abandoned a search, then returned to it,
          cleared it and typed a completely different string), `refined` (The
          user abandoned a search, then returned to it, and partially modified
          the string), `persisted_search_terms` (The user returned to a previous
          successful search that persisted terms in the urlbar),
          `persisted_search_terms_restarted` (The user returned to a previous
          successful search that persisted terms in the urlbar, then cleared it
          and typed a completely different string) and
          `persisted_search_terms_refined` (The user returned to a previous
          successful search that persisted terms in the urlbar, and partially
          modified the string).
        type: string
      search_mode:
        description: >
          If the urlbar is in search mode, thus restricting results to a
          specific search engine or local source, this is set to the search mode
          source. The possible sources are: `actions`, `bookmarks`, `history`,
          `search_engine`, and `tabs`. If search mode is active but the source
          did not fall into any of these categories, this will be `unknown`. If
          search mode is not active, this will be an empty string.
        type: string
      search_engine_default_id:
        description: >
          The telemetry id of the search engine.
          Reflects `search.engine.default.engine_id`.
        type: string
      n_chars:
        description: >
          The length of string used for the search. It includes whitespaces.
        type: quantity
      n_words:
        description: >
          The length of words used for the search. The words are made by
          splitting the search string by whitespaces, thus this doesn’t support
          CJK languages. For performance reasons a maximum of 255 characters are
          considered when splitting.
        type: quantity
      n_results:
        description: >
          The number of results shown to the user. If this is high the results
          list below may be truncated due to technical limitations. Also note in
          that case not all the results may be physically visible due to the
          screen size limitation.
        type: quantity
      selected_result:
        description: >
          The type of the result the user selected. The `unknown` type should
          not occur and indicates a bug. The possible types are:
          `action`,
          `addon`,
          `autofill_about`,
          `autofill_adaptive`,
          `autofill_origin`,
          `autofill_unknown`,
          `autofill_url`,
          `bookmark`,
          `calc`,
          `clipboard`,
          `experimental_addon`,
          `fxsuggest_data_sharing_opt_in`,
          `history`,
          `input_field`,
          `intervention_clear`,
          `intervention_refresh`,
          `intervention_unknown`,
          `intervention_update`,
          `keyword`,
          `merino_adm_sponsored`,
          `merino_amo`,
          `merino_top_picks`,
          `merino_wikipedia`,
          `recent_search`,
          `remote_tab`,
          `rs_adm_nonsponsored`,
          `rs_adm_sponsored`,
          `rs_amo`,
          `rs_mdn`,
          `rs_pocket`,
          `rust_adm_nonsponsored`,
          `rust_adm_sponsored`,
          `rust_amo`,
          `rust_mdn`,
          `rust_pocket`,
          `rust_yelp`,
          `search_engine`,
          `search_history`,
          `search_shortcut_button`,
          `search_suggest`,
          `search_suggest_rich`,
          `site_specific_contextual_search`,
          `tab`,
          `tab_to_search`,
          `tip_dismissal_acknowledgment`,
          `tip_onboard`,
          `tip_persist`,
          `tip_redirect`,
          `tip_unknown`,
          `top_site`,
          `trending_search`,
          `trending_search_rich`,
          `unit`,
          `url`,
          `weather`
        type: string
      selected_result_subtype:
        description: >
          The subtype of the result the user selected. Currently, only the
          action of the quick actions is the target to this. The possible values
          are: `addon`, `bookmarks`, `clear`, `downloads`, `extensions`,
          `inspect`, `logins`, `plugins`, `print`, `private`, `refresh`,
          `restart`, `screenshot`, `settings`, `themes`, `update` and
          `viewsource`. Otherwise, an empty string is returned.
        type: string
      selected_position:
        description: >
          The 1-based index of the result the user selected. If user searched
          without selection, 0 will be recorded.
        type: quantity
      provider:
        description: >
          The name of the `UrlbarProvider` that provided the selected result.
          The possible values are: `AboutPages`, `AliasEngines`, `Autofill`,
          `BookmarkKeywords`, `calculator`, `UrlbarProviderContextualSearch`,
          `HeuristicFallback`, `HistoryUrlHeuristic`, `InputHistory`,
          `UrlbarProviderInterventions`, `Omnibox`, `OpenTabs`, `Places`,
          `PrivateSearch`, `quickactions`, `UrlbarProviderQuickSuggest`,
          `RemoteTabs`, `SearchSuggestions`, `UrlbarProviderSearchTips`,
          `TabToSearch`, `TokenAliasEngines`, `UrlbarProviderTopSites`,
          `UnitConversion` and `UnifiedComplete`.
          If engagement_type is `drop_go` or `paste_go`, this will be null
          because no results are shown. And also, if selected_result is
          `experimental_addon`, it means that the user selected a result
           from an add-on using the urlbar experimental API. In this case,
           this will be the provider name specified by the add-on.
        type: string
      engagement_type:
        description: >
          Records how the user selected the result. The possible values are:
          `click`,
          `dismiss`,
          `drop_go`,
          `enter`,
          `go_button`,
          `help`,
          `inaccurate_location`,
          `manage`,
          `not_interested`,
          `not_relevant`,
          `paste_go`,
          `show_less_frequently`
        type: string
      groups:
        description: >
          Comma separated list of result groups in the order they were shown to
          the user. The groups may be repeated, since the list will match 1:1
          the results list, so we can link each result to a group. The possible
          group names are: `heuristic`, `adaptive_history`, `search_history`,
          `search_suggest`, `search_suggest_rich`, `trending_search`,
          `trending_search_rich`, `top_pick`, `top_site`, `recent_search`,
          `remote_tab`, `addon`, `general`, `suggest`, `about_page` and
          `suggested_index`. If the group did not fall into any of these, this
          will be `unknown` and a bug should be filed to investigate it. If
          engagement_type is `drop_go` or `paste_go`, this will be empty string
          because no results are shown.
        type: string
      results:
        description: >
          Comma separated list of result types in the order they were shown to
          the user. The `unknown` type should not occur and indicates a bug. The
          possible types are:
          `action`,
          `addon`,
          `autofill_about`,
          `autofill_adaptive`,
          `autofill_origin`,
          `autofill_unknown`,
          `autofill_url`,
          `bookmark`,
          `calc`,
          `clipboard`,
          `fxsuggest_data_sharing_opt_in`,
          `history`,
          `intervention_clear`,
          `intervention_refresh`,
          `intervention_unknown`,
          `intervention_update`,
          `keyword`,
          `merino_adm_sponsored`,
          `merino_amo`,
          `merino_top_picks`,
          `merino_wikipedia`,
          `recent_search`,
          `remote_tab`,
          `rs_adm_nonsponsored`,
          `rs_adm_sponsored`,
          `rs_amo`,
          `rs_mdn`,
          `rs_pocket`,
          `rust_adm_nonsponsored`,
          `rust_adm_sponsored`,
          `rust_amo`,
          `rust_mdn`,
          `rust_pocket`,
          `rust_yelp`,
          `search_engine`,
          `search_history`,
          `search_suggest`,
          `search_suggest_rich`,
          `tab`,
          `tab_to_search`,
          `tip_dismissal_acknowledgment`,
          `tip_onboard`,
          `tip_persist`,
          `tip_redirect`,
          `tip_unknown`,
          `top_site`,
          `trending_search`,
          `trending_search_rich`,
          `unit`,
          `url`,
          `weather`
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797265
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797265#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247#c3
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  exposure:
    type: event
    description: >
      Recorded when client is exposed to urlbar experiment results.
    extra_keys:
      results:
        description: >
          Comma separated list of results that were visible to the user.
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819766
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819766#c9
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  potential_exposure:
    type: event
    description: >
      This event is recorded in the `urlbar-potential-exposure` ping, which is
      submitted at the end of urlbar sessions during which the user typed a
      keyword defined by the Nimbus variable `potentialExposureKeywords`. A
      "session" begins when the user focuses the urlbar and ends with an
      engagement or abandonment. The ping will contain one event per unique
      keyword that is typed during the session. This ping is not submitted for
      sessions in private windows.
    extra_keys:
      keyword:
        type: string
        description: >
          The matched keyword.
      terminal:
        type: boolean
        description: >
          Whether the matched keyword was present at the end of the urlbar
          session. If true, the session ended with the keyword. If false, the
          keyword was typed at some point during the session but the session
          did not end with it.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875
    data_sensitivity:
      - stored_content
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - urlbar-potential-exposure

  quick_suggest_contextual_opt_in:
    type: event
    description: >
      Recorded when the contextual opt-in UI is shown or interacted with.
    extra_keys:
      interaction:
        description: >
          The type of interaction. Possible values: `impression`, `dismiss`,
          `allow`, `learn_more`.
        type: string
      top_position:
        description: >
          Whether the opt-in result appeared at the very top of results or at
          the bottom, after one-off buttons.
        type: boolean
      say_hello:
        description: >
          Whether the alternative copy was used for the opt-in result.
        type: boolean
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1852058
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1852058#c2
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: 128

  pref_max_results:
    lifetime: application
    type: quantity
    unit: integer
    description: >
      Maximum results to show in the Address Bar.
      Corresponds to the value of the `browser.urlbar.maxRichResults` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - events

  pref_suggest_data_collection:
    lifetime: application
    type: boolean
    description: >
      Whether the user has opted in to data collection for Firefox Suggest,
      i.e., online suggestions served from Merino.
      Corresponds to the value of the
      `browser.urlbar.quicksuggest.dataCollection.enabled` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849726
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - events

  pref_suggest_nonsponsored:
    lifetime: application
    type: boolean
    description: >
      Whether non-sponsored quick suggest results are shown in the urlbar.
      Corresponds to the value of the
      `browser.urlbar.suggest.quicksuggest.nonsponsored` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849726
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - events

  pref_suggest_sponsored:
    lifetime: application
    type: boolean
    description: >
      Whether sponsored quick suggest results are shown in the urlbar.
      Corresponds to the value of the
      `browser.urlbar.suggest.quicksuggest.sponsored` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849726
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - events

  pref_suggest_topsites:
    lifetime: application
    type: boolean
    description: >
      Whether topsite results are enabled in the urlbar.
      Corresponds to the value of the `browser.urlbar.suggest.topsites` pref.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    send_in_pings:
      - events

# Replacement for PingCentre "quicksuggest-block|impression|click" pings.
quick_suggest:
  ping_type:
    type: string
    description: >
      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".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  position:
    type: quantity
    unit: QuickSuggest position
    description: >
      The position (1-based) of the QuickSuggest item being interatcted with.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  suggested_index:
    type: string
    description: >
      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.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  suggested_index_relative_to_group:
    type: boolean
    description: >
      Whether `suggested_index` is relative to the "Firefox Suggest" group. If
      false, it is relative to the entire list of suggestions.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  source:
    type: string
    description: >
      The source of the interaction. E.g. "urlbar".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  match_type:
    type: string
    description: >
      Whether this was a best/top match or not. Either "best-match" or
      "firefox-suggest".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  block_id:
    type: string
    description: >
      A unique identifier for the suggestion (a.k.a. a keywords block).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  improve_suggest_experience:
    type: boolean
    description: >
      Whether the "Improve Suggest Experience" checkbox is checked.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  advertiser:
    type: string
    description: >
      The name of the advertiser providing the sponsored TopSite.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
      - web_activity
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  request_id:
    type: string
    description: >
      A request identifier for each API request to
      [Merino](https://mozilla-services.github.io/merino/).
      Only present for suggestions provided by Merino.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
      - web_activity
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  is_clicked:
    type: boolean
    description: >
      Whether this quicksuggest-impression ping was for an item that was
      clicked.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  reporting_url:
    type: url
    description: >
      The url to report this interaction to.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - web_activity
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  context_id:
    type: uuid
    description: >
      An identifier to identify users for Contextual Services user interaction pings.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - technical
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest

  iab_category:
    type: string
    description: >
      The suggestion's category. Either "22 - Shopping" or "5 - Educational".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
    data_sensitivity:
      - interaction
      - web_activity
    notification_emails:
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - quick-suggest