Skip to content
PeriplusDocs
Open app
Audit log

Audit log

Understand who acted in your organization and what the recorded outcome means.

Who did what

Audit log records who performed an action and which API key or connected MCP app they used, where applicable.

Search the current page by actor, action, or outcome, and open an event for details. The log is scoped to your organization.

Started is not completed

Started means the request was accepted, not that it finished. If there is no completion event, check the operation’s status before trying again. For long-running resources, inspect the capture, crawl, pin, or schedule itself.

A completed request is not proof that a streamed SQL result finished successfully. Use query history for execution errors and details.

Audit versus query history

Audit entries do not store credentials, SQL text, or request bodies. Query history is separate and includes SQL and parameters. Choose Audit log to investigate actions and access; choose Usage’s query activity to inspect an execution.

Read attributed actions

Audit entries describe request outcomes, not capture completion. A started entry without completion is uncertain: inspect the resource before retrying a mutation.

Python

Python
from periplus_sdk import Client

with Client() as client:
    page = client.audit.list(outcome="completed")
    for event in page.items:
        print(event.user_id, event.action, event.created_at)

cURL

Shell
curl --fail-with-body "${PERIPLUS_API_URL:-https://api.periplus.dev}/audit?outcome=completed" \
  -H "Authorization: Bearer $PERIPLUS_API_KEY"

Open audit log