summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/data/deletion-ping.rst
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/telemetry/docs/data/deletion-ping.rst')
-rw-r--r--toolkit/components/telemetry/docs/data/deletion-ping.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/docs/data/deletion-ping.rst b/toolkit/components/telemetry/docs/data/deletion-ping.rst
new file mode 100644
index 0000000000..dfa7fefa00
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/deletion-ping.rst
@@ -0,0 +1,26 @@
+
+"deletion" ping (obsolete)
+==========================
+
+This ping is generated when a user turns off FHR upload from the Preferences panel, changing the related ``datareporting.healthreport.uploadEnabled`` preference. This requests that all associated data from that user be deleted.
+
+This ping contains the client id and no environment data.
+
+Structure:
+
+.. code-block:: js
+
+ {
+ version: 4,
+ type: "deletion",
+ ... common ping data
+ clientId: <UUID>,
+ payload: { }
+ }
+
+Version History
+---------------
+
+- Firefox 63:
+
+ - Replaced by "optout" ping (`bug 1445921 <https://bugzilla.mozilla.org/show_bug.cgi?id=1445921>`_).