Poll delivery, open, and click metrics for a single HTML email sent via the one-shot endpoint
Documentation Index
Fetch the complete documentation index at: https://docs.minimo.it/llms.txt
Use this file to discover all available pages before exploring further.
POST /public/v1/emails, use the returned id (or the full statsUrl) to read back delivery and engagement metrics for that single delivery.
Unlike the template-stats endpoint, these numbers refer to one recipient and one HTML payload — not aggregated counters across a campaign.
| Field | Type | Description |
|---|---|---|
id | string | Echo of the opaque sqid id returned by the POST endpoint. |
status | "pending" | "sent" | "failed" | Lifecycle state of the delivery. |
to | string | Recipient address as it was sent. |
subject | string | Subject line as it was sent. |
sentAt | date-time | When the delivery row was created (queue-in time, not provider acceptance). |
opened | boolean | true once the tracking pixel has been fetched at least once. |
firstOpenAt | date-time | null | Timestamp of the first open; null until the pixel is fetched. |
clickCount | integer | Total number of clicks across all tracked links in the email. |
firstClickAt | date-time | null | Timestamp of the earliest tracked click; null until the first click. |
failureReason | string | null | Populated when status = "failed" — the provider’s rejection reason. |
<img> open-pixel. Image proxies (Gmail, Apple Mail Privacy Protection) trigger this immediately on arrival, which inflates open rates compared to pre-2021 baselines./api/click/... URL appends a row to the click ledger. clickCount is the cardinality of that ledger; firstClickAt is its minimum timestamp.id do not affect this row.
Confirm a magic link landed
Detect failed deliveries in a queue worker
status === "failed", persist failureReason against the originating business object so support can react.Attribute a CTA click back to the trigger
| Status | Cause |
|---|---|
401 | API key missing or malformed. |
403 | API key lacks the TRANSACTIONAL permission. |
404 | The id doesn’t exist, or it belongs to a different company than the one this API key authorizes. |