Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Konnect API Request Analytics

v2.0.0OAS 3.0

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

API Base URL
  • Server 1:https://us.api.konghq.com/v2

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v2

    Europe Production region

  • Server 3:https://au.api.konghq.com/v2

    Australia Production region

  • Server 4:https://me.api.konghq.com/v2

    Middle-East Production region

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

Additional Information
Contact Kong

Query API Requests

Returns API requests that were proxied through the Kong Gateway.

post

Body

application/json

AnalyticsRequestsQuery

AnalyticsRequestsQuery
One Of
filtersOne Of
array

Default:[]

Filter by api_productOne Of
Multiselect filtersobject
Show Child Parameters
time_rangeOne Of

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.

Default:{"type":"relative","time_range":"1H"}

RequestsRelativeTimeRangeobject
* Additional properties are NOT allowed.
Show Child Parameters
orderstring

Order of results sorted by time.

Allowed values:ascendingdescending

Default:descending

sizeinteger

Number of requests to be returned.

Default:100

offsetinteger

Number of requests to be skipped when returning results.

Default:0

Response

application/json

Response from the Analytics Requests API.

* Additional properties are NOT allowed.
resultsarray[object]required

Mapping of the columns to values.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Meta information about the returned query response.

* Additional properties are NOT allowed.
Show Child Parameters
post/api-requests

Body

{
"time_range": {
"type": "relative",
"time_range": "24H",
"tz": "EST"
},
"filters": [
{
"operator": "in",
"field": "api_product",
"value": [
"523468b1-2e74-4b58-b30e-6f904e99e4d0",
"c19b3f76-ef71-484a-bbc8-a07812a980b3"
]
},
{
"operator": "in",
"field": "gateway_service",
"value": [
"d5ac5d88-efed-4e10-9dfe-0b0a6646c219:523468b1-2e74-4b58-b30e-6f904e99e4d0"
]
},
{
"operator": "not_in",
"field": "http_method",
"value": [
"OPTIONS",
"GET"
]
},
{
"operator": "not_in",
"field": "status_code_grouped",
"value": [
"2XX"
]
},
{
"operator": "not_in",
"field": "status_code",
"value": [
200
]
}
]
}
 
application/json