LogStitch Documentation

LogStitch is an audit log API for SaaS companies. Ingest structured events, query with filters, enforce PII redaction, and embed a log viewer — all through a simple REST API and TypeScript SDK.

Core Concepts#

LogStitch is organized around a few key primitives. Read the full concepts guide for details.

Organization — Your company's LogStitch account.
Project — A product or app within your org. Events, keys, and rules are scoped to a project.
Tenant — Your customer. Each event belongs to a tenant.
Event — An immutable, structured record of something that happened.

Free Tier#

No credit card required

Every account starts on the free tier with 7-day event retention and 1,000 events per day per project. No credit card required to get started.

Quick Links#

Quickstart

Send your first event in under 5 minutes.

SDK Reference

TypeScript SDK with batching, retry, and fire-and-forget.

API Reference

REST API for ingestion, querying, and configuration.

PII Redaction

Built-in patterns and custom rules for sensitive data.

Security Alerts

Detect suspicious patterns with built-in and custom rules.

Example#

Install the SDK and start logging events in a few lines of code.

Send an event

import { LogStitch } from '@logstitch/sdk';

const logstitch = new LogStitch({
  projectKey: 'pk_your_key_here',
});

await logstitch.log({
  action: 'user.signed_up',
  category: 'auth',
  actor: { id: 'user_123', type: 'user', name: 'Alice' },
  tenant_id: 'acme_corp',
});