MetricsResultV2

object

The result of a metrics query. Contains the data and metadata about the query.

dataarray[object]requiredread-only

A result with metrics grouped by the dimensions specified in the query, at a particular time

The example represents a result group that has a summed request_count, and response_latency_p99 for a gateway_service at 2024-01-16T00:00:00Z.

Example:{"event":{"gateway_service":"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055","request_count":1000,"response_latency_p99":23},"timestamp":"2024-01-16T00:00:00Z"}

Show Child Parameters
metaobjectrequiredread-only

Metadata about the query response. This includes the start and end times of the query, the granularity of the result, whether the result was truncated, the limit of the result, and the query_id.

Example:{"start":"2024-01-16T18:00:00.000Z","end":"2024-01-16T18:16:40.000Z","display":{"gateway_service":{"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111":{"id":"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111","deleted":true,"name":"Gateway Service Alpha"},"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055":{"id":"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055","deleted":false,"name":"Gateway Service Beta"}}},"metric_units":{"request_count":"count","response_latency_p99":"ms"},"granularity_ms":60000,"truncated":false,"limit":50,"query_id":"requested-query-id"}

Show Child Parameters
Example

RequestsFilterType

string

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

UnscopedUuid

string

Match pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

RequestsFilterTypeEmpty

string

The type of filter to apply.

Allowed values:emptynot_empty

Filter by api

One Of
operatorstringrequired

The type of filter to apply. in filters will limit results to only the specified values, while not_in filters will exclude the specified values.

Allowed values:innot_in

valuearray[string]required

The IDs to include in the results.

Match pattern:^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

fieldstringrequired

The field to filter.

Allowed values:api

Example