Skip to content

API Call Log

The API Call Log records every HTTP request that DIBOP makes to your connected external systems. It provides full visibility into what data is being sent and received, with timing, status codes, and error details.

Accessing the API Call Log

Navigate to MONITOR > API Call Log in the sidebar. You will see a paginated table of API calls, most recent first.

What the Log Shows

Each row in the log represents a single HTTP request to an external system:

Column Description
Timestamp When the call was made
System The connected system (with its icon)
Method HTTP method (GET, POST, PUT, DELETE)
Endpoint The API endpoint path
Status HTTP response status code
Duration Response time in milliseconds
Orchestration Which orchestration triggered this call (if applicable)

System Icons

Each system has a recognisable icon in the log. The icon helps you quickly scan the log and identify which systems are being called.

Stub connectors are indicated with a dashed border around the icon and a small STUB badge, so you can easily distinguish real API calls from mock/simulated ones.

Status Code Colours

Status codes are colour-coded for quick scanning:

Range Colour Meaning
2xx Green Success
3xx Blue Redirect
4xx Amber Client error (bad request, auth failure, not found)
5xx Red Server error (external system failure)

Filtering

The API Call Log supports several filters:

By System

Select one or more systems to see only their API calls. This is useful when investigating issues with a specific integration.

By Status

Filter by response status:

  • All -- show everything
  • Success (2xx) -- only successful calls
  • Client Error (4xx) -- authentication failures, bad requests
  • Server Error (5xx) -- external system failures
  • Timeout -- calls that did not receive a response

By Date Range

Set a start and end date to view calls within a specific period:

  • Last hour
  • Last 24 hours
  • Last 7 days
  • Last 30 days
  • Custom range

By Orchestration

Filter to see only API calls made by a specific orchestration. This is helpful when debugging a particular workflow.

Call Detail

Click any row to open the call detail panel, showing:

Request

Field Description
Full URL The complete URL including query parameters
Headers Request headers (sensitive values like API keys are masked)
Body Request body (for POST/PUT requests)

Response

Field Description
Status Code The HTTP status code and reason phrase
Headers Response headers
Body Response body (JSON is formatted for readability)

Timing

Field Description
Total Duration End-to-end time from request sent to response received
DNS Lookup Time to resolve the hostname
Connection Time to establish the TCP connection
TLS Handshake Time to complete the TLS/SSL handshake
Time to First Byte Time from request sent to first byte of response
Content Transfer Time to receive the full response body

Per-System Statistics

The API Call Log page also provides aggregate statistics. Click the Statistics tab (or navigate to it from the Observability dashboard) to see:

Metric Description
Total Calls Total number of API calls to each system
Success Count Number of successful calls (2xx)
Error Count Number of failed calls (4xx + 5xx)
Avg Duration Average response time in milliseconds
Calls Last 7 Days Number of calls in the last 7 days
Success Rate Percentage of successful calls

These statistics help you identify:

  • Which systems are called most frequently
  • Which systems have the highest error rates
  • Which systems are slowest to respond

Common Patterns

Investigating Repeated Failures

If you see a cluster of red (5xx) entries for the same system:

  1. Filter by that system and status "Server Error"
  2. Check the timestamps -- are failures clustered or spread out?
  3. Click a failure to see the response body -- the external system may include an error message
  4. Cross-reference with the Execution Log to see which orchestrations were affected

Investigating Slow Responses

If the average duration for a system is increasing:

  1. Filter by that system
  2. Sort by duration (descending) to find the slowest calls
  3. Check the timing breakdown to identify the bottleneck (DNS, connection, server processing)
  4. Consider adjusting the connection timeout or contacting the external system's support

Identifying Rate Limiting

If you see 429 (Too Many Requests) responses:

  1. Filter by status "Client Error" and look for 429s
  2. Check the response headers for Retry-After values
  3. Review the Quotas & Rate Limits configuration
  4. Consider reducing the frequency of orchestrations that call the affected system

Data Retention

API call logs are retained according to your enterprise's retention policy:

Data Default Retention
Call metadata (system, method, status, duration) 90 days
Request/response bodies 30 days

After the retention period, data is permanently deleted. See Retention Policies.

Exporting

Export API call data for reporting or analysis:

  1. Apply your desired filters
  2. Click Export
  3. Choose CSV or JSON format
  4. Download the file

Regular Exports

If you need long-term records for compliance, set up a regular export schedule before data reaches its retention limit.

Next Steps