Software AG Products 10.5 | Using API Gateway | API Gateway Analytics | Runtime Events and Metrics Data Model | JDBC
 
JDBC
The events and metrics payload generated by API Gateway at run-time is published to the configured JDBC destination. The columns that make up the events and metrics data model for JDBC are listed below:
API Gateway supports three types of database, Oracle, DB2, and MSSQL. Based on the database selected, API Gateway publishes the events and metrics payload to the JDBC destination.
Transactional Events
Column Description
Oracle
DB2
MSSQL
API_ID
The unique identifier for the API.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b1
Varchar(256)
Varchar(256)
NVarchar(256)
API_NAME
Name of the API in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
API_VERSION
The system-assigned version identifier for the API.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_ID
The unique identifier for the application associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_IP
IP address of the application associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
APPLICATION_NAME
Name of the application associated with the API invocation.
An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchsar(128)
AUDITTIMESTAMP
Date and time when the event was written to the log.
TIMESTAMP
TIMESTAMP
DATETIME
BINDING_NAME
Name of the binding that identifies a specific access URI.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(256)
Varchar(256)
NVarchar(256)
CACHED_RESPONSE
Indicates whether the response is sent to the client from the cached data present in API Gateway through the Service result caching policy or the response is received from Native service and sent to client.
Possible values are: Cached, Not-Cached
Varchar(12)
Varchar(12)
NVarchar(12)
CONSUMER_ID
The unique identifier for the consumer associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_IP
IP address of the consumer associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
CONSUMER_NAME
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 policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchar(128)
CONTEXTID
The unique identifier for the current context information API Gateway uses to connect related entries from different logs.
This column is currently not used. It appears as NULL or as an empty string.
Example: 81546147-41a8-4998-8150-02ba67bb08c2
CHAR(36)
CHAR(36)
NCHAR(36)
CORRELATIONID
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
Varchar(256)
Varchar(256)
NVarchar(256)
CUSTOM_FIELD
The custom fields an API Provider can provide to log a new field and value for a transaction event.
Example: {"customfield":"customvalue"}
BLOB
BLOB
IMAGE
ERROR_ORIGIN
The origin of error.
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_CREATE_TS
Date and time when the event was generated in API Gateway.
This is not the time the database performed its insert (for example, this is calculated by the Mediator policy engine and not a database function).
TIMESTAMP
TIMESTAMP
DATETIME
EVENT_SOURCE
The source where the event occurred.
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_TYPE
The type of event that occurred.
Example: Transactional
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_USERNAME
Name of the user on API Gateway that invoked the API.
Varchar(256)
Varchar(256)
NVarchar(256)
EXTERNAL_CALLS
List the external calls from API Gateway. These external calls can be to a native service or service registry.
Example:

[{
"externalCallType":
"SERVICE_REGISTRY_CALL",
"externalURL":
"http://service.registry.com",
"callDuration":49,
"callStartTime":1562244570486,
"callEndTime":1562244570535,
"responseCode": "200"
},
{
"externalCallType":
"NATIVE_SERVICE_CALL",
"externalURL":
"https://petstore.swagger.io/v2/store
/inventory",
"callDuration":1285,
"callStartTime":1562244569252,
"callEndTime":1562244570537,
"responseCode":"200"
}]
BLOB
BLOB
IMAGE
HTTP_METHOD
The HTTP method used to invoke the API.
Example: GET
Varchar(8)
Varchar(8)
NVarchar(8)
INSERTTIMESTAMP
Date and time when the event was generated in API Gateway.
TIMESTAMP
TIMESTAMP
DATETIME
MSGID
The ID assigned to the message by the API provider.
This column is currently not used.
CHAR(36)
CHAR(36)
NCHAR(36)
NATIVE_ENDPOINT
The endpoint URL of the native API that is invoked.
Example: http://petstore.swagger.io/v2/pet/55
Varchar(4000)
Varchar(4000)
NVarchar(4000)
NATIVE_HTTP_METHOD
The HTTP method used to invoke the native service.
Example: GET
Varchar2(20)
Varchar(20)
Varchar(20)
NATIVE_REQUEST_HEADERS
Request header in the incoming request from the API Gateway to native service.
Example:

