| 12
 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
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
 1000
 1001
 1002
 1003
 1004
 1005
 1006
 1007
 1008
 1009
 1010
 1011
 1012
 1013
 1014
 1015
 1016
 1017
 1018
 1019
 1020
 1021
 1022
 1023
 1024
 1025
 1026
 1027
 1028
 1029
 1030
 1031
 1032
 1033
 1034
 1035
 1036
 1037
 1038
 1039
 1040
 1041
 1042
 1043
 1044
 1045
 1046
 1047
 1048
 1049
 1050
 1051
 1052
 1053
 1054
 1055
 1056
 1057
 1058
 1059
 1060
 1061
 1062
 1063
 1064
 1065
 1066
 1067
 1068
 1069
 1070
 1071
 1072
 1073
 1074
 1075
 1076
 1077
 1078
 1079
 1080
 1081
 1082
 1083
 1084
 1085
 1086
 1087
 1088
 1089
 1090
 1091
 1092
 1093
 1094
 1095
 1096
 1097
 1098
 1099
 1100
 1101
 1102
 1103
 1104
 1105
 1106
 1107
 1108
 1109
 1110
 1111
 1112
 1113
 1114
 
 | # 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:
  - "Core :: Machine Learning"
genai.chatbot:
  # metrics
  badges:
    type: string
    lifetime: application
    description: >
      Which badges are shown in various surfaces (comma separated).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  enabled:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot feature is enabled.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  menu:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot menu is shown without provider.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  page:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot page level features are enabled.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  provider:
    type: string
    lifetime: application
    description: >
      Indicates id of activated chatbot provider or "custom" or "none"
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  shortcuts:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot feature would show shortcuts on selection.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  shortcuts_custom:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot feature would show shortcuts custom input.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  sidebar:
    type: boolean
    lifetime: application
    description: >
      Indicates if the chatbot feature would open in sidebar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  # events
  contextmenu_choose:
    type: event
    description: >
      Choose/open chatbot provider was clicked from the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Current provider id.
  contextmenu_prompt_click:
    type: event
    description: >
      Chatbot prompt was clicked from the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      prompt:
        type: string
        description: Selected prompt id.
      provider:
        type: string
        description: Selected provider id.
      selection:
        type: quantity
        description: Selected text length.
  contextmenu_remove:
    type: event
    description: >
      Chatbot provider was removed from the context menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1946099
    data_reviews:
      - https://phabricator.services.mozilla.com/D237127
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Removed provider id.
  experiment_checkbox_click:
    type: event
    description: >
      Chatbot experiment checkbox was clicked to enable/disable.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      enabled:
        type: boolean
        description: New/current state is enabled.
  keyboard_shortcut:
    type: event
    description: >
      Chatbot sidebar toggled with keyboard shortcut.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1905027
    data_reviews:
      - https://phabricator.services.mozilla.com/D226205
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      enabled:
        type: boolean
        description: Chatbot was already enabled.
      sidebar:
        type: string
        description: Sidebar is currently open.
  length_disclaimer:
    type: event
    description: >
      Warning message for length disclaimer is shown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1980228
    data_reviews:
      - https://phabricator.services.mozilla.com/D260463
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      type:
        type: string
        description: Content scope.
      length:
        type: quantity
        description: Page content length.
      provider:
        type: string
        description: Current provider id.
  length_disclaimer_dismissed:
    type: event
    description: >
      Warning message is dismissed.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1980228
    data_reviews:
      - https://phabricator.services.mozilla.com/D260463
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      type:
        type: string
        description: Content scope.
      provider:
        type: string
        description: Current provider id.
  onboarding_close:
    type: event
    description: >
      Chatbot onboarding closed from provider choice.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider was last selected.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_finish:
    type: event
    description: >
      Chatbot onboarding finished with start chatting button.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider was last selected.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_learn_more:
    type: event
    description: >
      Chatbot onboarding opened feature learn more link.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider was last selected.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_provider_choice_displayed:
    type: event
    description: >
      Chatbot onboarding impression for provider choice screen.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Current provider id.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_provider_learn:
    type: event
    description: >
      Chatbot onboarding opened provider learn more link.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_provider_selection:
    type: event
    description: >
      Chatbot onboarding selected a provider.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider.
      step:
        type: quantity
        description: Onboarding screen number.
  onboarding_provider_terms:
    type: event
    description: >
      Chatbot onboarding opened provider terms link.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Which provider.
      step:
        type: quantity
        description: Onboarding screen number.
      text:
        type: string
        description: Which terms link.
  prompt_click:
    type: event
    description: >
      Chatbot prompt requested.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      content_type:
        type: string
        description: Type of content, e.g., page, selection.
      prompt:
        type: string
        description: Selected prompt id.
      provider:
        type: string
        description: Selected provider id.
      reader_mode:
        type: boolean
        description: Whether reader mode text was used.
      selection:
        type: quantity
        description: Page content length.
      source:
        type: string
        description: Entrypoint for the request, e.g., callout, footer, page.
  provider_change:
    type: event
    description: >
      Chatbot provider UI changed providers.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      current:
        type: string
        description: Current provider id.
      previous:
        type: string
        description: Previous provider id.
      surface:
        type: string
        description: Which UI surface.
  shortcuts_checkbox_click:
    type: event
    description: >
      Chatbot shortcuts checkbox was clicked to enable/disable.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      enabled:
        type: boolean
        description: New/current state is enabled.
  shortcuts_displayed:
    type: event
    description: >
      Shortcuts displayed on text selection.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      delay:
        type: quantity
        description: Milliseconds from mousedown to showing.
      inputType:
        type: string
        description: Type if user can edit, e.g., contenteditable, input, textarea.
      selection:
        type: quantity
        description: Selected text length.
  shortcuts_expanded:
    type: event
    description: >
      Shortcuts expanded to show prompts.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1922379
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
      - https://phabricator.services.mozilla.com/D225895
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      selection:
        type: quantity
        description: Selected text length.
      provider:
        type: string
        description: Selected provider id.
      warning:
        type: boolean
        description: Warning label is shown to the user.
  shortcuts_hide_click:
    type: event
    description: >
      Chatbot hide shortcuts was clicked from the shortcuts.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      selection:
        type: quantity
        description: Selected text length.
  shortcuts_prompt_click:
    type: event
    description: >
      Chatbot prompt was clicked from the shortcuts.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
    data_reviews:
      - https://phabricator.services.mozilla.com/D217782
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      prompt:
        type: string
        description: Selected prompt id.
      provider:
        type: string
        description: Selected provider id.
      selection:
        type: quantity
        description: Selected text length.
  sidebar_close_click:
    type: event
    description: >
      Chatbot close X clicked.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Selected provider id.
  sidebar_more_menu_click:
    type: event
    description: >
      Chatbot more menu clicked an action.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      action:
        type: string
        description: Which action was clicked.
      provider:
        type: string
        description: Selected provider id.
  sidebar_more_menu_display:
    type: event
    description: >
      Chatbot more menu opened.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Selected provider id.
  sidebar_provider_menu_click:
    type: event
    description: >
      Chatbot provider menu clicked an action.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
    data_reviews:
      - https://phabricator.services.mozilla.com/D223938
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      action:
        type: string
        description: Which action was clicked.
      provider:
        type: string
        description: Selected provider id.
  sidebar_toggle:
    type: event
    description: >
      Chatbot sidebar panel was toggled open/close.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
    data_reviews:
      - https://phabricator.services.mozilla.com/D214470
    data_sensitivity:
      - interaction
    expires: 147
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      opened:
        type: boolean
        description: New/current state of sidebar is open.
      provider:
        type: string
        description: Selected provider id.
      reason:
        type: string
        description: Why panel is toggling.
      version:
        type: string
        description: The active version of sidebar (either "old" or "new").
  summarize_page:
    type: event
    description: >
      Chatbot page summarization was requested.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1974185
    data_reviews:
      - https://phabricator.services.mozilla.com/D255286
    data_sensitivity:
      - interaction
    expires: 154
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      provider:
        type: string
        description: Selected provider id.
      reader_mode:
        type: boolean
        description: Whether reader mode text was used.
      selection:
        type: quantity
        description: Page content length.
      source:
        type: string
        description: Entrypoint for the request, e.g., callout, footer, page.
