GET /api/apis/versions/{APIVersionID}/txlogs
Returns up to 1000 transaction logs for the specified API version. If no count parameters specified, returns 100 transactions.
With the optional ContractID, returns transaction logs for a specific app/API contract. Additional optional parameters allow you to specify more clearly the set of transaction logs that you want.
Authorization Roles/Permissions: Must be logged in. Must be a user with Monitor permission for the API; an API Admin or Business Admin or an app developer who has a contract with the API.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/versions/{APIVersionID}/txlogs[?][ContractID={ContractID}]
&[AppVersionID={AppVersionID}]&[Environment={Environment}]&[StartDate={StartDate}]&[EndDate={EndDate}]
&[TimeZone={TimeZone}]&[Duration={Duration}]&[start={start}][&count={count}]
Sample Request
The example below shows a request for the first four transactions for the specified API version.
Sample Request URL
https://{hostname}/api/apis/versions/6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp/txlogs?Environment=Production&Duration=1M&TimeZone=America%2FNew_York
Sample request headers
Accept: application/json X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | application/json, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| APIVersionID | Path | string | Required | The unique ID for a specific API version. |
| ContractID | Query | string | Required | The unique ID for a specific contract between an app version and an API version. |
| AppVersionID | Query | string | Required | The unique ID for a specific app version. |
| Environment | Query | string | Required | The environment (implementation) (Sandbox or Production). If not specified, defaults to Production. |
| StartDate | Query | string | Required | The beginning point for the date range of metric information requested. Format: YYYY-MM-DD:THH:MM:SS. Example: StartDate=2011-01-01T11:55:22. If StartDate is not specified, the operation uses EndDate minus Duration. If both StartDate and EndDate are unspecified, the operation returns information for the Duration value, and if Duration is also unspecified it returns default Duration value of 2 hours. |
| EndDate | Query | string | Required | The ending point for the date range of metric information requested. Format: YYYY-MM-DD:THH:MM:SS. Example: EndDate=2011-01-02T11:55:22. If not specified, defaults to the current date/time of the API call. |
| TimeZone | Query | string | Optional | The time zone for the information. If a time zone isn't specified, the information is returned in GMT. For more information, refer to Working with Time Zones and Time Intervals. |
| Duration | Query | string | Optional | The duration for the metric information. For example, you might want metric information for a 24-hour period or only for an hour. The StartDate, EndDate, and Duration fields work together to define the information to be returned. If not specified, defaults to two hours (2h). |
| start | Query | integer | Optional | An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result. |
| count | Query | integer | Optional | The count of log items. Max: 1000. Default: 100. |
|
OperationName Version: 2019.1.0 |
Query | string | Optional | The specific operation for which information should be returned. |
|
Status Version: 2019.1.0 |
Query | integer | Required | One more more specific HTTP status values. If Status is specified, only transactions with that status are included in the results. For valid values, see Status (HTTP). |
|
FromResponseTime Version: 2019.1.0 |
Query | integer | Required | The beginning time of a range. |
|
ToResponseTime Version: 2019.1.0 |
Query | integer | Required | The ending time of a range. |
Response
If successful, this operation returns HTTP status code 200, with the transaction logs.
Sample Response
The sample response below shows the transaction logs for a specific API version. The first four transactions have been requested (see example request above).
Sample response headers: application/json
Status Code: 200 OK Content-Type: application/json Date: Tue, 21 Jul 2020 20:24:47 GMT
Sample response body: application/json
{
"TransactionInfo":[
{
"TransactionID":"54d67bd6-15d9-4eb6-9765-f48081bef37e",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T14:28:47.901-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"54d67bd6-15d9-4eb6-9765-f48081bef37e",
"ResponseTime":"P0Y0M0DT0H0M0.320S",
"RequestMessageSize":0,
"ResponseMessageSize":75026,
"APIResponseTime":"P0Y0M0DT0H0M0.204S",
"APIURL":"http://akana-qa-44:7905/api15427live/34534534535",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.101S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.101S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.000S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.008S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"9d830e55-698a-4464-ae8f-9b7425f6dc06",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T13:12:00.403-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"9d830e55-698a-4464-ae8f-9b7425f6dc06",
"ResponseTime":"P0Y0M0DT0H0M0.101S",
"RequestMessageSize":0,
"ResponseMessageSize":74811,
"APIResponseTime":"P0Y0M0DT0H0M0.085S",
"APIURL":"http://akana-qa-44:7905/api15427live/887868768",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.003S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.002S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.001S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.006S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"e54dea20-e89e-4ee6-861f-32857cf577c8",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T13:10:56.942-04:00",
"ResponseStatusCode":404,
"ClientHost":"10.250.24.239",
"MethodKey":"e54dea20-e89e-4ee6-861f-32857cf577c8",
"ResponseTime":"P0Y0M0DT0H0M0.138S",
"RequestMessageSize":0,
"ResponseMessageSize":193,
"ResponseErrorMessage":"Received fault from next hop: faultcode : [404] faultstring : [Not Found]",
"APIResponseTime":"P0Y0M0DT0H0M0.114S",
"APIURL":"http://akana-qa-44:7905/api15427live/4335345",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.003S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.003S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.000S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"4a7e2df0-86de-4075-853d-463c97b516c5",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T13:06:53.882-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"4a7e2df0-86de-4075-853d-463c97b516c5",
"ResponseTime":"P0Y0M0DT0H0M0.092S",
"RequestMessageSize":0,
"ResponseMessageSize":128,
"APIResponseTime":"P0Y0M0DT0H0M0.083S",
"APIURL":"http://akana-qa-44:7905/api15427live/34234324",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.004S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.003S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.001S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"1bb13028-a37f-4c07-9632-89cc3145df15",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T13:02:03.888-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"1bb13028-a37f-4c07-9632-89cc3145df15",
"ResponseTime":"P0Y0M0DT0H0M0.117S",
"RequestMessageSize":0,
"ResponseMessageSize":100,
"APIResponseTime":"P0Y0M0DT0H0M0.109S",
"APIURL":"http://akana-qa-44:7905/api15427live/898998",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.002S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.002S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.000S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"48b76d1c-55a8-432b-8b52-d5b381e2e087",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T12:58:44.325-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"48b76d1c-55a8-432b-8b52-d5b381e2e087",
"ResponseTime":"P0Y0M0DT0H0M0.016S",
"RequestMessageSize":0,
"ResponseMessageSize":109,
"APIResponseTime":"P0Y0M0DT0H0M0.007S",
"APIURL":"http://akana-qa-44:7905/api15427live/2423432434",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.003S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.002S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.001S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"31829f22-7074-452b-bd22-647a31e41de5",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T12:58:40.885-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"31829f22-7074-452b-bd22-647a31e41de5",
"ResponseTime":"P0Y0M0DT0H0M0.015S",
"RequestMessageSize":0,
"ResponseMessageSize":109,
"APIResponseTime":"P0Y0M0DT0H0M0.007S",
"APIURL":"http://akana-qa-44:7905/api15427live/423442234234",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.002S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.002S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.000S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"c00aa4f5-114b-4d33-9b5a-ae8b82b1461b",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T12:58:40.064-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"c00aa4f5-114b-4d33-9b5a-ae8b82b1461b",
"ResponseTime":"P0Y0M0DT0H0M0.098S",
"RequestMessageSize":0,
"ResponseMessageSize":109,
"APIResponseTime":"P0Y0M0DT0H0M0.086S",
"APIURL":"http://akana-qa-44:7905/api15427live/423442234234",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.005S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.004S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.001S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"1aede4ab-a804-45f3-bdcc-6adb66e6c286",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T12:57:19.018-04:00",
"ResponseStatusCode":500,
"ClientHost":"10.250.24.239",
"MethodKey":"1aede4ab-a804-45f3-bdcc-6adb66e6c286",
"ResponseTime":"P0Y0M0DT0H0M0.092S",
"RequestMessageSize":0,
"ResponseMessageSize":23,
"ResponseErrorMessage":"java.lang.String cannot be cast to com.soa.message.Message",
"APIResponseTime":"P0Y0M0DT0H0M0.087S",
"APIURL":"http://akana-qa-44:7905/api15427live/23131312",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.005S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.003S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.002S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
},
{
"TransactionID":"489c65f2-59f2-41c1-a2ff-c932a694992d",
"APIID":"cf765652-f5bc-440e-abdb-a38503199365.acmepaymentscorp2020-1",
"APIName":"Orchestration",
"APIVersionID":"6929b1a5-c1ce-4285-b02b-6659ba879dda.acmepaymentscorp2020-1",
"MethodName":"Default_Operation",
"RequestDateTime":"2020-07-17T10:11:24.524-04:00",
"ResponseStatusCode":200,
"ClientHost":"10.250.24.239",
"MethodKey":"489c65f2-59f2-41c1-a2ff-c932a694992d",
"ResponseTime":"P0Y0M0DT0H0M0.354S",
"RequestMessageSize":0,
"ResponseMessageSize":150,
"APIResponseTime":"P0Y0M0DT0H0M0.307S",
"APIURL":"http://akana-qa-44:7905/api15427live/200",
"HttpVerb":"GET",
"GatewayTime":"P0Y0M0DT0H0M0.046S",
"GatewayReqProcessingTime":"P0Y0M0DT0H0M0.046S",
"GatewayRespProcessingTime":"P0Y0M0DT0H0M0.000S",
"GatewayRespWriteTime":"P0Y0M0DT0H0M0.000S",
"GatewayReqReadTime":"P0Y0M0DT0H0M0.000S"
}
]
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | application/json, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
Response Body
| Name | Type | Description |
|---|---|---|
| TransactionsInfo | TransactionsInfo[ ] | Contains information about one or more transactions for the API, with details for each. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.