Usage

Metrics time series

Activity bucketed into fixed UTC intervals: messages sent and received, bounces, complaints, first opens and first clicks of tracked sends, webhook deliveries and terminal failures, and inbound messages the prompt-injection scanner flagged (medium or high). Derived live from the account's rows; outcomes are attributed to messages created inside the window, and opens/clicks count once per message. Requires usage.read. Honours workspace scoping and inbox-scoped API keys.

get/v1/metrics

Request

  • Base URL: https://api.deadsimple.email
  • URL: https://api.deadsimple.email/v1/metrics
  • Auth: HTTP bearer

Query parameters

fromstring

Start of the window, inclusive. ISO date (2026-09-01) or datetime (2026-09-01T12:00:00Z; naive means UTC). Default: 30 days before to.

tostring

End of the window, exclusive. A date-only value means the end of that day, so from=2026-09-01&to=2026-09-07 is seven whole days. Default: now. The window may span at most 92 days.

interval'day' | 'hour'

Bucket size. hour is allowed only for windows of 7 days or less.

inbox_idstring

Comma-separated inbox ids (max 100) to restrict the series to. Each must belong to the account and be visible to the key; otherwise 404.

Headers

X-Workspace-Idstring uuid

Target a specific workspace. Required for account-wide API keys that want workspace-scoped results.

Response

Bucketed series plus totals over the whole window

interval'day' | 'hour'
fromstring date-time
tostring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.