Articles in this section

Request logs in API Builder

Viewing request logs is essential for monitoring, debugging, and optimizing API performance. Logs provide a detailed record of incoming requests, pre-mapped responses, and responses. By analyzing these logs, you can identify bottlenecks, unauthorized access attempts, and failed API calls, improving security and reliability.

Open and view your request logs

To open your API's request log from the API builder list:

  1. Click ResourcesAPIs.

    resources_api.png
  2. Navigate to the API builder tab.

  3. Find your API in the list and click Actions (...)View request logs.

    request_logs_action_menu.png

To open your API's request log from API builder:

  1. Click ResourcesAPIsAPI builder<Your API>.

    resources_api.png
  2. Click Actions overflow (...)View request logs.

    Request_logs_menu.png

Navigate your request logs

After opening your request logs, you'll see a list of all requests on the left side. These requests can be sorted by timestamp, method, or response code. The Actions (...) menu allows you to delete a request log.

Log data is displayed on the right side and separated into API request, Pre-mapped response, and API response data tabs.

You can refresh the data to fetch the latest API requests by clicking Refresh refresh.svg. You will not see any request log entries without request history for the filtered criteria. Old request logs are purged based on your data retention policy (30, 60, 90, or 180 days).

All the data in your API logs can be copied using the Copy copy.svg​​ button.

request_logs.png

API request

This tab shows the API request's body, headers, and Other data (e.g., request URL, method, and requestSize). This is the API request as your API consumer sent it.

Request_logs_API_request.png

Pre-mapped response

This tab lets you view the records before they're mapped in the API response. This includes the source records as they're sent, execution errors, and configuration errors.

Check the API request log execution errors to troubleshoot issues while keeping error details hidden from API consumers. Learn more about creating custom errors.

Configuration errors display if your API setup is incomplete—such as missing a Relative URI, HTTP method, status code in response nodes, or an unmerged branch. In these cases, you’ll see a 501 (Not Implemented) error.

Request_logs_-_premap_response.png

Execution error

configuration_errors.png

Configuration error

API response

This is the API response sent to your API consumer. This tab shows the API response's body, headers, and Other data (e.g., statusCode, responseSize, and duration).

request_logs_-_API_response.png