The unique identifier for the API.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b1

Name of the API in which the event occurred.

Example: SampleAPI

The system-assigned version identifier for the API.

Example: 1.0

The unique identifier for the consumer associated with the API invocation.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

IP address of the consumer associated with the API invocation.

Example: 10.1.1.211

Name of the consumer associated with the API invocation.

A consumer name is populated as unknown when API Gateway is unable to identify the consumer using a security policy that is configured for the API.

Example: SampleApplication

The unique identifier that is automatically generated for every request coming to API Gateway and can be used to query the log.

Example: MED38e9cfa4-2348-408b-9462-124b2181c1a6:656

Date and time when the event was generated in API Gateway.

Example: 1501671101509

The custom fields an API Provider can provide to log a new field and value for a transaction event.

Example: {"customfield":"customvalue"}

The origin of error.

Example: Nativeserivce

The type of event that occurred.

Example: Transactional

This is applicable only for WebSocket APIs. The request and response payloads for API invocations.

Example: Sample WebSocket message

Name of the API operation that is invoked.

Example: Using a Calculator API, you can perform various operations such as addition, subtraction, multiplication, and division. When an addition operation is invoked in API Gateway, then the operation field name is populated as addInts.

Time in milliseconds required for API Gateway to invoke a native provider and receive a response. This time includes the overhead incurred by API Gateway. Overhead includes the time it takes for a provider to process a request and return a response, plus any network latency to or from the provider. Subtracting total time from provider time must give a rough indicator of the API Gateway overhead.

Example: 20

This is applicable only for REST APIs. Query parameters present in the incoming REST request.

Example: {"status":"available"}

The API request payload data.

Example: <RequestPayload>

Request header in the incoming request from the client.

Example: {"Cache-Control":"max-age=0","Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","Upgrade-Insecure-Requests":"1","Connection":"keep-alive","User-Agent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181 Safari/537.36","Host":"mcdaso02:5555","Accept-Encoding":"gzip, deflate","Accept-Language":"en-US,en;q=0.9,ta;q=0.8","Content-Type":"application/x-www-form-urlencoded"}

The API response payload data.

Example: <ResponsePayload>

The HTTP response status code that indicates success or failure of the requested operation.

Example: 200

Response header in the outgoing response.

Example: {"Server":"Jetty(9.2.9.v20150224)","Access-Control-Allow-Origin":"*","Access-Control-Allow-Methods":"GET, POST, DELETE, PUT","Connection":"close","Date":"Fri, 30 Mar 2018 08:25:45 GMT","Access-Control-Allow-Headers":"Content-Type, api_key, Authorization","Content-Type":"application/xml"}

A string the API Gateway server generates to uniquely identify each session. This is either the IS session token or the automatically generated GUID if the token is missing from the message context.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

Status of the API request.

Possible values are: SUCCESS, FAILURE

The total combined size of request and response payloads in bytes.

Example: 100

Time in milliseconds required to invoke the API provider. This time includes the overhead incurred by API Gateway. Overhead includes security overhead for encryption, decryption, and load-balance retries.

Example: 120

The unique identifier for the API.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b1

Name of the API in which the event occurred.

Example: SampleAPI

The system-assigned version identifier for the API.

Example: 1.0

The unique identifier for the consumer associated with the API invocation.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

IP address of the consumer associated with the API invocation.

Example: 10.20.248.33

Name of the consumer associated with the API invocation.

A consumer name is populated as unknown when API Gateway is unable to identify the consumer using a security policy that is configured for the API.

Example: SampleApplication

Date and time when the event was generated in API Gateway.

Example: 1501671101509

Message that describes the error that occurred.

The type of event that occurred.

Example: Error Event

Name of the API operation that is invoked.

Example: Using a Calculator API, you can perform various operations such as addition, subtraction, multiplication, and division. When an addition operation is invoked in API Gateway, then the operation field name is populated as addInts.

The HTTP response status code that indicates success or failure of the requested operation.

Example: 503

A string the API Gateway server generates to uniquely identify each session. This is either the IS session token or the automatically generated GUID if the token is missing from the message context.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

Text of the alert message sent to a configured destination when the performance conditions are violated. The alert message is specified in the policy definition of an API.

Example: EnforcePolicy-HardLimit

The type of alert generated for the event.

Example: sla

The unique identifier for the API.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b1

Name of the API in which the event occurred.

Example: SampleAPI

The system-assigned version identifier for the API.

Example: 1.0

The unique identifier for the consumer associated with the API invocation.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

IP address of the consumer associated with the API invocation.

Example: 10.20.248.33

Name of the consumer associated with the API invocation.

A consumer name is populated as unknown when API Gateway is unable to identify the consumer using a security policy that is configured for the API.

