API docs by Redocly

Konnect Explore Endpoint (4.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Konnect endpoint for extracting and computing metrics

Explore

Explore metrics in the analyticcs platform

Post a query to the endpoint to retrieve aggregated metrics down to the minute. Data can be requested to group by any 2 dimensions, and any number of filter conditions.

Request Body schema: application/json
metrics
required
Array of strings
Items Enum: "request_count" "request_per_minute" "response_latency_p99" "response_latency_p95" "response_latency_p50" "response_latency_average" "upstream_latency_p99" "upstream_latency_p95" "upstream_latency_p50" "upstream_latency_average" "kong_latency_p99" "kong_latency_p95" "kong_latency_p50" "kong_latency_average" "response_size_p99" "response_size_p95" "response_size_p50" "request_size_p99" "request_size_p95" "request_size_p50" "request_size_average" "response_size_average"

List of aggregated metrics to collect across the requested time span.

dimensions
Array of strings [ 0 .. 2 ] items
Items Enum: "api_product" "api_product_version" "application" "consumer" "control_plane" "control_plane_group" "data_plane_node" "gateway_service" "route" "status_code" "status_code_grouped" "time"

List of attributes or entity types to group by.

Array of objects (ExploreFilter)

A list of filters to apply to the query.

granularity
string
Enum: "minute" "hour" "day" "week" "trend"

Force time grouping into buckets of the specified duration. Only has an effect if "time" is in the "dimensions" list.

If "trend" is chosen, the time range covered by the query will be twice the specified time range, and the granularity will be set such that two time buckets are returned, one for the given time range and one for the same time range prior. For example:

time range: last 24 hours granularity: trend

will return 2 time buckets (assuming both have data):

  • 48 hours ago to 24 hours ago
  • 24 hours ago to now

Another example:

time range: 2020-05-01 to 2020-05-15 granularity: trend

will return 2 time buckets:

  • 2020-04-15 through 2020-04-30
  • 2020-05-01 through 2020-05-15

The granularity of the result may be coarser than requested. The finest allowed granularity depends on the query's time range: data farther in the past may have coarser granularity. The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and "time" is in the dimensions list, a default will be chosen based on the time range requested.

any
Default: {"type":"relative","time_range":"1h"}

The time range to query.

meta
object

Responses

Request samples

Content type
application/json
{
  • "time_range": {
    },
  • "dimensions": [
    ],
  • "filters": [
    ],
  • "granularity": "hour",
  • "metrics": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}