summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/data/uitour-ping.rst
blob: 06e4a9f49bbb40b9e7e9a2694d1713d37c1879ce (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
"uitour-tag" ping
=================

This ping is submitted via the UITour ``setTreatmentTag`` API. It may be used by
the tour to record what settings were made by a user or to track the result of
A/B experiments.

The client ID is submitted with this ping.

Structure:

.. code-block:: js

    {
      version: 1,
      type: "uitour-tag",
      clientId: <string>,
      payload: {
        tagName: <string>,
        tagValue: <string>
      }
    }

See also: :doc:`common ping fields <common-ping>`