Hanzo
OpenapiO11y

Returns ingested vs retained series over time across all volume-control rules,…

Returns ingested vs retained series over time across all volume-control rules, in hourly buckets, in the query-range time-series response shape.

GET /v1/o11y/metric_reduction_rules/timeseries

Addresshttps://api.hanzo.ai/v1/o11y/metric_reduction_rules/timeseries
MethodGET
OperationGetMetricReductionRuleTimeseries
AuthAuthorization: Bearer $HANZO_API_KEY

Returns ingested vs retained series over time across all volume-control rules, in hourly buckets, in the query-range time-series response shape.

Request

GET /v1/o11y/metric_reduction_rules/timeseries takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200o11y.O11yReductionSeriesOutok

200 body — 97 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yQueryRange
data.databodyo11y.O11yQueryRangeData
data.data.resultsbodyo11y.O11yReductionSeriesResult[]Results are the per-query results, each a set of aggregated series.
data.data.results[].aggregationsbodyo11y.O11yAggregation[]Aggregations are the query's aggregation buckets.
data.data.results[].aggregations[].aliasbodystringAlias is the aggregation's alias.
data.data.results[].aggregations[].anomalyScoresbodyo11y.O11yMetricSeries[]AnomalyScores are anomaly overlays.
data.data.results[].aggregations[].anomalyScores[].labelsbodyo11y.O11yMetricLabel[]Labels identify the series.
data.data.results[].aggregations[].anomalyScores[].labels[].keybodyo11y.O11yMetricField
data.data.results[].aggregations[].anomalyScores[].labels[].key.descriptionbodystringDescription describes the field.
data.data.results[].aggregations[].anomalyScores[].labels[].key.fieldContextbodystringFieldContext is the context the field lives in, e.g.
data.data.results[].aggregations[].anomalyScores[].labels[].key.fieldDataTypebodystringFieldDataType is the field's data type.
data.data.results[].aggregations[].anomalyScores[].labels[].key.namebodystringName is the field's name.
data.data.results[].aggregations[].anomalyScores[].labels[].key.signalbodystringSignal is the telemetry signal the field belongs to.
data.data.results[].aggregations[].anomalyScores[].labels[].key.unitbodystringUnit is the field's unit.
data.data.results[].aggregations[].anomalyScores[].labels[].valuebodyobjectValue is the label's value.
data.data.results[].aggregations[].anomalyScores[].valuesbodyo11y.O11yMetricPoint[]Values are the series' points, in time order.
data.data.results[].aggregations[].anomalyScores[].values[].partialbodybooleanPartial marks a point whose bucket the window only partly covers.
data.data.results[].aggregations[].anomalyScores[].values[].timestampbodyintegerTimestamp is the point's time as a Unix timestamp in milliseconds.
data.data.results[].aggregations[].anomalyScores[].values[].valuebodynumberValue is the point's value.
data.data.results[].aggregations[].anomalyScores[].values[].valuesbodynumber[]Values carries the bucket values of a heatmap point.
data.data.results[].aggregations[].indexbodyintegerIndex is the aggregation's position in the query.
data.data.results[].aggregations[].lowerBoundSeriesbodyo11y.O11yMetricSeries[]LowerBoundSeries are forecast lower bounds.
data.data.results[].aggregations[].lowerBoundSeries[].labelsbodyo11y.O11yMetricLabel[]Labels identify the series.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].keybodyo11y.O11yMetricField
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.descriptionbodystringDescription describes the field.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.fieldContextbodystringFieldContext is the context the field lives in, e.g.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.fieldDataTypebodystringFieldDataType is the field's data type.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.namebodystringName is the field's name.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.signalbodystringSignal is the telemetry signal the field belongs to.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].key.unitbodystringUnit is the field's unit.
data.data.results[].aggregations[].lowerBoundSeries[].labels[].valuebodyobjectValue is the label's value.
data.data.results[].aggregations[].lowerBoundSeries[].valuesbodyo11y.O11yMetricPoint[]Values are the series' points, in time order.
data.data.results[].aggregations[].lowerBoundSeries[].values[].partialbodybooleanPartial marks a point whose bucket the window only partly covers.
data.data.results[].aggregations[].lowerBoundSeries[].values[].timestampbodyintegerTimestamp is the point's time as a Unix timestamp in milliseconds.
data.data.results[].aggregations[].lowerBoundSeries[].values[].valuebodynumberValue is the point's value.
data.data.results[].aggregations[].lowerBoundSeries[].values[].valuesbodynumber[]Values carries the bucket values of a heatmap point.
data.data.results[].aggregations[].metabodyo11y.O11yAggregationMeta
data.data.results[].aggregations[].meta.unitbodystringUnit is the aggregation's unit.
data.data.results[].aggregations[].predictedSeriesbodyo11y.O11yMetricSeries[]PredictedSeries are forecast overlays, when the query asked for them.
data.data.results[].aggregations[].predictedSeries[].labelsbodyo11y.O11yMetricLabel[]Labels identify the series.
data.data.results[].aggregations[].predictedSeries[].labels[].keybodyo11y.O11yMetricField
data.data.results[].aggregations[].predictedSeries[].labels[].key.descriptionbodystringDescription describes the field.
data.data.results[].aggregations[].predictedSeries[].labels[].key.fieldContextbodystringFieldContext is the context the field lives in, e.g.
data.data.results[].aggregations[].predictedSeries[].labels[].key.fieldDataTypebodystringFieldDataType is the field's data type.
data.data.results[].aggregations[].predictedSeries[].labels[].key.namebodystringName is the field's name.
data.data.results[].aggregations[].predictedSeries[].labels[].key.signalbodystringSignal is the telemetry signal the field belongs to.
data.data.results[].aggregations[].predictedSeries[].labels[].key.unitbodystringUnit is the field's unit.
data.data.results[].aggregations[].predictedSeries[].labels[].valuebodyobjectValue is the label's value.
data.data.results[].aggregations[].predictedSeries[].valuesbodyo11y.O11yMetricPoint[]Values are the series' points, in time order.
data.data.results[].aggregations[].predictedSeries[].values[].partialbodybooleanPartial marks a point whose bucket the window only partly covers.
data.data.results[].aggregations[].predictedSeries[].values[].timestampbodyintegerTimestamp is the point's time as a Unix timestamp in milliseconds.
data.data.results[].aggregations[].predictedSeries[].values[].valuebodynumberValue is the point's value.
data.data.results[].aggregations[].predictedSeries[].values[].valuesbodynumber[]Values carries the bucket values of a heatmap point.
data.data.results[].aggregations[].seriesbodyo11y.O11yMetricSeries[]Series are the aggregated time series.
data.data.results[].aggregations[].series[].labelsbodyo11y.O11yMetricLabel[]Labels identify the series.
data.data.results[].aggregations[].series[].labels[].keybodyo11y.O11yMetricField
data.data.results[].aggregations[].series[].labels[].key.descriptionbodystringDescription describes the field.
data.data.results[].aggregations[].series[].labels[].key.fieldContextbodystringFieldContext is the context the field lives in, e.g.
data.data.results[].aggregations[].series[].labels[].key.fieldDataTypebodystringFieldDataType is the field's data type.
data.data.results[].aggregations[].series[].labels[].key.namebodystringName is the field's name.
data.data.results[].aggregations[].series[].labels[].key.signalbodystringSignal is the telemetry signal the field belongs to.
data.data.results[].aggregations[].series[].labels[].key.unitbodystringUnit is the field's unit.
data.data.results[].aggregations[].series[].labels[].valuebodyobjectValue is the label's value.
data.data.results[].aggregations[].series[].valuesbodyo11y.O11yMetricPoint[]Values are the series' points, in time order.
data.data.results[].aggregations[].series[].values[].partialbodybooleanPartial marks a point whose bucket the window only partly covers.
data.data.results[].aggregations[].series[].values[].timestampbodyintegerTimestamp is the point's time as a Unix timestamp in milliseconds.
data.data.results[].aggregations[].series[].values[].valuebodynumberValue is the point's value.
data.data.results[].aggregations[].series[].values[].valuesbodynumber[]Values carries the bucket values of a heatmap point.
data.data.results[].aggregations[].upperBoundSeriesbodyo11y.O11yMetricSeries[]UpperBoundSeries are forecast upper bounds.
data.data.results[].aggregations[].upperBoundSeries[].labelsbodyo11y.O11yMetricLabel[]Labels identify the series.
data.data.results[].aggregations[].upperBoundSeries[].labels[].keybodyo11y.O11yMetricField
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.descriptionbodystringDescription describes the field.
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.fieldContextbodystringFieldContext is the context the field lives in, e.g.
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.fieldDataTypebodystringFieldDataType is the field's data type.
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.namebodystringName is the field's name.
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.signalbodystringSignal is the telemetry signal the field belongs to.
data.data.results[].aggregations[].upperBoundSeries[].labels[].key.unitbodystringUnit is the field's unit.
data.data.results[].aggregations[].upperBoundSeries[].labels[].valuebodyobjectValue is the label's value.
data.data.results[].aggregations[].upperBoundSeries[].valuesbodyo11y.O11yMetricPoint[]Values are the series' points, in time order.
data.data.results[].aggregations[].upperBoundSeries[].values[].partialbodybooleanPartial marks a point whose bucket the window only partly covers.
data.data.results[].aggregations[].upperBoundSeries[].values[].timestampbodyintegerTimestamp is the point's time as a Unix timestamp in milliseconds.
data.data.results[].aggregations[].upperBoundSeries[].values[].valuebodynumberValue is the point's value.
data.data.results[].aggregations[].upperBoundSeries[].values[].valuesbodynumber[]Values carries the bucket values of a heatmap point.
data.data.results[].queryNamebodystringQueryName names the query the result answers.
data.metabodyo11y.O11yQueryStats
data.meta.bytesScannedbodyintegerBytesScanned is how many bytes the query read.
data.meta.durationMsbodyintegerDurationMS is how long the query took, in milliseconds.
data.meta.rowsScannedbodyintegerRowsScanned is how many rows the query read.
data.meta.stepIntervalsbodyobjectStepIntervals is the step used per query, in seconds.
data.meta.stepIntervals.*bodyinteger
data.typebodystringType is the result kind; time_series here.
data.warningbodyo11y.O11yQueryWarning
data.warning.messagebodystringMessage is the warning.
data.warning.urlbodystringURL points at the relevant documentation.
data.warning.warningsbodyo11y.O11yQueryWarningNote[]Warnings carries additional notes.
data.warning.warnings[].messagebodystringMessage is the note.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y metric_reduction_rules timeseries

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page