Last verified with: 10.8.6.0
Overview #
The JSON API Log screen is used to review API request/response history. The screen is intended for troubleshooting, traceability, and support investigation.
It is also useful for developers and integration teams who need to better understand the sequence of API activity used for actions in the system, such as what requests were sent, what data was returned, and how the platform responded over time.
Selecting a log entry exposes both metadata and full request/response payload details.
JSON API Log Panel #
The JSON API Log Panel on the left allows you to select existing records so that you can view and edit their details on the panel to the right. Selecting an item loads its metadata and payload details into the right panel. This is a review screen and does not expose edit actions.
Filtering The List #
The list can be filtered so users can narrow the set of API log entries they are reviewing.
Filtering is useful when users need to focus on a smaller group of requests, such as requests for a particular endpoint, requests from a specific time period, or requests associated with a known tracking value.
When troubleshooting, filtering the list can make it easier to isolate the relevant API interaction before reviewing the request details, response details, and related metadata in the right panel.
Log Details #
The information in this section reflects the currently selected record. From here you can review the current configuration and make changes where permitted.
These fields are used to identify the request, understand the outcome, and correlate the request with upstream/downstream processing.
Fields #
- User: shows the user or process associated with the API request when that information is available.
- Request URI: shows the API endpoint that was called.
- Tracking ID: identifies the request for correlation across related logs, processing steps, or troubleshooting workflows.
- Idempotency Key: shows the idempotency value used to prevent duplicate processing when the integration supports idempotent requests.
- Response Reason Code: shows the reason phrase or returned outcome detail associated with the response.
- Response Status Code: shows the HTTP status code returned by the system.
- Request Verb: shows the HTTP method used for the request, such as
GET,POST,PUT, orDELETE. - Request Length: shows the size of the request payload.
- Duration: shows how long the request took to process.
- Response Length: shows the size of the response payload returned by the system.
- IP Address From: shows the source IP address associated with the request.
- IP Address To: shows the destination IP address associated with the request.
- UTC Date: shows when the request was logged in UTC.
Response Tab #
The Response tab contains the data that was returned by the system for the selected API request.
This tab includes:
- the response body
- the response headers
These viewers are useful when validating returned data, confirming status details, or troubleshooting API failures.
Request Tab #
The Request tab shows what was sent to the system for the selected API log entry.
This tab includes:
- the request body
- the request headers
These viewers are useful when validating payload shape, reviewing header values, and understanding integration behavior.
Troubleshooting Use #
This screen is most useful when administrators, support teams, or developers need to investigate how a specific API interaction was processed by the system.
Common troubleshooting uses include:
- correlating a request by Tracking ID
- reviewing the request body and headers that were sent to the system
- reviewing the response body and headers returned by the system
- confirming the response status and reason code for the request
- analyzing request duration, request size, and response size
- checking the source and destination IP details involved in the request
Taken together, these details help users determine what was sent, how the system responded, and where an integration or processing issue may have occurred.