Skip to main content

API Logs

API Logs allow you to monitor, debug, and audit all API requests made using your API key. Every request to the Partner API is automatically logged with detailed information including request payloads, response status, latency, and more.
Automatic Logging: All API requests made with your API key are automatically logged. You don’t need to configure anything - logs are captured automatically for monitoring and debugging purposes.

Accessing API Logs

API Logs are accessible through the TapTalent dashboard interface. Follow these steps to view your API logs:

Step 1: Navigate to API Logs

  1. Log in to your TapTalent Dashboard
  2. Navigate to Account Settings > Developers > API Logs

Step 2: View Your Logs

The API Logs page displays a table of all your API requests with the following information:
  • Timestamp: Date and time when the request was made
  • Method: HTTP method used (GET, POST, PUT, etc.)
  • Request URL: The endpoint that was called
  • Status: HTTP status code (200, 400, 500, etc.)
  • Latency: Response time in milliseconds

Step 3: Filter Your Logs

Use the filter options at the top of the page to narrow down your search: Filter by Status Code:
  • All Status: View all requests
  • 2xx - Success: View only successful requests (200-299)
  • 3xx - Redirect: View redirect responses (300-399)
  • 4xx - Client Error: View client errors (400-499)
  • 5xx - Server Error: View server errors (500-599)
Filter by HTTP Method:
  • Filter by specific HTTP methods: GET, POST, PUT, PATCH, DELETE, OPTIONS, or HEAD
Filter by Date Range:
  • Select a date range using the calendar picker to view logs from a specific time period

Step 4: View Log Details

Click on any log entry in the table to view detailed information: Request Details:
  • Complete request URL with query parameters
  • HTTP method used
  • Request payload (body data sent with the request)
  • Request timestamp
Response Details:
  • HTTP status code
  • Response payload (only stored for non-200 status codes)
  • Response latency in milliseconds
  • IP address and user agent
Additional Information:
  • Client ID and Company ID
  • Timestamps for when the log was created and updated

Understanding Log Data

What Gets Logged

Every API request automatically captures:
InformationDescription
Request URLComplete URL including endpoint path and query parameters
HTTP MethodThe HTTP method used (GET, POST, PUT, PATCH, DELETE, etc.)
Request PayloadThe request body data (for POST, PUT, PATCH requests)
Status CodeHTTP response status code (200, 400, 404, 500, etc.)
Response PayloadResponse body (only stored for non-200 status codes to save space)
LatencyHow long the request took to complete (in milliseconds)
IP AddressThe IP address that made the request
User AgentThe client/user agent string
TimestampWhen the request was made

Response Payload Storage

Important: Response payloads are only stored for non-200 status codes. This means:
  • ✅ Successful requests (200 status) will show responsePayload: null
  • ✅ Error responses (400, 404, 500, etc.) will include the full error response
  • This helps focus logs on errors and failures while optimizing storage

Use Cases

Debugging API Issues

When your integration isn’t working as expected:
  1. Filter by Error Status: Use the status filter to show only 4xx and 5xx errors
  2. Review Failed Requests: Click on error entries to see the exact error message and response
  3. Check Request Payloads: Verify that you’re sending the correct data format
  4. Identify Patterns: Look for repeated errors that might indicate a configuration issue

Monitoring API Performance

Track how your integration is performing:
  1. View Latency: Check the latency column to identify slow requests
  2. Monitor Success Rates: Filter by status codes to see success vs error ratios
  3. Track Usage: Review the number of requests over time
  4. Identify Slow Endpoints: Look for requests with high latency values

Auditing API Activity

Maintain records of all API activity:
  1. Date Range Filtering: Use the date picker to view logs from specific time periods
  2. Review All Requests: See a complete history of all API calls made with your key
  3. Track Changes: Monitor when requests were made and what data was sent
  4. Compliance: Use logs for audit trails and compliance reporting

Best Practices

Regular Monitoring

  • Check logs regularly to catch errors early
  • Filter by error status codes (4xx, 5xx) to focus on issues
  • Review high-latency requests to identify performance problems

Debugging Workflow

  1. Identify the Issue: Filter logs by error status codes
  2. Review Details: Click on error entries to see full request/response data
  3. Check Request Payload: Verify the data format matches API requirements
  4. Review Error Messages: Read the response payload for specific error details
  5. Fix and Verify: Make corrections and check new requests to confirm the fix

Performance Optimization

  • Monitor latency: Look for requests taking longer than expected
  • Compare endpoints: See which API endpoints are slower
  • Track improvements: Monitor latency after making optimizations

Tips

Finding Specific Requests

  • Use date range filter to narrow down to a specific time period
  • Filter by HTTP method to see only POST requests, GET requests, etc.
  • Filter by status code to focus on errors or successful requests
  • Combine filters for more precise searches

Understanding Status Codes

  • 2xx (200-299): Success - Request completed successfully
  • 3xx (300-399): Redirect - Request was redirected
  • 4xx (400-499): Client Error - Issue with your request (invalid data, missing fields, etc.)
  • 5xx (500-599): Server Error - Issue on TapTalent’s side

Response Payloads

  • Response payloads are only shown for non-200 status codes
  • This helps you focus on errors and failures
  • Full error details are available in the response payload for debugging

Next Steps