MetricsDisplayBlob

object

The blob represents how to interpret large UUID strings in the MetricsResult. The structure is records of dimension_id -> ID -> entity metadata. Since entity names within Konnect may overlap, ids are returned and used for exact grouping. This blob may be used to join and display results in a more human friendly manner. Since IDs represent entities in the system at all points in time, historical data will still exist even if an entity is deleted. These such entities are marked with the deleted key.

Another special case is the OTHER entity. When the limit of cardinality is reached for a second dimension, the system will group all other entities into the OTHER grouping. This prevents returning an overwhelming number of long tail entities.

apiobject
api_packageobject
api_productobject
api_product_versionobject
applicationobject
consumerobject
control_planeobject
control_plane_groupobject
country_codeobject
data_plane_nodeobject
data_plane_node_versionobject
gateway_serviceobject
portalobject
response_sourceobject
routeobject
status_codeobject
status_code_groupedobject
upstream_status_codeobject
upstream_status_code_groupedobject
Example

MetricUnits

object

A mapping of metric names to their associated unit. The keys are the metric names, and the values are the units. The possible units are: ms (Millisecond), count, and bytes

Example

MetricsResponseMeta

object

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.

startstring(date-time)requiredread-only

Start of the query time range.

endstring(date-time)requiredread-only

End of the query time range.

displayobjectrequiredread-only

The blob represents how to interpret large UUID strings in the MetricsResult. The structure is records of dimension_id -> ID -> entity metadata. Since entity names within Konnect may overlap, ids are returned and used for exact grouping. This blob may be used to join and display results in a more human friendly manner. Since IDs represent entities in the system at all points in time, historical data will still exist even if an entity is deleted. These such entities are marked with the deleted key.

Another special case is the OTHER entity. When the limit of cardinality is reached for a second dimension, the system will group all other entities into the OTHER grouping. This prevents returning an overwhelming number of long tail entities.

Example:{"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"}}}

Show Child Parameters
metric_unitsobjectrequiredread-only

A meta object that describes how to interpret metric names and their associated unit.

Example:{"request_count":"count","response_latency_p99":"ms"}

granularity_msnumberrequiredread-only

The number of milliseconds per interval in a time series.

truncatedbooleanrequiredread-only

Set true when the limit of cardinarlity is hit. For queries with 2 dimensions, the limit truncates the first dimension, and then groups all other groupings for the second dimension.

Example: limit of 2 for gateway_service and status_code would return 2 gateway services maximum, and 2 status codes + OTHER. The _OTHER is representing all other status codes.

limitnumberrequiredread-only

Applied query cardinality limit.

query_idstringrequiredread-only

An ID that can be used to reference the query.

Example

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