Oxide 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 Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
1 operation
across 1 path,
and defines 45 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
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
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
Cumulativeuint64
object
A cumulative or counter data type.
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
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…
MissingDatum
object
2 properties
1 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.
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
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
MeasurementResultsPage
object
A single page of results
2 properties
1 required
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…
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
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…
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…
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
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.
