Get

/metrics

Query parameters

metric_names

stringRequired

Comma-separated list of metric names (1-10 metrics, e.g. "http_requests,memory_usage,dataengine.function.invocations"). Allows alphanumeric characters, dots, colons, and underscores.

aggregation

string

Aggregation method (defaults to 'avg')

Valid values[ "sum", "avg", "min", "max", "p50", "p95", "p99" ]

pipeline

string

Pipeline name filter (optional)

function

string

Function name filter (optional)

function_deployment

string

Function deployment name filter (optional)

metric_type

string

Filter by metric type (optional)

Valid values[ "Counter", "Histogram", "Gauge", "UpDownCounter" ]

group_by

string

Group metrics by dimension (function_name or pipeline_name)

Valid values[ "function_name", "pipeline_name", "function_deployment_name" ]

top_k

integer

Return only the top K groups with highest values (requires group_by, mutually exclusive with bottom_k)

Minimum1

Maximum100

bottom_k

integer

Return only the bottom K groups with lowest values (requires group_by, mutually exclusive with top_k)

Minimum1

Maximum100

timeframe

string

Time window like '30s', '5m', '1h', '7d'. Defaults to '1h' if neither timeframe nor time_start/time_end are specified.

time_start

string (date-time)

Start time for query

time_end

string (date-time)

End time for query

max_points

integer

Maximum data points to return

Minimum1

Maximum100

Default60

Responses

200

Multi-metric query result

Expand All

object

query

object

metric_names

Array of string

Metrics that were queried

string

aggregation

string

Aggregation method used

time_range

object

start

string (date-time)

Query start time

end

string (date-time)

Query end time

bucket_size_seconds

integer

Size of time buckets in seconds

filters

object

Optional filters that were applied

pipeline

string

Pipeline filter applied

function

string

Function filter applied

function_deployment

string

Function deployment name filter applied

metric_type

string

Metric type filter applied

group_by

string

Dimension to group metrics by (function_name, pipeline_name, or function_deployment_name)

Valid values[ "function_name", "pipeline_name", "function_deployment_name" ]

top_k

integer

Top K groups filter applied (highest values)

bottom_k

integer

Bottom K groups filter applied (lowest values)

results

Array of object

Per-metric results array

object

metric_name

string

Name of the metric

metric_type

string

Type of metric (Counter, Gauge, etc.)

metric_unit

string

Unit of the metric (ms, bytes, percent, etc.)

metric_description

string

Human-readable description of the metric

scope

string

OpenTelemetry scope name (e.g., "vast-runtime" for automatic metrics, "user" for custom metrics)

groups_found

Array of string | null

List of unique group values found (only present when group_by is used)

string

groups

Array of object

Array of grouped metric data. Contains one or more groups depending on query grouping.

object

group

string | null

The value of the grouping dimension for this group (only present when group_by is used)

statistics

object

total_points

integer

Number of aggregated data points for this metric

raw_points_count

integer

Number of raw metric points before aggregation for this metric

prop_list

Array of string

Column names for data array

Example[ "timestamp", "value", "count" ]

string

data

Array of array

Data rows in prop_list column order

Array

422

Validation Error

object

detail

string

String representation of a mapping between field names and error messages

Example{"url": "URL must include a protocol", "port": "Port must be an integer"}

Query multiple metrics with aggregation