Get email insights
The check results and score for one email. Answers 404 when the email has no insights. BillionSend extension.
GET
/emails/{id}/insightsAutorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Parámetros de ruta
idstring<uuid>obligatorioRespuestas
200
Best-practice check results and score computed when the email was sent
objectstringobligatorioValores permitidos:
email_insightsemail_idstring<uuid>obligatorioscorenumberobligatorioBest-practice score, 0-10, one decimal
score_versionintegerobligatoriobandstringobligatorioValores permitidos:
excellentgoodneeds_attentionat_riskmarketingbooleanobligatoriohtml_size_bytesinteger | nullobligatoriocomputed_atstringobligatoriochecksobject[]obligatorioMostrar propiedadesOcultar propiedades
Array de
objectidstringobligatorioCheck id from the @billionsend/core check catalog
severitystringobligatorioValores permitidos:
criticalmajorminorinfostatusstringobligatorioValores permitidos:
passfailpassed_by_designnot_applicableunknownpenaltynumberobligatorioPoints deducted from the score; 0 unless status is fail
detailobject401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio403
Restricted API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio404
Not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio