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 a2a_context_idOne 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

<= 1000

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

AnalyticsRequestsQuery

One Of
filtersOne Of
array

Default:[]

Filter by a2a_context_idOne 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

<= 1000

offsetinteger

Number of requests to be skipped when returning results.

Default:0

Example

Filter by field

object
* Additional properties are NOT allowed.
filtersOne Of
array

Default:[]

Filter by a2a_context_idOne 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

<= 1000

offsetinteger

Number of requests to be skipped when returning results.

Default:0

Example

Filter by dimension

object
* Additional properties are NOT allowed.
filtersOne Of
array

Default:[]

Filter by api_productobject
* Additional properties are NOT allowed.
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

<= 1000

offsetinteger

Number of requests to be skipped when returning results.

Default:0

Example

FilterTimeRange

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"}

One Of
tzstring

The time zone of the requestor, provided as a string matching the
tz database. This helps determine day boundaries for relative time
ranges spanning more than 24 hours: for example, submitting a request
for data from the last 7 days on 2020-01-08T00:00:00 in timezone
US/Eastern will find results starting from 2020-01-01T05:00:00Z (UTC).

Default:Etc/UTC

Example:US/Eastern

typestringrequired

Request data from a time relative to the current time.

Allowed values:relative

time_rangestringrequired

Return results from the last fifteen minutes, one hour, six hours, etc.

Allowed values:15M1H6H12H24H7D

Default:12H

Example