Skip to content
View as Markdown

GET Export System Logs (CSV)​

GET
/setting/system-logs/export

Stream the system log as a CSV download.

::: warning
This endpoint does not return JSON. It sets CSV download headers, streams rows directly to the output buffer, and calls exit — so ordinary REST clients that expect a JSON envelope will not work. Treat it as a file download.
:::

Rows are streamed in chunks by descending id rather than buffered in memory, so the export works on log tables too large to load at once, and it stops early if the client disconnects.

The file opens with a UTF-8 BOM for spreadsheet compatibility, and every cell is escaped so a value beginning with =, +, -, or @ cannot execute as a formula.

Columns are ID, Date & Time, Title, Description, with HTML stripped from the description. The filename encodes the range, e.g. fluent-crm-system-logs-last-30-days-2026-08-04-113000.csv.

Required capability: fcrm_manage_settings

Enforced by SettingsPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

range

all for everything, or a number of days to look back. Unrecognised values fall back to all.

Type
string
Default
"all"
search

Case-insensitive substring match against the log title or description.

Type
string

Responses​

A CSV file. Sent with download headers, not a JSON body.

text/csv

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI