GET /api/apis/versions/{APIVersionID}/environments/{Environment}/operations/{OperationName}/txlogs

Returns transaction logs for the specified operation in the specified environment.

Optional parameters allow you to further narrow down a transaction range; for example, by date range.

Authorization Roles/Permissions: 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

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/environments/{Environment}/operations/{OperationName}/txlogs[?]
&[StartDate={StartDate}]&[EndDate={EndDate}]&[TimeZone={TimeZone}]&[Duration={Duration}]&[start={start}][&count={count}]

Back to top

Sample Request

The example below shows a request for the first five transactions for the specified environment/operation.

Request URL

In the example below, a line break was added for display purposes.

https://{hostname}/api/apis/versions/0f14e2b3-671a-49e4-98ac-eef610a58a81.acmepaymentscorp/environments/
Production/operations/getPetById/txlogs?count=2

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

application/json, application/xml

application/vnd.soa.v72+json, application/vnd.soa.v72+xml

application/vnd.soa.v72+json,application/vnd.soa.v72+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
Environment Path string Required The environment (implementation) (Sandbox or Production).
OperationName Path string Required The specific operation for which metrics should be returned.
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. If not specified, defaults to two hours (2h). The StartDate, EndDate, and Duration fields work together to define the information to be returned.
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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the transaction logs.

Back to top

Sample Response

The sample response belows shows the transaction logs for specific API version. In the JSON example, the first two transactions have been requested (see example request above). The XML example includes three transactions.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 30 Dec 2015 17:49:10 GMT

Sample response body: application/json

