跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
idstring<uuid>必填
响应
200

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

objectstring必填
允许值:email_insights
email_idstring<uuid>必填
scorenumber必填

Best-practice score, 0-10, one decimal

score_versioninteger必填
bandstring必填
允许值:excellentgoodneeds_attentionat_risk
marketingboolean必填
html_size_bytesinteger | null必填
computed_atstring必填
checksobject[]必填
显示属性
object 数组
idstring必填

Check id from the @billionsend/core check catalog

severitystring必填
允许值:criticalmajorminorinfo
statusstring必填
允许值:passfailpassed_by_designnot_applicableunknown
penaltynumber必填

Points deducted from the score; 0 unless status is fail

detailobject
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Restricted API key

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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
      }
    }
  ]
}

这个页面有帮助吗?