API Reference - Event Schemas

These are the JSON schemas for events the SDK sends to the Guard ingest endpoint. You don’t normally interact with these directly — they’re documented here for debugging and self-hosting.

Request event

Field	Type	Description
url	string	Request URL as the framework provides it. May include scheme/host (Python) or be path-only (Node, Go)
endpoint	string	Path with query string
method	string	HTTP method, uppercased
status_code	int	Response status code
request_headers	object	Lowercased keys, sensitive values redacted
request_body	any	Parsed JSON when possible, capped at 64KB
response_headers	object	Lowercased keys
response_body	any	Parsed JSON when possible, capped at 64KB
duration_ms	int	Response time in milliseconds
client_ip	string	Extracted from proxy headers

{
  "url": "/api/users/42",
  "endpoint": "/api/users/42",
  "method": "GET",
  "status_code": 200,
  "request_headers": {
    "content-type": "application/json",
    "authorization": "[REDACTED]"
  },
  "request_body": null,
  "response_headers": { "content-type": "application/json" },
  "response_body": {
    "id": 42,
    "name": "Jane Doe",
    "email": "ja***@example.com"
  },
  "duration_ms": 23,
  "client_ip": "203.0.113.42"
}

Error event

Field	Type	Description
_type	string	Always "error"
error_type	string	Exception class name
error_message	string	Error message
level	string	"fatal", "error", or "warning"
fingerprint	string?	Optional grouping key (Node, Python)
stack_frames	StackFrame[]	Stack trace
request_url	string?	Request URL that caused the error
request_method	string?	HTTP method
client_ip	string?	Client IP
timestamp	int	Unix milliseconds

Stack frame

Field	Type	Description
file	string	Source file path
line	int	Line number
column	int?	Column (Node, Python 3.11+)
function	string	Function name
context	string[]?	Surrounding source lines (Python only)
in_app	bool	true if your code, false for library/runtime