{
  "TransactionInfo" : [ {
    "TransactionID" : "eccf145f-af1b-11e5-b10b-bd5e99870074",
    "APIID" : "77486534-f920-4c20-9b80-be5b5f239caf.acmepaymentscorp",
    "APIName" : "SwaggerAPI_Both",
    "APIVersionID" : "3808a7eb-cda3-4ef2-b6c9-45cd7afc05cb.acmepaymentscorp",
    "MethodName" : "getPetById",
    "AppID" : "e76fee30-0e41-4e83-a864-6a9c0378ecf5.acmepaymentscorp",
    "AppName" : "__SwaggerApp_prod",
    "AppVersionID" : "8NIpdvkgDKjcUSRTSYHntRP9.acmepaymentscorp",
    "RequestDateTime" : "2015-12-30T17:36:57Z",
    "ResponseStatusCode" : 200,
    "ClientHost" : "10.1.22.242",
    "APIVersionName" : "1.0",
    "MethodKey" : "eccf145f-af1b-11e5-b10b-bd5e99870074",
    "AppVersionName" : "1.0",
    "AppRuntimeID" : "8NIpdvkgDKjcUSRTSYHntRP9",
    "ResponseTime" : "P0Y0M0DT0H0M0.254S",
    "RequestMessageSize" : 0,
    "ResponseMessageSize" : 155,
    "APIResponseTime" : "P0Y0M0DT0H0M0.069S",
    "APIURL" : "http://www.acmepaymentscorp.com/prod/pet/1451489108665",
    "HttpVerb" : "GET"
  }, {
    "TransactionID" : "c3db2f0d-af1a-11e5-b10b-bd5e99870074",
    "APIID" : "77486534-f920-4c20-9b80-be5b5f239caf.acmepaymentscorp",
    "APIName" : "SwaggerAPI_Both",
    "APIVersionID" : "3808a7eb-cda3-4ef2-b6c9-45cd7afc05cb.acmepaymentscorp",
    "MethodName" : "getPetById",
    "AppID" : "e76fee30-0e41-4e83-a864-6a9c0378ecf5.acmepaymentscorp",
    "AppName" : "__SwaggerApp_prod",
    "AppVersionID" : "8NIpdvkgDKjcUSRTSYHntRP9.acmepaymentscorp",
    "RequestDateTime" : "2015-12-30T17:28:39Z",
    "ResponseStatusCode" : 200,
    "ClientHost" : "10.1.22.242",
    "APIVersionName" : "1.0",
    "MethodKey" : "c3db2f0d-af1a-11e5-b10b-bd5e99870074",
    "AppVersionName" : "1.0",
    "AppRuntimeID" : "8NIpdvkgDKjcUSRTSYHntRP9",
    "ResponseTime" : "P0Y0M0DT0H0M1.272S",
    "RequestMessageSize" : 0,
    "ResponseMessageSize" : 155,
    "APIResponseTime" : "P0Y0M0DT0H0M0.068S",
    "APIURL" : "http://www.acmepaymentscorp.com/prod/pet/1451489108665",
    "HttpVerb" : "GET"
  } ]
}

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Date:  Wed, 06 Jan 2016 18:16:51 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TransactionsInfo xmlns="http://soa.com/xsd/performance/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/contract/1.0" xmlns:ns4="http://soa.com/xsd/api/1.0" 
xmlns:ns5="http://soa.com/xsd/app/1.0" xmlns:ns6="http://soa.com/xsd/legals/1.0" 
xmlns:ns7="http://soa.com/xsd/dnmodel/1.0" xmlns:ns8="http://soa.com/xsd/resource/1.0">
  <TransactionInfo>
    <TransactionID>5c90f9df-b4a0-11e5-867b-832f054c50dc</TransactionID>
    <APIID>93e5dfba-3b21-43f7-8553-e3cfe952c02c.acmepaymentscorp</APIID>
    <APIName>SwaggerAPI_Both</APIName>
    <APIVersionID>c984f021-eea6-4aa8-a14e-4c6ff3aebfe5.acmepaymentscorp</APIVersionID>
    <MethodName>getPetById</MethodName>
    <AppID>4249e762-7385-4434-9e34-e053ed27ecfd.acmepaymentscorp</AppID>
    <AppName>__SwaggerApp_prod</AppName>
    <AppVersionID>8f79KOC5hVjat8oaR8WKs5Uu.acmepaymentscorp</AppVersionID>
    <RequestDateTime>2016-01-06T18:07:34Z</RequestDateTime>
    <ResponseStatusCode>200</ResponseStatusCode>
    <ClientHost>10.1.22.242</ClientHost>
    <APIVersionName>1.0</APIVersionName>
    <MethodKey>5c90f9df-b4a0-11e5-867b-832f054c50dc</MethodKey>
    <AppVersionName>1.0</AppVersionName>
    <AppRuntimeID>8f79KOC5hVjat8oaR8WKs5Uu</AppRuntimeID>
    <ResponseTime>P0Y0M0DT0H0M0.075S</ResponseTime>
    <RequestMessageSize>0</RequestMessageSize>
    <ResponseMessageSize>160</ResponseMessageSize>
    <APIResponseTime>P0Y0M0DT0H0M0.068S</APIResponseTime>
    <APIURL>http://www.acmepaymentscorp.com/prod/pet/1452103486957</APIURL>
    <HttpVerb>GET</HttpVerb>
  </TransactionInfo>
  <TransactionInfo>
    <TransactionID>5c2abdfd-b4a0-11e5-867b-832f054c50dc</TransactionID>
    <APIID>93e5dfba-3b21-43f7-8553-e3cfe952c02c.acmepaymentscorp</APIID>
    <APIName>SwaggerAPI_Both</APIName>
    <APIVersionID>c984f021-eea6-4aa8-a14e-4c6ff3aebfe5.acmepaymentscorp</APIVersionID>
    <MethodName>getPetById</MethodName>
    <AppID>4249e762-7385-4434-9e34-e053ed27ecfd.acmepaymentscorp</AppID>
    <AppName>__SwaggerApp_prod</AppName>
    <AppVersionID>8f79KOC5hVjat8oaR8WKs5Uu.acmepaymentscorp</AppVersionID>
    <RequestDateTime>2016-01-06T18:07:33Z</RequestDateTime>
    <ResponseStatusCode>200</ResponseStatusCode>
    <ClientHost>10.1.22.242</ClientHost>
    <APIVersionName>1.0</APIVersionName>
    <MethodKey>5c2abdfd-b4a0-11e5-867b-832f054c50dc</MethodKey>
    <AppVersionName>1.0</AppVersionName>
    <AppRuntimeID>8f79KOC5hVjat8oaR8WKs5Uu</AppRuntimeID>
    <ResponseTime>P0Y0M0DT0H0M0.087S</ResponseTime>
    <RequestMessageSize>0</RequestMessageSize>
    <ResponseMessageSize>160</ResponseMessageSize>
    <APIResponseTime>P0Y0M0DT0H0M0.068S</APIResponseTime>
    <APIURL>http://www.acmepaymentscorp.com/prod/pet/1452103486957</APIURL>
    <HttpVerb>GET</HttpVerb>
  </TransactionInfo>
  <TransactionInfo>
    <TransactionID>448baef8-b4a0-11e5-867b-832f054c50dc</TransactionID>
    <APIID>93e5dfba-3b21-43f7-8553-e3cfe952c02c.acmepaymentscorp</APIID>
    <APIName>SwaggerAPI_Both</APIName>
    <APIVersionID>c984f021-eea6-4aa8-a14e-4c6ff3aebfe5.acmepaymentscorp</APIVersionID>
    <MethodName>getPetById</MethodName>
    <AppID>4249e762-7385-4434-9e34-e053ed27ecfd.acmepaymentscorp</AppID>
    <AppName>__SwaggerApp_prod</AppName>
    <AppVersionID>8f79KOC5hVjat8oaR8WKs5Uu.acmepaymentscorp</AppVersionID>
    <RequestDateTime>2016-01-06T18:06:54Z</RequestDateTime>
    <ResponseStatusCode>200</ResponseStatusCode>
    <ClientHost>10.1.22.242</ClientHost>
    <APIVersionName>1.0</APIVersionName>
    <MethodKey>448baef8-b4a0-11e5-867b-832f054c50dc</MethodKey>
    <AppVersionName>1.0</AppVersionName>
    <AppRuntimeID>8f79KOC5hVjat8oaR8WKs5Uu</AppRuntimeID>
    <ResponseTime>P0Y0M0DT0H0M0.782S</ResponseTime>
    <RequestMessageSize>0</RequestMessageSize>
    <ResponseMessageSize>167</ResponseMessageSize>
    <APIResponseTime>P0Y0M0DT0H0M0.141S</APIResponseTime>
    <APIURL>http://www.acmepaymentscorp.com/prod/pet/1452087586438</APIURL>
    <HttpVerb>GET</HttpVerb>
  </TransactionInfo>
</TransactionsInfo>

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/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

Back to top

Response Body

Name Type Description
TransactionsInfo TransactionsInfo[ ] Contains information about one or more transactions for the API, with details for each.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics