Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Query Platform Metrics

POST
/observability/v1/platform/engines/{engine}/metrics:query
curl --request POST \
--url https://example.com/observability/v1/platform/engines/example/metrics:query \
--header 'Content-Type: application/json' \
--data '{ "engine": "example", "query": "example", "observe_time": "2026-04-15T12:00:00Z", "filter": "example" }'

Evaluates a metric expression at a single instant against the reserved platform tenant — the control-plane and infrastructure telemetry that belongs to no workspace. Platform-administrator only: the request names no workspace, so authorization is evaluated at PLATFORM scope.

engine
required
string

The provider: qibdo, aws, gcp, or azure.

Media type application/json

QueryPlatformMetricsRequest

Request for QueryPlatformMetrics (instant) against the reserved platform tenant.

The tenant is selected by the address — the literal platform collection segment — so this message deliberately carries no workspace, organisation or group field. That absence is load-bearing: it is what makes the authorization scope chain collapse to PLATFORM, which is how the surface is reserved to platform administrators.

object
engine
required

The provider: qibdo, aws, gcp, or azure.

string
query
required

The native metric query expression (PromQL for the qibdo engine).

string
observe_time

The instant to evaluate at; defaults to now when unset.

string format: date-time
filter

AIP-160 filter expression.

string
Example generated
{
"engine": "example",
"query": "example",
"observe_time": "2026-04-15T12:00:00Z",
"filter": "example"
}

OK

Media type application/json

QueryMetricsResponse

Response for QueryMetrics / QueryMetricsRange.

object
mode

Whether the result was evaluated at an instant or across a window.

string format: enum
Allowed values: METRIC_QUERY_MODE_UNSPECIFIED METRIC_QUERY_MODE_INSTANT METRIC_QUERY_MODE_RANGE
series

The matching series.

Array<object>

MetricSeries

One labelled time series. An instant result carries a single sample.

object
labels

The series’ label set.

object
key
additional properties
string
samples

The samples, ordered by time.

Array<object>

MetricSample

A single (timestamp, value) point in a series.

object
observe_time

The sample instant.

string format: date-time
value

The sample value.

number format: double
engine

The provider that served the query.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
Example
{
"mode": "METRIC_QUERY_MODE_UNSPECIFIED",
"engine": "ENGINE_UNSPECIFIED"
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}