How to Review Blackbox API Trace Logs [Step-by-Step Guide]

You can review API (Application Programming Interface) trace logs in techSHIP to monitor API calls made to the platform.

This tool is essential for troubleshooting, tracking actions, and analyzing integration workflows (where only inputs and outputs are visible, but not the internal processes—this is known as the Blackbox approach).

NOTE: This page is only accessible to Portal Administrators. 

NOTE: Make sure the appropriate account is selected in the header switcher. 

NOTE: All dates and times are displayed and filtered according to the portal's time zone.

To review the API trace logs:

1. Click API Trace from the left menu under the Maintenance section.

2. Filter the logs table using the:

• Search Bar: Instantly search for entries by any part of the URL. 
• Advanced Filter: Opens a pop-up with the following filter options:
  • Event Date: Filter entries by the specified date.
  • Url: Filter by any matching part of the URL. 
  • Client Api Key: Filter entries by a specific client. 
  • Request: Filter by any part of the request payload. 
  • Response: Filter by any part of the response payload.
    
    
    NOTE: Use the Request and Response filters to quickly locate entries with specific values or field names, saving time in your research. 
    
    

NOTE: You can click on the Event Date/Time column header to sort by ascending or descending order.

3. Press the Details icon for the desired entry to open its details. 

4. Review the entry details.

The API Trace Details pop-up window provides you with the following information:

• Event Date/Time: The date and time of the API call. 
• Duration (second): Time taken for the call to be processed by techSHIP.
• Url: Full API URL used. 
• Request headers: Complete headers sent with the request. 
• Request: The full request payload sent to techSHIP, including fields and values. 
• Response headers: (If applicable) Complete headers returned by techSHIP. 
• Response: The complete response from techSHIP, varying based on the method called and values provided.