Health & Metrics API
Parent API: Tenant SMTP API URL Prefix: /api/v1/tenant/smtp
Endpoints
Get SMTP Status
Method: GET URL: /api/v1/tenant/smtp/status Purpose: Summarized operational health for the tenant’s sending.
Response:
{
"success": true,
"data": {
"sending_enabled": true,
"reputation_band": "healthy",
"recent_bounce_rate": 0.012
}
}
Get SMTP Metrics
Method: GET URL: /api/v1/tenant/smtp/metrics Purpose: Aggregate deliverability metrics for dashboards.
Query Parameters:
window: e.g.,7d
Response:
{
"success": true,
"data": {
"window": "7d",
"sent": 250000,
"delivered": 245000,
"bounced": 2500,
"opens": 80000
}
}