Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Get email insights

GET/emails/{id}/insights
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstring<uuid>obrigatório
Respostas
200

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

objectstringobrigatório
Valores permitidos:email_insights
email_idstring<uuid>obrigatório
scorenumberobrigatório

Best-practice score, 0-10, one decimal

score_versionintegerobrigatório
bandstringobrigatório
Valores permitidos:excellentgoodneeds_attentionat_risk
marketingbooleanobrigatório
html_size_bytesinteger | nullobrigatório
computed_atstringobrigatório
checksobject[]obrigatório
Mostrar propriedades
Array de object
idstringobrigatório

Check id from the @billionsend/core check catalog

severitystringobrigatório
Valores permitidos:criticalmajorminorinfo
statusstringobrigatório
Valores permitidos:passfailpassed_by_designnot_applicableunknown
penaltynumberobrigatório

Points deducted from the score; 0 unless status is fail

detailobject
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Restricted API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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
      }
    }
  ]
}

Esta página foi útil?