New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

Elastic Docs › ›Intake API ›Events API
« Errors Example Request Body »

Metricsedit

Metrics contain application metric data captured by an APM agent.

Metric Schemaedit

The APM Server uses JSON Schema for validating requests. The specification for metrics is defined below:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "$id": "docs/spec/metricsets/common_metricset.json",
    "type": "object",
    "description": "Metric data captured by an APM agent",
    "properties": {
        "samples": {
            "type": ["object"],
            "description": "Sampled application metrics collected from the agent.",
            "patternProperties": {
                "^[^*\"]*$": {
                    "$ref": "sample.json"
                }
            },
            "additionalProperties": false
        },
        "tags": {
            "$ref": "../tags.json"
        }
    },
    "required": ["samples"]
}
{
    "$id": "docs/spec/metricsets/v2_metricset.json",
    "type": "object",
    "description": "Data captured by an agent representing an event occurring in a monitored service",
    "allOf": [

        { "$ref": "common_metricset.json"  },
        { "$ref": "../timestamp_epoch.json"},
        {"required": ["timestamp"], "properties": {"timestamp": { "type": "integer" }}}
    ]
}
« Errors Example Request Body »

On this page

Was this helpful?
Feedback