Skip to main content

MetricQueryResponse

metric_namestring

Metric name

metric_typestring

Metric type

unitstring

Metric unit

time_range object
startstring<date-time>

Start of time range

endstring<date-time>

End of time range

aggregate_intervalstring

Aggregation bucket interval used

series object[]

Grouped metric data

  • Array [
  • group object

    Group key-value pairs

    property name*string
    data_points object[]

    Time-bucketed data points

  • Array [
  • bucketstring<date-time>

    Time bucket start

    avg_valuenumber<double>

    Average value

    min_valuenumber<double>

    Minimum value

    max_valuenumber<double>

    Maximum value

    sample_countinteger<int64>

    Number of data points in bucket

    total_countinteger<int64>

    Total count (histogram/summary only)

    total_sumnumber<double>

    Total sum (histogram/summary only)

  • ]
  • ]
  • countinteger

    Total data points returned

    has_moreboolean

    Whether more data is available

    MetricQueryResponse
    {
    "metric_name": "string",
    "metric_type": "string",
    "unit": "string",
    "time_range": {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z"
    },
    "aggregate_interval": "string",
    "series": [
    {
    "group": {},
    "data_points": [
    {
    "bucket": "2024-07-29T15:51:28.071Z",
    "avg_value": 0,
    "min_value": 0,
    "max_value": 0,
    "sample_count": 0,
    "total_count": 0,
    "total_sum": 0
    }
    ]
    }
    ],
    "count": 0,
    "has_more": true
    }
    Was this page helpful?