Skip to content
Inbox OSS
All docs

Documentation

Stats & Events

Real-time aggregated statistics plus an immutable event log. Both queryable via API.

Aggregated stats

The /api/v1/stats endpoint returns aggregated metrics over any window with optional split dimensions.

GET /api/v1/stats?start_date=2026-05-01&end_date=2026-05-11&aggregated_by=day
Authorization: Bearer $INBOX_API_KEY

Split dimensions: category, country, device, mailbox_provider, client_type.

Event log

Query individual events with cursor pagination.

GET /api/v1/events?event=delivered&start_date=2026-05-10&limit=100
Authorization: Bearer $INBOX_API_KEY

Hot retention is 30 days. Cold export (S3-compatible bucket) is available for 13 months.

CSV export

Any stats or event query can be returned as CSV by setting Accept: text/csv. Useful for piping into spreadsheets or warehouses.

Stuck? We're here.

Free plan includes 3,000 emails/month forever. No credit card required.