B2B Integration 10.5 | Administering and Monitoring B2B Transactions | Trading Networks Administrator's Guide | Monitoring API Usage | Viewing the API Usage Details of a Partner
 
Viewing the API Usage Details of a Partner
Prerequisites:A partner must have access to at least a single API in the associated API Gateway instance to view the API usage details.
* To view the API usage details of a Partner
1. In My webMethods Server: Navigate > Applications > Monitoring > Integration > B2B > API Usage.
2. In the API Usage Monitoring page, select values for the fields listed in the following table:
Field
Description
Partner
Select a partner from the list of partners in Trading Networks
API Name
Select an API from the list of accessible APIs for the selected partner.
Duration
Select the time interval to view all the API invocations made by the partners. Use the Custom option to view the API invocations within a specific date range.
*From Date. Select the date from when you want to view the invocation details.
*To Date. Select the date until when you want to view the invocation details.
3. Click Apply Filters.
A list of APIs invoked by the partner appears in a table with the following details for each API:
Field
Description
Invocation Time
Time when the API was invoked.
API Name
Name of the API.
API Version
Version of API that was accessed.
Partner Name
Name of the selected partner.
Operation Name
Name of the operation for which the API was invoked. An operation refers to activities you can perform based on the business logic exposed by the API. For example, in an pet store inventory API, the following operations are possible:
*Inventory/create. Create an inventory for a new type of pet toy.
*Inventory/add. Add an item to the inventory.
*Inventory/update. Update the quantity of an item in the inventory.
*Inventory/delete. Delete an item in the inventory.
Method
Name of the method that was used for the operation. For example, GET, PUT, POST, and DELETE.
Response Code
The HTTP response status code that indicates the status of the requested operation. The possible values are success and failure. For example, response code 200 indicates OK.
Status
Status of the invocation. The possible values are Success and Failure.
Provider Time
Time taken ( in milliseconds) for API Gateway to invoke a native API 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 the total time from the provider time gives a rough indicator of the API Gateway overhead.
For example, for a transactional event type, the provider could be a native messaging provider that facilitates the exchange of request and response messages from the native API to API Gateway and vice versa.
Total Time
The amount of time taken (in milliseconds) for the API to complete the invocation.
Total Data Size
The combined size of the request and response payloads in bytes.
Copyright © 2016- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.