Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Get email insights

The check results and score for one email. Answers 404 when the email has no insights. BillionSend extension.

GET/emails/{id}/insights
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Respuestas
200

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

objectstringobligatorio
Valores permitidos:email_insights
email_idstring<uuid>obligatorio
scorenumberobligatorio

Best-practice score, 0-10, one decimal

score_versionintegerobligatorio
bandstringobligatorio
Valores permitidos:excellentgoodneeds_attentionat_risk
marketingbooleanobligatorio
html_size_bytesinteger | nullobligatorio
computed_atstringobligatorio
checksobject[]obligatorio
Mostrar propiedades
Array de object
idstringobligatorio

Check id from the @billionsend/core check catalog

severitystringobligatorio
Valores permitidos:criticalmajorminorinfo
statusstringobligatorio
Valores permitidos:passfailpassed_by_designnot_applicableunknown
penaltynumberobligatorio

Points deducted from the score; 0 unless status is fail

detailobject
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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
      }
    }
  ]
}

¿Te ha resultado útil esta página?