> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pingtree.com/llms.txt
> Use this file to discover all available pages before exploring further.

# System Logs

> Browse and read server-side log files from the Pingtree platform UI to debug integration issues, track API errors, and monitor system health.

## Overview

**System Logs** provide direct access to the platform's server-side log files from within the Pingtree UI. Instead of requiring server access, administrators and authorized users can browse log categories, open dated log files, and read their contents — all without leaving the platform.

Navigate to **Settings > System Logs** to access this feature.

> **Access:** System Logs require the `system_logs` role permission. Users without this permission will not see this section.

***

## Browsing Log Categories

The System Logs view opens with a list of all available log file categories. Each category corresponds to a specific area of the platform or type of server-side activity.

Log category names are displayed in a human-readable format (e.g., `error_log` is shown as "Error Log"). Categories are derived from the log files present on the server and updated automatically as new log types are introduced.

Common log categories include:

* **Error Log** — Uncaught server errors and exceptions
* **API Request Log** — Inbound API calls and their responses
* **Webhook Log** — Outbound webhook dispatch records
* **Queue Log** — Background job processing activity
* **Integration Log** — Third-party integration call results

***

## Viewing Log Files Within a Category

Clicking a log category displays all dated log files available within that category. Log files are named by date, allowing you to navigate to a specific day's activity.

To open a log file:

1. Go to **Settings > System Logs**.
2. Select a log category from the list.
3. Choose the dated log file you want to inspect.
4. The log file contents will load in the reader view.

***

## Log Reader View

The log reader displays the full contents of the selected log file. For large files, the reader supports scrolling through the entire log output.

Key features of the log reader:

* **Full-screen mode** — Expand the reader to fill the screen for easier reading of dense log output.
* **Timestamped entries** — Each log entry includes a timestamp for precise event timing.
* **Structured output** — Errors and events are logged with contextual details such as request data, stack traces, and response codes.

***

## Use Cases

| Scenario                          | How System Logs Help                                                                                |
| --------------------------------- | --------------------------------------------------------------------------------------------------- |
| **Debugging integration issues**  | Inspect API request logs to see exactly what data was sent and received by third-party integrations |
| **Tracking API errors**           | Review the error log to identify failed requests and their root causes                              |
| **Monitoring system health**      | Check queue and webhook logs to confirm background jobs are processing correctly                    |
| **Investigating lead rejections** | Look up specific API calls related to a Transaction ID to trace why a lead was rejected             |
| **Auditing webhook delivery**     | Confirm whether outbound webhooks to buyers were dispatched and what responses were returned        |

***

## Log File Organization

Log files are organized by:

1. **Category** — The type of activity being logged (error, API request, webhook, etc.)
2. **Date** — Each log file covers a single day's activity, named with the date in its filename (e.g., `error_2025-04-01.log`)

This structure makes it straightforward to jump to a specific day when investigating a time-bound issue reported by a user or integration partner.