genai.linkpreview:
  # metrics
  ai_optin:
    type: boolean
    lifetime: application
    description: >
      Records if the user has opted-in to use AI for key points generation
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1969012
    data_reviews:
      - https://phabricator.services.mozilla.com/D251779
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  enabled:
    type: boolean
    lifetime: application
    description: >
      Records if the user has link previews enabled
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  key_points:
    type: boolean
    lifetime: application
    description: >
      Records if the user defaults to expanded state for key point generation
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1969012
    data_reviews:
      - https://phabricator.services.mozilla.com/D251779
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  shortcut:
    type: string
    lifetime: application
    description: >
      Records which type of shortcut the user selected for Link Previews (comma separated if more than one)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1969012
    data_reviews:
      - https://phabricator.services.mozilla.com/D251779
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - metrics
  # events
  card_ai_consent:
    type: event
    description: >
      Recorded when the user interacts with the AI consent dialog
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951146
    data_reviews:
      - https://phabricator.services.mozilla.com/D249104
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      option:
        type: string
        description: User's response - cancel, continue, or learn
  card_close:
    type: event
    description: >
      Recorded when the user closes the card
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      duration:
        type: quantity
        description: Milliseconds the card stayed open
      tab:
        type: string
        description: The type of tab where the event occurred. Potential values home, newtab
  card_link:
    type: event
    description: >
      Recorded when the user clicks on a link from the card
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      key_points:
        type: boolean
        description: Whether key points were visible when the link was clicked.
      source:
        type: string
        description: Which link, e.g., error, retry, title, visit
      tab:
        type: string
        description: The type of tab where the event occurred. Potential values home, newtab
  fetch:
    type: event
    description: >
      Recorded when the browser fetches the page to be previewed
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      description:
        type: boolean
        description: Description detected
      image:
        type: boolean
        description: Image detected
      length:
        type: quantity
        description: Length of the article
      outcome:
        type: string
        description: success or error
      sitename:
        type: boolean
        description: Site name detected
      skipped:
        type: boolean
        description: Skipped for newer fetch
      tab:
        type: string
        description: The type of tab where the event occurred. Potential values home, newtab
      time:
        type: quantity
        description: Milliseconds to fetch and extract page
      title:
        type: boolean
        description: Title detected
  generate:
    type: event
    description: >
      Recorded when the model finishes generating the preview
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      delay:
        type: quantity
        description: Milliseconds waiting on previous
      download:
        type: quantity
        description: Milliseconds to finish download
      latency:
        type: quantity
        description: Milliseconds to output first sentence
      outcome:
        type: string
        description: success or prefetch or error
      sentences:
        type: quantity
        description: Number of sentences generated
      time:
        type: quantity
        description: Milliseconds to generate full result
  key_points_toggle:
    type: event
    description: >
      Recorded when the user toggles the key points section
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1961215
    data_reviews:
      - https://phabricator.services.mozilla.com/D249851
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      expand:
        type: boolean
        description: Link preview card is expanded
  onboarding_card:
    type: event
    description: >
      Recorded when the link preview onboarding is displayed and how the user interacts with it.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1961212
    data_reviews:
      - https://phabricator.services.mozilla.com/D249855
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      action:
        type: string
        description: User's action on the dialogue - "view" (impression), "try_it_now", "close"
      type:
        type: string
        description: The type of onboarding trigger, e.g. "longPress" or "shiftKey".
  pref_changed:
    type: event
    description: >
      Recorded when the user toggles prefs
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1969012
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
      - https://phabricator.services.mozilla.com/D251779
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      enabled:
        type: boolean
        description: New/current state is enabled
      pref:
        type: string
        description: Which checkbox was clicked. Potential values link_previews, key_points, shift, shift_option, long_press
  start:
    type: event
    description: >
      Recorded when the user initiates a link preview
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1951148
    data_reviews:
      - https://phabricator.services.mozilla.com/D243790
    data_sensitivity:
      - interaction
    expires: 150
    notification_emails:
      - elee@mozilla.com
    send_in_pings:
      - events
    extra_keys:
      cached:
        type: boolean
        description: Reusing existing panel
      source:
        type: string
        description: Entrypoint shortcut (longpress, shift, shift-alt), context, onboarding
      tab:
        type: string
        description: The type of tab where the event occurred. Potential values home, newtab
 |