Telemetry

Telemetry endpoints submit science events and aggregated metrics.

Metric Object

A metric records a count or distribution sample.

Metric Structure
FieldTypeDescription
namestringThe metric name
typestringThe metric type
tagsarray[string]Tags in name:value format
value?numberThe distribution value; present for distribution metrics
Metric Type
ValueDescription
countA count increment
distributionA distribution sample
Example Metric
{
  "name": "app.open_latency",
  "type": "distribution",
  "tags": ["design_id:tabs_ia", "platform:web", "release_channel:canary"],
  "value": 184.5
}

Metrics Client Info Object

Metrics client information identifies the client build that produced a batch.

Metrics Client Info Structure
FieldTypeDescription
built_atstringThe client build timestamp in milliseconds
build_numberstringThe client build number

Endpoints

Submit Metrics v2

POST/metrics/v2

Submits a batch of up to 100 metrics.

JSON Params
FieldTypeDescription
metricsarray[metric object]The metrics in the batch
client_infometrics client info objectInformation about the client build
Example JSON Params
{
  "metrics": [
    {
      "name": "app.open",
      "type": "count",
      "tags": ["design_id:tabs_ia", "platform:web", "release_channel:canary"]
    }
  ],
  "client_info": {
    "built_at": "1781640804075",
    "build_number": "564083"
  }
}