Return a sending health summary
Changed onReturns your delivery, bounce, and complaint rates for a date window, compared with the previous window of the same length, plus an overall health grade for the last 7 days. When health is at_risk or critical, findings points to the likely cause, such as one recipient domain bouncing most of your mail, and gives you a filter for the events behind it.
Messages count on the day they were sent, so the rates for recent days can still change as delivery results arrive.
Request
- Base URLhttps://api.us.nylas.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The first day of the window, as a UTC date in YYYY-MM-DD format. Defaults to six days before end, so the default window covers 7 days. A window can cover up to 365 days.
The last day of the window, as a UTC date in YYYY-MM-DD format. Defaults to today. Today is included as a partial day.
Return only data for messages sent from this domain.
Response
Success. Returns the summary.
Example response
{
"data": {
"health": {
"state": "at_risk",
"window": {
"start": "2026-10-24",
"end": "2026-10-30"
},
"min_assess_volume": 100,
"findings": [
{
"rule": "concentration",
"severity": "high",
"evidence": {
"metric": "bounce_rate",
"value": 12.5,
"threshold": 5,
"dimension": "recipient_domain",
"dimension_value": "example.org",
"share_of_excess": 0.78,
"day": "2026-10-28",
"baseline_value": 1.2,
"totals": {
"sent": 1840,
"delivered": 1814,
"bounced_hard": 18,
"bounced_soft": 6,
"complaints": 1
},
"window": {
"start": "2026-10-24",
"end": "2026-10-30"
}
},
"logs_filter": {
"recipient_domain": "example.org",
"event_type": [
"bounced"
],
"bounce_class": "hard"
}
}
]
},
"totals": {
"sent": 1840,
"delivered": 1814,
"bounced_hard": 18,
"bounced_soft": 6,
"complaints": 1
},
"metrics": {
"delivery_rate": {
"value": 98.6,
"delta_pp": -0.8,
"prior_value": 99.4,
"status": "ok"
},
"bounce_rate": {
"value": 98.6,
"delta_pp": -0.8,
"prior_value": 99.4,
"status": "ok"
},
"complaint_rate": {
"value": 98.6,
"delta_pp": -0.8,
"prior_value": 99.4,
"status": "ok"
}
},
"prior_period": {
"start": "2026-10-24",
"end": "2026-10-30"
}
}
}Changes
- info
endpoint added
- info