Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get deliverability

GET/deliverability
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Responses
200

Account deliverability score over the trailing 30 days

objectstringrequired
Allowed:deliverability
scorenumber | nullrequired
bandstring | nullrequired
Allowed:excellentgoodneeds_attentionat_risknull
content_scorenumber | nullrequired
outcome_scorenumber | nullrequired
complaint_ratenumberrequired
hard_bounce_ratenumberrequired
emails_sentintegerrequired
scored_recipientsintegerrequired
window_daysintegerrequired
insufficient_outcome_databooleanrequired
guardrail_statusstringrequired
Allowed:okwarningpaused
score_versionintegerrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Request
curl -X GET 'https://api.billionsend.com/deliverability' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "deliverability",
  "score": 0,
  "band": "excellent",
  "content_score": 0,
  "outcome_score": 0,
  "complaint_rate": 0,
  "hard_bounce_rate": 0,
  "emails_sent": 0,
  "scored_recipients": 0,
  "window_days": 0,
  "insufficient_outcome_data": true,
  "guardrail_status": "ok",
  "score_version": 0
}

Was this page helpful?