MailerHealth¶

GET mailer/health

Full state of the module: database, loaded adapters, what the crons are doing, how deep the queue is, the bounce and complaint rates per profile, the last known provider quotas, and the counters of triggers, campaigns and webhooks.

The per-profile rates are the part to look at first: they are what the reputation guard uses to pause a profile, and seeing them next to the queue backlog explains why sending slowed down.

Access Control¶

Allowed role: admin.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/health
Authorization: <JWT_TOKEN>

{
  "command": "MailerHealth",
  "extID": "1",
  "data": {}
}

const res = await platform.MailerHealth({});

Request Data¶

This method takes no parameters.

Response Data¶

queue.awaitingReport counts emails in SENT — accepted by the provider but with no delivery event yet. A number that keeps growing means the webhook stopped arriving, which MailerPing cannot tell you.

{
  "service": "sct-mailer",
  "nodeID": "sct-mailer-3227647",
  "version": "0.0.1",
  "uptimeSec": 412,
  "database": { "ok": true, "latencyMs": 1 },
  "adapters": {
    "loaded": ["postmark", "sendgrid", "ses", "smtp"],
    "failed": [],
    "capabilities": [
      {
        "name": "postmark",
        "title": "Postmark",
        "capabilities": { "sendEmail": true, "webhook": true, "domainCheck": true, "balance": false }
      }
    ]
  },
  "crons": {
    "enabled": true,
    "queueIntervalSec": 5,
    "queue": { "lastRunAt": "2026-08-24T13:39:30.004Z", "lastTaken": 7, "lastSent": 7, "runs": 84 },
    "reports": { "lastRunAt": "2026-08-24T13:39:15.114Z", "lastChecked": 7, "lastUpdated": 2 },
    "campaigns": { "lastRunAt": "2026-08-24T13:39:00.000Z", "lastStarted": 1 },
    "expired": { "lastRunAt": "2026-08-24T13:30:00.000Z", "lastExpired": 1, "totalExpired": 3 }
  },
  "queue": {
    "pending": 7,
    "oldestPendingAt": "2026-08-24 13:38:02",
    "awaitingReport": 14,
    "last24h": { "DELIVERED": 402, "SENT": 14, "PENDING": 7, "BOUNCED": 8, "COMPLAINED": 1 }
  },
  "deliverability": [
    { "profileId": 3, "sample": 420, "bounceRate": 0.019, "complaintRate": 0.0002, "pausedAt": null }
  ],
  "balances": {
    "4": { "provider": "ses", "amount": 48200, "currency": "EMAILS_PER_DAY", "low": false, "checkedAt": "2026-08-24T14:11:03.118Z", "error": null }
  },
  "suppressions": 1204,
  "counters": { "emails": 8420, "suppressed": 190, "campaigns": 4 },
  "webhooks": { "received": 420, "processed": 402, "duplicates": 12, "ignored": 4, "unverified": 2, "errors": 0 }
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Not an admin session
`502`	`MOL_CALL_FAILED`	The module is not on the bus