Example: SampleApplication

Date and time when the event was generated in API Gateway.

Example: 1501671101509

The type of event that occurred.

Example: Monitor Event

The HTTP method used to request the API access.

Example: GET

Name of the API operation that is invoked.

Example: Using a Calculator API, you can perform various operations such as addition, subtraction, multiplication, and division. When an addition operation is invoked in API Gateway, then the operation field name is populated as addInts.

The HTTP response status code that indicates success or failure of the requested operation.

Example: 200

A string the API Gateway server generates to uniquely identify each session. This is either the IS session token or the automatically generated GUID if the token is missing from the message context.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

Date and time when the event was generated in API Gateway.

Example: 1501671101509

Status of the API Gateway instance.

Possible values are: STARTED or STOPPED

The type of event that occurred.

Example: LifeCycle

Name of the API Gateway instance reporting the event.

Example: API_Gateway_Instance

Text of the alert message sent to a configured destination when the performance conditions are violated. The alert message is specified in the policy definition of an API.

Example: A violation was detected for policy (Unknown-Policyuser ): application could not be identified. Anonymous access is not allowed for this service!

Name of the API Gateway policy that generated the alert message.

Example: Unknown-Policy

The type of alert generated for the event.

Example: PolicyViolation

The unique identifier for the API.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b1

Name of the API in which the event occurred.

Example: SampleAPI

The system-assigned version identifier for the API.

Example: 1.0

The unique identifier for the consumer associated with the API invocation.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

IP address of the consumer associated with the API invocation.

Example: 10.20.248.33

Name of the consumer associated with the API invocation.

A consumer name is populated as unknown when API Gateway is unable to identify the consumer using a security policy that is configured for the API.

Example: SampleApplication

Date and time when the event was generated in API Gateway.

Example: 1501671101509

The type of event that occurred.

Example: Policy Violation Event

Name of the API operation that is invoked.

Example: Using a Calculator API, you can perform various operations such as addition, subtraction, multiplication, and division. When an addition operation is invoked in API Gateway, then the operation field name is populated as addInts.

The HTTP response status code that indicates success or failure of the requested operation.

Example: 200

A string the API Gateway server generates to uniquely identify each session. This is either the IS session token or the automatically generated GUID if the token is missing from the message context.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b2

The unique identifier for the API.

Example: c0f84954-9732-11e5-b9f4-f159eafe47b1

Name of the API in which the event occurred.

Example: SampleAPI

The system-assigned version identifier for the API.

Example: 1.0

The percentage of time that an API was available during the current interval. A value of 100 indicates that the API was always available. If invocations fail due to policy violations, this parameter could still be as high as 100.

Example: 100

The average amount of time it took the API to complete each invocation in the current interval. Response time is measured from the moment API Gateway receives the request until the moment it returns the response to the caller.

Example: 135

Date and time when the event was generated in API Gateway.

Example: 1501671101509

The type of event that occurred.

Example: Performance Metrics Event

The number of failed API invocations in the current interval.

Example: 10

Includes failed API invocations.

Possible values are: true, false

The starting date and time from which you want to examine metrics.

Example: 2015-08-26 04:13:35 PM

The ending date and time until which you want to examine metrics.

Example: 2015-08-26 04:13:45 PM

The maximum amount of time (in milliseconds) it took for the API to complete an invocation in the current interval.

Example: 343

The minimum amount of time (in milliseconds) it took for the API to complete an invocation in the current interval.

Example: 10

Name of the API operation that is invoked.

Example: Using a Calculator API, you can perform various operations such as addition, subtraction, multiplication, and division. When an addition operation is invoked in API Gateway, then the operation field name is populated as addInts.

The number of successful API invocations in the current interval.

Example: 100

The total number of API invocations (successful and unsuccessful) in the current interval.

Example: 110

A helpful action taken on the API for the alert.

Example: DENY

Name of the threat protection filter.

Example: DoSFilter

If the API invocation failed, message that describes the error that occurred.

Example: Global Denial of Service limits were reached: Maximum requests limit of 2 in 120 seconds has been exceeded.

Hostname of the machine from which the API access request was submitted.

Example: 10.60.34.152

Date and time the request was submitted.

Example: 1501671101509

The type of request that was received for the API.

Example: ALL

Name of the user on API Gateway from whom the request is received.

Example: null

The relative URI path for a resource that was used for API invocation.

Example: invoke/pub.date/getCurrentDate

The HTTP response status code that indicates success or failure of the requested operation.

Example: 200

The API Gateway rule that triggered the event.

Example: GlobalDoSRule

The name or IP address of the machine on which the thread protection server is running.

Example: 10.60.34.83

The port number on which the thread protection server is configured to listen for incoming requests.

Example: 8911