# 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 :: DOM: Notifications'

web_notification:
  insecure_context_permission_request:
    type: counter
    description: >
      Whether we saw a permission request from an insecure context.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    notification_emails:
      - krosylight@mozilla.com
    expires: never
  show_origin:
    type: labeled_counter
    description: >
      The category of the origin that calls new Notification/showNotification().
    labels:
      - first_party
      - third_party
      - nested_first_party
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    notification_emails:
      - krosylight@mozilla.com
    expires: never
  permission_origin:
    type: labeled_counter
    description: >
      The category of the origin that retrieves Notification.permission.
    labels:
      - first_party
      - third_party
      - nested_first_party
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    notification_emails:
      - krosylight@mozilla.com
    expires: never
  request_permission_origin:
    type: labeled_counter
    description: >
      The category of the origin that calls Notification.requestPermission().
    labels:
      - first_party
      - third_party
      - nested_first_party
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1914203
    notification_emails:
      - krosylight@mozilla.com
    expires: never
  shown:
    type: event
    description: >
      The event of a notification being shown to the user.
    extra_keys:
      site_category:
        description: Category of the site that triggered the notification
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    notification_emails:
      - krosylight@mozilla.com
    expires: 165
  clicked:
    type: event
    description: >
      The event of a notification being clicked by the user.
    extra_keys:
      site_category:
        description: Category of the site that triggered the notification
        type: string
      action:
        description: How this click happened
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    notification_emails:
      - krosylight@mozilla.com
    expires: 165
  ignored:
    type: event
    description: >
      The event of a notification being ignored by the user, letting the
      notification enter the notification center.
    extra_keys:
      site_category:
        description: Category of the site that triggered the notification
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    notification_emails:
      - krosylight@mozilla.com
    expires: 165
  dismissed:
    type: event
    description: >
      The event of a notification being dismissed by the user.
    extra_keys:
      site_category:
        description: Category of the site that triggered the notification
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2046221
    notification_emails:
      - krosylight@mozilla.com
    expires: 165