Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Réponses
200

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

objectstringrequis
Valeurs autorisées :email_insights
email_idstring<uuid>requis
scorenumberrequis

Best-practice score, 0-10, one decimal

score_versionintegerrequis
bandstringrequis
Valeurs autorisées :excellentgoodneeds_attentionat_risk
marketingbooleanrequis
html_size_bytesinteger | nullrequis
computed_atstringrequis
checksobject[]requis
Afficher les propriétés
Tableau de object
idstringrequis

Check id from the @billionsend/core check catalog

severitystringrequis
Valeurs autorisées :criticalmajorminorinfo
statusstringrequis
Valeurs autorisées :passfailpassed_by_designnot_applicableunknown
penaltynumberrequis

Points deducted from the score; 0 unless status is fail

detailobject
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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
      }
    }
  ]
}

Cette page vous a-t-elle été utile ?