Skip to main content
GET
/
api
/
v1
/
emails
/
stats
Get Email Stats
curl --request GET \
  --url https://api.example.com/api/v1/emails/stats
{
  "stats": {
    "total": 123,
    "sent": 123,
    "failed": 123,
    "transactional": 123,
    "marketing": 123,
    "successRate": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mailbreeze.com/llms.txt

Use this file to discover all available pages before exploring further.

Get aggregate statistics for email sending including totals by type and success rates.

Examples

import { MailBreeze } from "mailbreeze";

const mailbreeze = new MailBreeze({ apiKey: "sk_live_xxx" });

const stats = await mailbreeze.emails.stats();

console.log(`Total: ${stats.total}`);
console.log(`Sent: ${stats.sent}`);
console.log(`Failed: ${stats.failed}`);
console.log(`Transactional: ${stats.transactional}`);
console.log(`Marketing: ${stats.marketing}`);
console.log(`Success rate: ${stats.successRate}%`);

Response

The API returns a nested response with stats inside a stats object.
stats
object
The statistics object containing all metrics.
Example Response
{
  "success": true,
  "data": {
    "stats": {
      "total": 124,
      "sent": 124,
      "failed": 0,
      "transactional": 110,
      "marketing": 14,
      "successRate": 100
    }
  },
  "meta": {
    "timestamp": "2025-12-27T13:35:49.055Z",
    "requestId": "f11f8792-d984-4fb2-a0e4-67f58d1b4000",
    "path": "/api/v1/emails/stats"
  }
}

Understanding the Metrics

MetricDescription
totalTotal emails processed through the system
sentSuccessfully delivered to recipient servers
failedEmails that couldn’t be delivered
transactionalSingle-recipient triggered emails (receipts, notifications)
marketingBulk campaign emails
successRatePercentage: (sent / total) * 100
SDKs automatically extract the nested stats object, so you access fields directly (e.g., stats.total instead of response.stats.total).