TransactionInfo Object
A set of information about a specific transaction.
The transaction log includes all the information listed below. This object is used by these services: apps and apis.
This object is used by the following operations:
- Operations that reference the TransactionsInfo object; for example, the GET /api/apis/versions/{APIVersionID}/txlogs operation
- Operations that reference the TransactionRecord object; for example, the GET /api/apis/versions/{APIVersionID}/txlogs/{TransactionID} operation
The properties included in the TransactionInfo object are listed below.
| Property | Type | Description |
|---|---|---|
| TransactionID | string | The unique ID for a specific transaction.Example: d706739b-b425-11e2-bf83-98ba4043f1fe |
| APIID | string | The unique ID for a specific API. |
| APIName | string | The name of the API to which the call is being made. |
| APIVersionID | string | The unique ID for a specific API version. |
| MethodName | string | The name of the operation being invoked. |
| AppID | string | The unique ID for a specific app. |
| AppName | string | The name of the app invoking the operation. |
| AppVersionID | string | The unique ID for a specific app version. |
| RequestDateTime | dateTime | The date/time stamp of the request. Example: 2013-05-03T15:25:47.234Z. |
| ResponseStatusCode | unsignedInt | The status code for the response. |
| ClientHost | string | The IP address for the client host. |
| APIVersionName | string | The name of the API version the transaction relates to. |
| MethodKey | string | The name of the operation invoked in the transaction. |
| AppVersionName | string | The name of the app version the transaction relates to. |
| AppRuntimeID | string | The app's Runtime ID. |
| ResponseTime | duration | The response time for the message. |
| RequestMessageSize | unsignedLong | Request message size in bytes. |
| ResponseMessageSize | unsignedLong | Response message size in bytes. |
| ResponseErrorMessage | string | Response error message, if any. |
| APIResponseTime | duration | Response time for the API. |
| APIURL | string | URL for the API. |
| HttpVerb | string | The HTTP verb for the operation. |
|
GatewayTime Version: 2020.1.0 |
duration | The total time taken by the Gateway, on inbound and outbound (request processing time plus response processing time). |
|
GatewayReqProcessingTime Version: 2020.1.0 |
duration |
The time from when the Gateway receives the request to when the Gateway initiates the request to the next-hop service. During this time, the Gateway might be performing multiple activities: for example, retrieving public keys or certificates, validating OAuth tokens. |
|
GatewayRespProcessingTime Version: 2020.1.0 |
duration | The time from when the Gateway receives the response from the next-hop service to when the Gateway initiates writing the response. |
|
GatewayRespWriteTime Version: 2020.1.0 |
duration | The time the Gateway takes to write the complete response to the client. |
|
GatewayReqReadTime Version: 2020.1.0 |
duration | The time the Gateway takes to read the request payload. |
