Get email insights
The check results and score for one email. Answers 404 when the email has no insights. BillionSend extension.
GET
/emails/{id}/insightsAutorisation
AuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
Paramètres de chemin
idstring<uuid>requisRéponses
200
Best-practice check results and score computed when the email was sent
objectstringrequisValeurs autorisées :
email_insightsemail_idstring<uuid>requisscorenumberrequisBest-practice score, 0-10, one decimal
score_versionintegerrequisbandstringrequisValeurs autorisées :
excellentgoodneeds_attentionat_riskmarketingbooleanrequishtml_size_bytesinteger | nullrequiscomputed_atstringrequischecksobject[]requisAfficher les propriétésMasquer les propriétés
Tableau de
objectidstringrequisCheck id from the @billionsend/core check catalog
severitystringrequisValeurs autorisées :
criticalmajorminorinfostatusstringrequisValeurs autorisées :
passfailpassed_by_designnot_applicableunknownpenaltynumberrequisPoints deducted from the score; 0 unless status is fail
detailobject401
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequis403
Restricted API key
statusCodenumberrequisnamestringrequismessagestringrequis404
Not found
statusCodenumberrequisnamestringrequismessagestringrequis429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis