Oxide System/metrics API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include System Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
3 operations
across 3 paths,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 2026081901.0.0.
Requests are made against the base URL https://{oxide-control-plane-host}.
The identity and technical contract details declared by the specification.
Binuint16
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
Values
object
A single list of values, for one dimension of a timeseries.
2 properties
2 required
BinRangeint16
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
BinRangeint32
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Binint64
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
TimeseriesSchema
object
The schema for a timeseries. This includes the name of the timeseries, as well as the datum type of its metric and the schema for each field.
8 properties
8 required
BinRangeuint8
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Cumulativefloat
object
A cumulative or counter data type.
2 properties
2 required
Binint8
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
BinRangefloat
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Binint16
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
Binuint64
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
OxqlTable
object
A table represents one or more timeseries with the same schema. A table is the result of an OxQL query. It contains a name, usually the name of the timeseries…
2 properties
2 required
FieldSource
string
The source from which a field is derived, the target or metric.
Cumulativeuint64
object
A cumulative or counter data type.
2 properties
2 required
Timeseries
object
A timeseries contains a timestamped set of values from one source. This includes the typed key-value pairs that uniquely identify it, and the set of timestamps…
2 properties
2 required
BinRangedouble
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Cumulativeint64
object
A cumulative or counter data type.
2 properties
2 required
Quantile
object
Structure for estimating the p-quantile of a population. This is based on the P² algorithm for estimating quantiles using constant space. The algorithm consist…
4 properties
4 required
Binuint32
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
TimeseriesQuery
object
A timeseries query string, written in the Oximeter query language.
1 property
1 required
Histogramuint32
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
BinRangeint8
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
FieldSchema
object
The name and type information for a field of a timeseries schema.
4 properties
4 required
Points
object
Timepoints and values for one timeseries.
3 properties
2 required
AuthzScope
Authorization scope for a timeseries. This describes the level at which a user must be authorized to read data from a timeseries. For example, fleet-scoping me…
MissingDatum
object
2 properties
1 required
Distributionint64
object
A distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile e…
9 properties
4 required
Histogramint32
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
Error
object
Error information from a response.
3 properties
2 required
DatumType
string
The type of an individual datum of a metric.
FieldValue
The FieldValue contains the value of a target or metric field.
Histogramuint64
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
TimeseriesDescription
object
Text descriptions for the target and metric of a timeseries.
2 properties
2 required
MeasurementResultsPage
object
A single page of results
2 properties
1 required
Histogramint16
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
MetricType
The type of the metric itself, indicating what its values represent.
ValueArray
List of data values for one timeseries. Each element is an option, where None represents a missing sample.
Bindouble
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
Histogramint64
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
Histogramfloat
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
BinRangeuint16
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Cumulativedouble
object
A cumulative or counter data type.
2 properties
2 required
BinRangeuint32
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
OxqlQueryResult
object
The result of a successful OxQL query.
1 property
1 required
Distributiondouble
object
A distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile e…
9 properties
4 required
Measurement
object
A Measurement is a timestamped datum from a single metric
2 properties
2 required
Histogramdouble
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
TimeseriesSchemaResultsPage
object
A single page of results
2 properties
1 required
Name
string
Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Nam…
TimeseriesName
string
Names are constructed by concatenating the target and metric names with ':'. Target and metric names must be lowercase alphanumeric characters with '' separati…
BinRangeuint64
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Units
Measurement units for timeseries samples.
Histogramint8
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
PaginationOrder
string
The order in which the client wants to page through the requested collection
FieldType
string
The FieldType identifies the data type of a target or metric field.
Histogramuint8
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
Binfloat
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
BinRangeint64
A type storing a range over T. This type supports ranges similar to the RangeTo, Range and RangeFrom types in the standard library. Those cover (..end), (start…
Histogramuint16
object
Histogram metric A histogram maintains the count of any number of samples, over a set of bins. Bins are specified on construction via their left edges, inclusi…
10 properties
10 required
Binuint8
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
Binint32
object
Type storing bin edges and a count of samples within it.
2 properties
2 required
Datum
A Datum is a single sampled data point from a metric.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oxide publishes across the network.
