Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get email insights

GET/emails/{id}/insights
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstring<uuid>required
Responses
200

Best-practice check results and score computed when the email was sent

objectstringrequired
Allowed:email_insights
email_idstring<uuid>required
scorenumberrequired

Best-practice score, 0-10, one decimal

score_versionintegerrequired
bandstringrequired
Allowed:excellentgoodneeds_attentionat_risk
marketingbooleanrequired
html_size_bytesinteger | nullrequired
computed_atstringrequired
checksobject[]required
Show properties
Array of object
idstringrequired

Check id from the @billionsend/core check catalog

severitystringrequired
Allowed:criticalmajorminorinfo
statusstringrequired
Allowed:passfailpassed_by_designnot_applicableunknown
penaltynumberrequired

Points deducted from the score; 0 unless status is fail

detailobject
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "email_insights",
  "email_id": "8e6bf5ae-e456-4654-87f8-33e2156caffc",
  "score": 0,
  "score_version": 0,
  "band": "excellent",
  "marketing": true,
  "html_size_bytes": 0,
  "computed_at": "string",
  "checks": [
    {
      "id": "string",
      "severity": "critical",
      "status": "pass",
      "penalty": 0,
      "detail": {
        "property1": null,
        "property2": null
      }
    }
  ]
}

Was this page helpful?