pings.yaml

# 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/.

# This file defines the pings that are recorded by the Glean SDK.
# Their code APIs is automatically generated, at build time using,
# the `glean_parser` PyPI package.

---
$schema: moz://mozilla.org/schemas/glean/pings/2-0-0

enrollment:
  description: |
    This ping is sent at the end of the user onboarding process,
    when and if the user joins the platform.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-rally/rally-core-addon/issues/117
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1663857#c5
  notification_emails:
    - than@mozilla.com

unenrollment:
  description: |
    This ping is sent when and if the user chooses to leave the platform.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-rally/rally-core-addon/issues/117
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1663857#c5
  notification_emails:
    - than@mozilla.com

study-enrollment:
  description: |
    This ping is sent when user clicks the Join button for a study
    and accepts the study policy.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-rally/rally-core-addon/issues/117
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1663857#c5
  notification_emails:
    - than@mozilla.com

study-unenrollment:
  description: |
    This ping is sent when user leaves a study.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-rally/rally-core-addon/issues/545
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1646151#c32
  notification_emails:
    - than@mozilla.com

demographics:
  description: |
    After a user joins the platform they are asked to fill a
    demographic survey, in order to help researchers parse the
    data. The survey is optional and can be partially filled: this
    ping is submitted right after the survey is filled.
  include_client_id: false
  send_if_empty: true
  bugs:
    - https://github.com/mozilla-rally/rally-core-addon/issues/545
  data_reviews:
    - https://github.com/mozilla-rally/rally-core-addon/pull/139#issuecomment-736024232
  notification_emails:
    - than@mozilla.com