Get email insights
GET
/emails/{id}/insightsAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Path parameters
idstring<uuid>requiredResponses
200
Best-practice check results and score computed when the email was sent
objectstringrequiredAllowed:
email_insightsemail_idstring<uuid>requiredscorenumberrequiredBest-practice score, 0-10, one decimal
score_versionintegerrequiredbandstringrequiredAllowed:
excellentgoodneeds_attentionat_riskmarketingbooleanrequiredhtml_size_bytesinteger | nullrequiredcomputed_atstringrequiredchecksobject[]requiredShow propertiesHide properties
Array of
objectidstringrequiredCheck id from the @billionsend/core check catalog
severitystringrequiredAllowed:
criticalmajorminorinfostatusstringrequiredAllowed:
passfailpassed_by_designnot_applicableunknownpenaltynumberrequiredPoints deducted from the score; 0 unless status is fail
detailobject401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired403
Restricted API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Not found
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired