Sign in

v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
API Analytics

Get API metric for a request

Get API metric for a request

Get API metric for a request.

get/environments/{envId}/apis/{apiId}/analytics/{requestId}

Response

API metric for a particular request

timestampstring date-time

The date (as timestamp) of the metric.

apiIdstring

The id of the api.

requestIdstring

The id of the request.

transactionIdstring

The id of the transaction.

hoststring

The host used for the request

gatewaystring

The id of the gateway.

gatewayHostnamestring

The hostname of the gateway instance.

gatewayIpstring

The IP address of the gateway instance.

uristring

URI of the request.

statusinteger

The response status

requestContentLengthinteger

The request content length

responseContentLengthinteger

The response content length

remoteAddressstring

the remote address

gatewayLatencyinteger

The gateway latency

gatewayResponseTimeinteger

The gateway response time

endpointResponseTimeinteger

The endpoint response time

method'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE' | 'OTHER'

The method of the selector

endpointstring

The endpoint URL.

messagestring

The error message.

errorKeystring

The error key.

errorComponentNamestring

The name of the component that generated the error.

errorComponentTypestring

The type of the component that generated the error.

additionalMetricsobject

A map of string keys to values

Example response

{
  "timestamp": "2023-05-18 12:40:46.184000+00:00",
  "apiId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "requestId": "1719d8d1-8d01-48f6-99d8-d18d0178f6d4",
  "transactionId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "host": "mycompany.example.com",
  "plan": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My Api plan",
    "description": "I can use a hundred characters to describe this plan.",
    "apiId": "6c530064-0b2c-4004-9300-640b2ce0047b",
    "apiProductId": "6c530064-0b2c-4004-9300-640b2ce0047b",
    "security": {
      "type": "KEY_LESS"
    },
    "mode": "STANDARD"
  },
  "application": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My App",
    "description": "I can use a hundred characters to describe this App.",
    "domain": "https://my-app.com",
    "type": "iOS",
    "primaryOwner": {
      "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "displayName": "John Doe"
    },
    "apiKeyMode": "UNSPECIFIED"
  },
  "gateway": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "gatewayHostname": "gateway-1.example.com",
  "gatewayIp": "192.168.1.100",
  "uri": "/my-api",
  "status": 200,
  "requestContentLength": 42,
  "responseContentLength": 42,
  "gatewayLatency": 42,
  "gatewayResponseTime": 42,
  "endpointResponseTime": 42,
  "method": "GET",
  "endpoint": "https://my-api-example.com",
  "message": "The timeout period of 1000ms has been exceeded",
  "errorKey": "TIMEOUT_ERROR",
  "errorComponentName": "security",
  "errorComponentType": "ENDPOINT",
  "warnings": [
    {
      "componentType": "POLICY",
      "componentName": "transform-header",
      "key": "TRANSFORM_HEADERS_FAILURE"
    }
  ]
}