tenfourfox/toolkit/components/telemetry/docs/uitour-ping.rst
Cameron Kaiser c9b2922b70 hello FPR
2017-04-19 00:56:45 -07:00

25 lines
482 B
ReStructuredText

"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::
{
version: 1,
type: "uitour-tag",
clientId: <string>,
payload: {
tagName: <string>,
tagValue: <string>
}
}
See also: :doc:`common ping fields <common-ping>`