MetricDescriptor

{
  "type": "object",
  "description": "Describes a single metric including its metadata, supported aggregations, entity dimensions, and default aggregation settings.",
  "properties": {
    "metricId": {
      "type": "string",
      "description": "The fully qualified key of the metric, potentially including applied transformations. For example, builtin:host.cpu.usage:avg.",
      "example": "abc123"
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable display name of the metric.",
      "example": "Production Service"
    },
    "description": {
      "type": "string",
      "description": "A detailed description of what the metric measures.",
      "example": "Example description."
    },
    "unit": {
      "type": "string",
      "description": "The unit of the metric values. For example, Percent, Byte, MilliSecond.",
      "example": "example-value"
    },
    "dduBillable": {
      "type": "boolean",
      "description": "Whether ingesting this metric consumes Davis Data Units (DDUs).",
      "example": true
    },
    "created": {
      "type": "integer",
      "description": "The Unix timestamp in milliseconds when the metric was created.",
      "format": "int64",
      "example": 500
    },
    "lastWritten": {
      "type": "integer",
      "description": "The Unix timestamp in milliseconds when the metric was last written.",
      "format": "int64",
      "example": 500
    },
    "entityType": {
      "type": "array",
      "description": "The entity types that can be used to filter this metric, e.g., HOST, SERVICE, PROCESS_GROUP.",
      "example": [
        "STANDARD"
      ],
      "items": {
        "type": "string"
      }
    },
    "aggregationTypes": {
      "type": "array",
      "description": "The list of aggregation types supported for this metric. Valid values include min, max, sum, count, avg, median, and percentile.",
      "example": [
        "min"
      ],
      "items": {
        "type": "string",
        "enum": [
          "min",
          "max",
          "sum",
          "count",
          "avg",
          "median",
          "percentile"
        ]
      }
    },
    "dimensionDefinitions": {
      "type": "array",
      "description": "The list of dimension definitions for this metric. Each dimension provides a label for data splitting.",
      "example": [
        {
          "key": "example-value",
          "name": "Production Service",
          "type": "STANDARD",
          "displayName": "Production Service"
        }
      ],
      "items": {
        "type": "object",
        "description": "Defines a single dimension of a metric.",
        "properties": {
          "key": {
            "type": "string",
            "description": "The unique key identifying this dimension.",
            "example": "example-value"
          },
          "name": {
            "type": "string",
            "description": "The display name of the dimension.",
            "example": "Production Service"
          },
          "type": {
            "type": "string",
            "description": "The type of the dimension. For example, ENTITY for entity dimensions or STRING for string dimensions.",
            "example": "STANDARD"
          },
          "displayName": {
            "type": "string",
            "description": "The human-readable display name of the dimension.",
            "example": "Production Service"
          }
        }
      }
    },
    "transformations": {
      "type": "array",
      "description": "The list of transformation expressions that can be applied to this metric using the metric selector.",
      "example": [
        "example-value"
      ],
      "items": {
        "type": "string"
      }
    },
    "defaultAggregation": {
      "type": "object",
      "description": "The default aggregation setting for the metric.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The aggregation type to apply when no aggregation is specified in the query. For example, avg, sum, or max.",
          "example": "min",
          "enum": [
            "min",
            "max",
            "sum",
            "count",
            "avg",
            "median",
            "percentile"
          ]
        },
        "parameter": {
          "type": "number",
          "description": "The parameter for the aggregation type, used for percentile aggregation to specify the percentile value (e.g., 95).",
          "format": "double",
          "example": 87.5
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MetricDescriptor"
}