API docs by Redocly

Portal Application Analytics (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

API for querying Application Analytics.

Application Analytics

The API for querying Application Analytics. Application Analytics is only available for private portals.

Query Application Analytics

Query

Authorizations:
portalAccessToken
Request Body schema: application/json

Object describing the query sent to analytics API.

start_ms
required
integer

Unix timestamp in milliseconds specifying the lower bound to return data for the query, inclusive.

end_ms
required
integer

Unix timestamp in milliseconds specifying upper bound to return data for the query, inclusive.

metrics
required
Array of strings = 1 items
Items Enum: "REQUEST_COUNT" "REQUEST_PER_MINUTE" "RESPONSE_LATENCY_P99" "RESPONSE_LATENCY_P95" "RESPONSE_LATENCY_P50" "RESPONSE_SIZE_P99" "RESPONSE_SIZE_P95" "RESPONSE_SIZE_P50" "REQUEST_SIZE_P99" "REQUEST_SIZE_P95" "REQUEST_SIZE_P50"

A property of your API (such as request count or latency) that you wish to query on. Your chosen metric is aggregated within the specified dimensions, meaning that if you query 'request count by application', you'll receive the total number of requests each application received within the given time frame. Some metrics, such as latency and response size, have more complicated aggregations: selecting P99 will result in the 99th percentile of the chosen metric.

dimensions
Array of strings [ 0 .. 2 ] items
Default: []
Items Enum: "API_PRODUCT_VERSION" "APPLICATION" "STATUS_CODE" "STATUS_CODE_GROUPED" "TIME"

The dimensions for the query. A query may have up to 2 dimensions, including time. If no dimensions are provided, the report will simply return the provided metric aggregated across all available data.

granularity_ms
integer
Default: 86400000

granularity_ms is only valid for queries that include a time dimension, and it specifies the time buckets in for the returned data.

Array of any
Default: []

Responses

Request samples

Content type
application/json
Example
{
  • "start_ms": 1691158080000,
  • "end_ms": 1691158980000,
  • "metrics": [
    ],
  • "filter": [
    ]
}

Response samples

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

Application Analytics Config

Get config for application analytics

Authorizations:
portalAccessToken

Responses

Response samples

Content type
application/json
Example
{
  • "analytics": null
}