API docs by Redocly

Konnect API Request Analytics (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

The API to query detailed records for every API request proxied by Kong

API Requests

Query API Requests

Returns API requests that were proxied through the Kong Gateway.

Authorizations:
personalAccessToken
Request Body schema: application/json
One of
Array of (ApiProductFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ApiProductVersionFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ApplicationFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (AuthTypeFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ClientIpFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ConsumerFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ControlPlaneFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ControlPlaneGroupFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (DataPlaneNodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (DataPlaneNodeVersionFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (GatewayServiceFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (HeaderHostFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (HeaderUserAgentFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (HttpMethodFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (LatenciesKongGatewayMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (LatenciesResponseMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (LatenciesUpstreamMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseBodySizeFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseHeaderContentLengthFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseSourceFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RequestBodySizeFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (RequestIdFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RequestUriFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ResponseHeaderContentTypeFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RouteFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ServicePortFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ServiceProtocolFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (StatusCodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (StatusCodeGroupedFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (TraceIdFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (UpstreamStatusCodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (UpstreamStatusCodeGroupedFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (UpstreamUriFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object)))
Default: []
any (FilterTimeRange)
Default: {"type":"relative","time_range":"1H"}

The period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of 1 hour will be chosen.

order
string (FilterOrder)
Default: "descending"
Enum: "ascending" "descending"

Order of results sorted by time.

size
integer (FilterSize)
Default: 100

Number of requests to be returned.

offset
integer (FilterOffset)
Default: 0

Number of requests to be skipped when returning results.

Responses

Request samples

Content type
application/json
Example
{
  • "time_range": {
    },
  • "filters": [
    ]
}

Response samples

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