{
"Authorization":"**************",
"Accept": "*/*",
"Authorization": "**************",
"Accept":"*/*",
"Cache-Control": "no-cache",
"User-Agent": "PostmanRuntime/7.13.0",
"Postman-Token":
"381424fa-e3b3-4058-8df9-4abf9d7c899",
"postmanHeader": "hello",
"accept-encoding": "gzip, deflate",
"Content-Type":
"application/x-www-form-urlencoded"
}
BLOB
BLOB
IMAGE
NATIVE_REQ_PAYLOAD
The native service request data.
Example:

{
"param1" : "value1",
"param2" : 10
}
CLOB
CLOB
Varchar(max)
NATIVE_RESPONSE_HEADERS
Response header in the outgoing response from the native service to API Gateway.
Example:

{
"Server":"Jetty(9.2.9.v20150224)",
"Access-Control-Allow-Origin":"*",
"Access-Control-Allow-Methods": "GET,
POST, DELETE, PUT",
"Connection":"close",
"Date":
"Fri, 07 Jun 2019 12:44:13 GMT",
"Access-Control-Allow-Headers":
"Content-Type, api_key,Authorization",
"Content-Type": "application/json"
}
BLOB
BLOB
IMAGE
NATIVE_RES_PAYLOAD
The native service response data.
Example:

