Audit & Reporting

AuditClient reads the governed audit chain: count returns chain-validity + entry count, find_by_request_id traces a single request end-to-end, export_pdf produces a signed, exportable report.

10 methods across this domain. Signatures, parameters (incl. keyword-only tunable defaults), and the three SDK spellings are ported from the live SDK source; flagship methods carry a hand-written When to use + example.

AuditClient

count()

When to use. Quick audit-chain health: validity + entry count.

  • Python — client.auditclient.count()
  • TypeScript — count()
  • Go — Count()

Example

from relata import AuditClient
print(AuditClient.from_client(relata).count())

export_pdf(case_id, template='default')

When to use. Produce a signed PDF report of audit entries for a window.

  • Python — client.auditclient.export_pdf(case_id, template='default')
  • TypeScript — exportPdf(caseId, opts)
  • Go — ExportPDF(caseID, template)

Parameters: case_id, template='default'

Example

AuditClient.from_client(relata).export_pdf(since="2025-01-01")

entries(principal=None, purpose=None, decision=None, request_id=None, since_ns=None, until_ns=None, limit=100, cursor=None)

entries(principal=None, purpose=None, decision=None, request_id=None, since_ns=None, until_ns=None, limit=100, cursor=None)`

  • Python — client.auditclient.entries(principal=None, purpose=None, decision=None, request_id=None, since_ns=None, until_ns=None, limit=100, cursor=None)
  • TypeScript — entries(opts)
  • Go — Entries()

Parameters: principal=None, purpose=None, decision=None, request_id=None, since_ns=None, until_ns=None, limit=100, cursor=None

find_by_request_id(request_id)

find_by_request_id(request_id)`

  • Python — client.auditclient.find_by_request_id(request_id)
  • TypeScript — findByRequestId(requestId)
  • Go — FindByRequestID(requestID)

Parameters: request_id

sign_receipt(payload)

sign_receipt(payload)`

  • Python — client.auditclient.sign_receipt(payload)
  • TypeScript — signReceipt(payload)
  • Go — SignReceipt(payload)

Parameters: payload

RelataClient

health()

health()`

  • Python — client.relataclient.health()
  • TypeScript — health()
  • Go — Health()

ready()

ready()`

  • Python — client.relataclient.ready()
  • TypeScript — ready()
  • Go — Ready()

stats()

stats()`

  • Python — client.relataclient.stats()
  • TypeScript — stats()
  • Go — Stats()

status()

status()`

  • Python — client.relataclient.status()
  • TypeScript — status()
  • Go — Status()

version()

version()`

  • Python — client.relataclient.version()
  • TypeScript — version()
  • Go — Version()