Bug 1273309 - Add searches parameter core ping docs. r=gfritzsche
MozReview-Commit-ID: LHA881ZDWK9
--- a/toolkit/components/telemetry/docs/core-ping.rst
+++ b/toolkit/components/telemetry/docs/core-ping.rst
@@ -20,17 +20,17 @@ Submission will be per the Edge server s
* ``appBuildID`` is the build number
Note: Counts below (e.g. search & usage times) are “since the last
ping”, not total for the whole application lifetime.
Structure::
{
- "v": 5, // ping format version
+ "v": 6, // ping format version
"clientId": <string>, // client id, e.g.
// "c641eacf-c30c-4171-b403-f077724e848a"
"seq": <positive integer>, // running ping counter, e.g. 3
"locale": <string>, // application locale, e.g. "en-US"
"os": <string>, // OS name.
"osversion": <string>, // OS version.
"device": <string>, // Build.MANUFACTURER + " - " + Build.MODEL
// where manufacturer is truncated to 12 characters
@@ -40,16 +40,19 @@ Structure::
// UNIX epoch.
"defaultSearch": <string>, // Identifier of the default search engine,
// e.g. "yahoo".
"distributionId": <string>, // Distribution identifier (optional)
"created": <string>, // date the ping was created
// in local time, "yyyy-mm-dd"
"tz": <integer>, // timezone offset (in minutes) of the
// device when the ping was created
+ "searches": <object>, // Optional, object of search use counts in the
+ // format: { "engine.source": <pos integer> }
+ // e.g.: { "yahoo.searchbar": 3, "other.searchbar": 1 }
"experiments": [<string>, …], // Optional, array of identifiers
// for the active experiments
}
Field details
-------------
device
@@ -118,16 +121,17 @@ HTTP "Date" header
This header is used to track the submission date of the core ping in the format
specified by
`rfc 2616 sec 14.18 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18>`_,
et al (e.g. "Tue, 01 Feb 2011 14:00:00 GMT").
Version history
---------------
+* v6: added ``searches``
* v5: added ``created`` & ``tz``
* v4: ``profileDate`` will return package install time when times.json is not available
* v3: added ``defaultSearch``
* v2: added ``distributionId``
* v1: initial version
Notes
~~~~~