{
"id":2,
"category":
{
"id":2,
"name":"string"
},
"name":"pysen",
"photoUrls":["string"],
"tags":
[{
"id":0,
"name":"string"
}],
"status":"available"
}
CLOB
CLOB
Varchar(max)
NATIVE_URL
URL of the native service.
Example: http://petstore.swagger.io/v2/pet/2
CLOB
CLOB
Varchar(max)
OPERATION_NAME
Name of the API operation or resource that is invoked.
Example: /pet/{petId}
Varchar(256)
Varchar(256)
NVarchar(256)
ORG_KEY
The Globally Unique Identifier (GUID) for an organization.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
PACKAGE_ID
The unique identifier for the API package.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
PACKAGE_NAME
Name of the API package.
Example: Travel Package
Varchar(256)
Varchar(256)
NVarchar(256)
PARENTCONTEXTID
The unique identifier for the parent context information API Gateway uses to connect related entries from different logs.
This column is currently not used. It appears as NULL or as an empty string.
CHAR(36)
CHAR(36)
NCHAR(36)
PARTNER_ID
The unique identifier for the partner that generated the audit record.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(256)
Varchar(256)
NVarchar(256)
PLAN_ID
The unique identifier for the API plan.
Example: d0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
PLAN_NAME
Name of the API plan.
Example: Gold Plan
Varchar(256)
Varchar(256)
NVarchar(256)
PROVIDER_TIME
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: 1367
NUMERIC
INT
INTEGER
QUERY_PARAMS
This is applicable only for REST APIs. Query parameters present in the incoming REST request.
Example: {"status":"available"}
BLOB
BLOB
IMAGE
REQUEST
The API request payload data.
Example: <RequestPayload>
BLOB
BLOB
IMAGE
REQUEST_HEADERS
Request header in the incoming request from the client.
BLOB
BLOB
IMAGE
RESPONSE
The API response payload data.
Example: <ResponsePayload>
BLOB
BLOB
IMAGE
RESPONSE_CODE
The HTTP response status code that indicates success or failure of the requested operation.
Example: 200
Numeric
INT
INTEGER
RESPONSE_HEADERS
Response header in the outgoing response.
BLOB
BLOB
IMAGE
ROOTCONTEXTID
The unique identifier for the root context information API Gateway uses to connect related entries from different logs.
This column is currently not used. It appears as NULL or as an empty string.
Example: 81546147-41a8-4998-8150-02ba67bb08c2
CHAR(36)
CHAR(36)
NCHAR(36)
SERVERID
The API Gateway server on which the transaction event occurred.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(450)
Varchar(450)
NVarchar(450)
SERVICE_KEY
The Universally Unique Identifier (UUID) for the service in which the event occurred.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_NAME
Name of the service in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
SERVICE_VERSION
The system-assigned version identifier for the service.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
SESSION_ID
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
Varchar(128)
Varchar(128)
NVarchar(128)
SOURCE_GATEWAY_NODE
Source API Gateway's IP address.
Example: 10.0.75.1
Varchar2(256)
Varchar(256)
Varchar(256)
STATUS
Status of the API request.
Possible values are: SUCCESS, FAILURE
Varchar(128)
Varchar(128)
NVarchar(128)
TARGET_NAME
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Varchar(32)
Varchar(32)
NVarchar(32)
TOTAL_DATA_SIZE
The total combined size of request and response payloads in bytes.
Example: 100
NUMERIC
INT
INTEGER
TOTAL_TIME
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
NUMERIC
INT
INTEGER
Error Events
Column Description
Oracle
DB2
MSSQL
API_ID
The unique identifier for the API.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b1
Varchar(256)
Varchar(256)
NVarchar(256)
API_NAME
Name of the API in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
API_VERSION
The system-assigned version identifier for the API.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_ID
The unique identifier for the application associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_IP
IP address of the application associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
APPLICATION_NAME
Name of the application associated with the API invocation.
An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchsar(128)
CONSUMER_ID
The unique identifier for the consumer associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_IP
IP address of the consumer associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
CONSUMER_NAME
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 policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchar(128)
CORRELATION_ID
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
Varchar2(256)
Varchar(256)
Varchar(256)
ERROR_SOURCE
The source where the error occurred.
Example: e1cc3c7b-495d-11e7-a5a6-88cf17308ba4
Varchar(256)
Varchar(256)
NVarchar(256)
ERROR_DESC
Message that describes the error that occurred.
Example: Resource / not found
Varchar(4000)
Varchar(4000)
NVarchar(4000)
EVENT_CREATE_TS
Date and time when the event was generated in API Gateway.
This is not the time the database performed its insert (for example, this is calculated by the Mediator policy engine and not a database function).
TIMESTAMP
TIMESTAMP
DATETIME
EVENT_SOURCE
The source where the event occurred.
Varchar(80)
Varchar(80)
NVarchar(80)
EVENT_TYPE
The type of event that occurred.
Example: Error Event
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_USERNAME
Name of the user on API Gateway that invoked the API.
Varchar(80)
Varchar(80)
NVarchar(80)
HTTP_METHOD
The HTTP method used to invoke the API.
Example: GET
Varchar(8)
Varchar(8)
NVarchar(8)
NATIVE_ENDPOINT
The endpoint URL of the native API that is invoked.
Example: http://petstore.swagger.io/v2/pet/55
Varchar(4000)
Varchar(4000)
NVarchar(4000)
OPERATION_NAME
Name of the API operation or resource that is invoked.
Example: /pet/{petId}
Varchar(256)
Varchar(256)
NVarchar(256)
ORG_KEY
The Globally Unique Identifier (GUID) for an organization.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
RESPONSE_CODE
The HTTP response status code that indicates success or failure of the requested operation.
Example: 200
Numeric
INT
INTEGER
SERVICE_KEY
The Universally Unique Identifier (UUID) for the service in which the event occurred.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_NAME
Name of the service in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
SERVICE_VERSION
The system-assigned version identifier for the service.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
SESSION_ID
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
Varchar(128)
Varchar(128)
NVarchar(128)
Monitoring Events
Column Description
Oracle
DB2
MSSQL
ALERT_DESC
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
Varchar(256)
Varchar(256)
NVarchar(256)
ALERT_SOURCE
Name of the API Gateway policy that generated the alert message.
Example: MonitorPolicy
Varchar(256)
Varchar(256)
NVarchar(256)
ALERT_TYPE
The type of alert generated for the event.
Possible values are: Monitor, SLA
Varchar(128)
Varchar(128)
NVarchar(128)
API_ID
The unique identifier for the API.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b1
Varchar(256)
Varchar(256)
NVarchar(256)
API_NAME
Name of the API in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
API_VERSION
The system-assigned version identifier for the API.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_ID
The unique identifier for the application associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_IP
IP address of the application associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
APPLICATION_NAME
Name of the application associated with the API invocation.
An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchsar(128)
BINDING_NAME
Name of the binding that identifies a specific access URI.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_ID
The unique identifier for the consumer associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_IP
IP address of the consumer associated with the API invocation.
Example: 10.20.248.33
Varchar(32)
Varchar(32)
NVarchar(32)
CONSUMER_NAME
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 policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchar(128)
EVENT_CREATE_TS
Date and time when the event was generated in API Gateway.
This is not the time the database performed its insert (for example, this is calculated by the Mediator policy engine and not a database function).
TIMESTAMP
TIMESTAMP
DATETIME
EVENT_SOURCE
The source where the event occurred.
Varchar(80)
Varchar(80)
NVarchar(80)
EVENT_TYPE
The type of event that occurred.
Example: Monitor Event
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_USERNAME
Name of the user on API Gateway that invoked the API.
Varchar(80)
Varchar(80)
NVarchar(80)
HTTP_METHOD
The HTTP method used to invoke the API.
Example: GET
Varchar(8)
Varchar(8)
NVarchar(8)
MONITOR_ATTR
The monitored attribute which has breached the configured SLA.
Example: AVGRESPONSETIME GT 1.0, SUCCESSCOUNT EQ 3, REQUESTCOUNT GT 10
Varchar(256)
Varchar(256)
NVarchar(256)
NATIVE_ENDPOINT
The endpoint URL of the native API that is invoked.
Example: http://petstore.swagger.io/v2/pet/55
Varchar(4000)
Varchar(4000)
NVarchar(4000)
OPERATION_NAME
Name of the API operation or resource that is invoked.
Example: /pet/{petId}
Varchar(256)
Varchar(256)
NVarchar(256)
ORG_KEY
The Globally Unique Identifier (GUID) for an organization.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
RESPONSE_CODE
The HTTP response status code that indicates success or failure of the requested operation.
Example: 200
Numeric
INT
INTEGER
SERVICE_KEY
The Universally Unique Identifier (UUID) for the service in which the event occurred.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_NAME
Name of the service in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
SERVICE_VERSION
The system-assigned version identifier for the service.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
SESSION_ID
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
Varchar(128)
Varchar(128)
NVarchar(128)
TARGET_NAME
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Varchar(64)
Varchar(64)
NVarchar(64)
Policy Violation Events
Column Description
Oracle
DB2
MSSQL
ALERT_DESC
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
Varchar(256)
Varchar(256)
NVarchar(256)
ALERT_SOURCE
Name of the API Gateway policy that generated the alert message.
Example: PolicyViolationPolicy
Varchar(256)
Varchar(256)
NVarchar(256)
ALERT_TYPE
The type of alert generated for the event.
Example: PolicyViolation
Varchar(128)
Varchar(128)
NVarchar(128)
API_ID
The unique identifier for the API.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b1
Varchar(256)
Varchar(256)
NVarchar(256)
API_NAME
Name of the API in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
API_VERSION
The system-assigned version identifier for the API.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_ID
The unique identifier for the application associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
APPLICATION_IP
IP address of the application associated with the API invocation.
Example: 10.20.248.33
Varchar(64)
Varchar(64)
NVarchar(64)
APPLICATION_NAME
Name of the application associated with the API invocation.
An application name is populated as unknown when API Gateway is unable to identify the application using a security policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchsar(128)
BINDING_NAME
Name of the binding that identifies a specific access URI.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_ID
The unique identifier for the consumer associated with the API invocation.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b2
Varchar(256)
Varchar(256)
NVarchar(256)
CONSUMER_IP
IP address of the consumer associated with the API invocation.
Example: 10.20.248.33
Varchar(32)
Varchar(32)
NVarchar(32)
CONSUMER_NAME
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 policy that is configured for the API.
Example: SampleApplication
Varchar(128)
Varchar(128)
NVarchar(128)
EVENT_CREATE_TS
Date and time when the event was generated in API Gateway.
This is not the time the database performed its insert (for example, this is calculated by the Mediator policy engine and not a database function).
TIMESTAMP
TIMESTAMP
DATETIME
EVENT_SOURCE
The source where the event occurred.
Varchar(80)
Varchar(80)
NVarchar(80)
EVENT_TYPE
The type of event that occurred.
Example: Policy Violation
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_USERNAME
Name of the user on API Gateway that invoked the API.
Varchar(80)
Varchar(80)
NVarchar(80)
HTTP_METHOD
The HTTP method used to invoke the API.
Example: GET
Varchar(8)
Varchar(8)
NVarchar(8)
NATIVE_ENDPOINT
The endpoint URL of the native API that is invoked.
Example: http://petstore.swagger.io/v2/pet/55
Varchar(4000)
Varchar(4000)
NVarchar(4000)
OPERATION_NAME Name of the API operation that is invoked.
Example: /pet/{petId}
Varchar(256)
Varchar(256)
NVarchar(256)
ORG_KEY
The Globally Unique Identifier (GUID) for an organization.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
RESPONSE_CODE
The HTTP response status code that indicates success or failure of the requested operation.
Example: 200
Numeric
INT
INTEGER
SERVICE_KEY
The Universally Unique Identifier (UUID) for the service in which the event occurred.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_NAME
Name of the service in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
SERVICE_VERSION
The system-assigned version identifier for the service.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
SESSION_ID
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
Varchar(128)
Varchar(128)
NVarchar(128)
TARGET_NAME
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Varchar(64)
Varchar(64)
NVarchar(64)
Performance Metrics
Column Description
Oracle
DB2
MSSQL
API_ID
The unique identifier for the API.
Example: c0f84954-9732-11e5-b9f4-f159eafe47b1
Varchar(256)
Varchar(256)
NVarchar(256)
API_NAME
Name of the API in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
API_VERSION
The system-assigned version identifier for the API.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
AVAIL
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
NUMBER
NUMBER (6, 2)
INTEGER
AVG_RESP
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: 1376
NUMBER
INT
INTEGER
BINDING_NAME
Name of the binding that identifies a specific access URI.
This column is currently not used. It appears as NULL or as an empty string.
Varchar(256)
Varchar(256)
NVarchar(256)
EVENT_CREATE_TS
Date and time when the event was generated in API Gateway.
This is not the time the database performed its insert (for example, this is calculated by the Mediator policy engine and not a database function).
TIMESTAMP
TIMESTAMP
DATETIME
EVENT_SOURCE
The source where the event occurred.
Varchar(80)
Varchar(80)
NVarchar(80)
EVENT_TYPE
The type of event that occurred.
Example: Performance Data
Varchar(256)
Varchar(256)
NVarchar(256)
FAULT_COUNT
Total number of error invocations for a specified API withing the configured metrics interval.
Example: 1
LIVELY
Boolean. Availability of an the API at the end of the current interval.
Char(1)
Char(1)
NChar(1)
MAX_RESP
The maximum amount of time (in milliseconds) it took for the API to complete an invocation in the current interval.
Example: 1401
NUMBER
INT
INTEGER
MIN_RESP
The minimum amount of time (in milliseconds) it took for the API to complete an invocation in the current interval.
Example: 1352
NUMBER
INT
INTEGER
NATIVE_ENDPOINT
The endpoint URL of the native API that is invoked.
Example: http://petstore.swagger.io/v2/pet/55
Varchar(4000)
Varchar(4000)
NVarchar(4000)
OPERATION_NAME
Name of the API operation or resource that is invoked.
Example: /pet/{petId}
Varchar(256)
Varchar(256)
NVarchar(256)
ORG_KEY
The Globally Unique Identifier (GUID) for the organization.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_KEY
The Universally Unique Identifier (UUID) for the service in which the event occurred.
This column is currently not used by APIs created in API Gateway. It is used to support the APIs that are migrated from CentraSite or Mediator to API Gateway.
Varchar(128)
Varchar(128)
NVarchar(128)
SERVICE_NAME
Name of the service in which the event occurred.
Example: SampleAPI
Varchar(256)
Varchar(256)
NVarchar(256)
SERVICE_VERSION
The system-assigned version identifier for the service.
Example: 1.0
Varchar(256)
Varchar(256)
NVarchar(256)
SUCCESS_COUNT
The number of successful API invocations in the current interval.
Example: 1
NUMBER
INT
INTEGER
TARGET_NAME
Name of the API Gateway instance reporting the event.
Example: API_Gateway_Instance
Varchar(64)
Varchar(64)
NVarchar(64)
TOTAL_COUNT
The total number of API invocations (successful and unsuccessful) in the current interval.
Example: 2
NUMBER
INT
INTEGER