search

PutMetrics (POST /v1/data-receiver/metrics)

The PutMetrics method creates one or more metric data points.

Fields

FieldRequired?TypeDescription
detailedResponseNoBooleanProvide specific feedback when parsing fails (true) or no specific feedback (false). The default is false.
metricsYesArray

One or more metric data point specifications.

The remaining fields of this table specify a data point.

timestampYesNumber

The date and time for the data point, specified as milliseconds since the epoch (January 1, 1970 at 00:00:00 UTC).

Zenoss Cloud does not accept requests with timestamp values that are more than 24 hours old.

metricYesStringThe name of the metric.
valueYesNumberThe numeric value to record for the metric.
dimensionsYesObject

The key-value pair or pairs that uniquely identify the entity associated with the metric.

The contents of this object must match the key-value pairs of one entity's dimension field. The pairs may be arranged in any order.

metadataFieldsNoObjectOne or more key-value pairs of additional information about the metric.

Status codes

  • 200 (full or partial success; see response message)
  • 500 (missing or invalid authentication key)

Example

PutMetrics Request
curl https://api.zenoss.io/v1/data-receiver/metrics \
  -H "content-type: application/json" \
  -H "zenoss-api-key: YOUR-API-KEY" \
  -X POST -s -S -d \
'{
  "detailedResponse": true,
  "metrics": [
    {
      "timestamp": 1600807394000,
      "metric": "my.metric",
      "value": 1349.3,
      "dimensions": {
        "source": "my.simple.app",
        "source-type": "com.example.simple"
      }
    },
    {
      "timestamp": 1600807647000,
      "metric": "my.metric",
      "value": 1481.7,
      "dimensions": {
        "source": "my.simple.app",
        "source-type": "com.example.simple"
      }
    }
  ]
}'
PutMetrics Response
{
  "succeeded": 2
  "message": "successfully processed 2 out of 2 metrics"
}