مرجع API

تحویل‌پذیری

رویدادها، نتایج اعتبار و گیرندگان مسدودشده را بررسی کنید.

GET/deliverability/stats
کلید API

دریافت آمار تحویل 30 روز اخیر

دریافت آمار تحویل 30 روز اخیر

درخواست
curl https://sendhq.cc/api/v1/deliverability/stats \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "window": "30d",
  "sent": 0,
  "delivery": 0,
  "bounce": 0,
  "complaint": 0,
  "deliveryRate": null
}
GET/deliverability/reputation
کلید API

فهرست وضعیت اعتبار به تفکیک دقیق هویت فرستنده

فهرست وضعیت اعتبار به تفکیک دقیق هویت فرستنده

درخواست
curl https://sendhq.cc/api/v1/deliverability/reputation \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "data": [
    {
      "sender": "alerts@example.com",
      "status": "active",
      "dailyLimit": 2000,
      "reason": null,
      "cleanSince": "2026-09-01T00:00:00.000Z",
      "warnedAt": null,
      "pausedAt": null,
      "evaluatedAt": "2026-09-07T00:00:00.000Z"
    }
  ],
  "count": 1
}
GET/deliverability/account
کلید API

Account delivery rates, daily ladder, and bounce trend

Daily trend for at most 30 days, counted per message. The rolling 7-day hard-bounce and complaint rates are per recipient, the same counts the sending ladder uses, divided by committed recipient units. `days` is 7 or 30. `limit` on the related domain and sender routes is at most 97.

Query parametersdays
درخواست
curl https://sendhq.cc/api/v1/deliverability/account \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "days": 30,
  "trendUnit": "message",
  "trend": [],
  "rolling7d": {
    "unit": "recipient",
    "sent": 0,
    "hardBounce": 0,
    "softBounce": 0,
    "complaint": 0,
    "hardBounceRate": null,
    "complaintRate": null
  },
  "thresholds": {},
  "ladder": null
}
GET/deliverability/domains
کلید API

Per-domain sent, delivered, hard and soft bounces, complaints, and failures

Each message counts once, however many recipients it had. This is a different unit from the 7-day ladder rate, which counts recipients. A new domain includes its Gmail cap, and an active 4.7.28 backoff includes the step and until time. `limit` is at most 97.

Query parametersdaysdomainlimitoffset
درخواست
curl https://sendhq.cc/api/v1/deliverability/domains \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "days": 30,
  "unit": "message",
  "data": [],
  "count": 0,
  "limit": 50,
  "offset": 0
}
GET/deliverability/senders
کلید API

Per-From-address delivery rates

Each message counts once. `limit` is at most 97.

Query parametersdaysdomainlimitoffset
درخواست
curl https://sendhq.cc/api/v1/deliverability/senders \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "days": 30,
  "unit": "message",
  "data": [],
  "count": 0,
  "limit": 50,
  "offset": 0
}
POST/deliverability/score
کلید API

Score an email's content before it is sent

A checklist of one email's content, worked out from the request alone: nothing is stored and nothing is sent. `score` starts at 100 for a plain email with no links and no images, and loses points for each thing mail filters look at: a designed layout, links (more for another site than the sender's, a link shortener, an `http://` address, a number address, or link text that shows a different site than the link opens), images (more with few words beside them), hidden or unreadable text, a plain-text part that says something else, capitals, an empty subject or a `Re:` on an email that answers nothing, more than 80 KB of HTML, and forms, scripts, embedded pages or linked style sheets. It never goes below 0. `deductions` lists what was found, most points first, each with the `points` it costs, a `count`, and a one-line `suggestion`. `warnings` are problems that carry no points, such as HTML long enough for Gmail to cut off. Send the email as it was written: the unsubscribe footer and tracking that SendHQ adds are not scored, and the frame around an email made in the block editor is not either. `from` (an address or a domain) is the sender; without it links to other sites are not judged. The score looks at content only. Sender reputation, authentication and how recipients react decide more of where mail lands, so use it as a checklist, not a prediction.

درخواست
curl https://sendhq.cc/api/v1/deliverability/score \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"hello@example.com","subject":"Your cart is still here","html":"<p>Pick up where you left off.</p><p><a href=\"https://bit.ly/3xyz\">Finish checkout</a></p>","text":"Pick up where you left off.\n\nFinish checkout: https://bit.ly/3xyz"}'
پاسخ 200
{
  "score": 90,
  "deductions": [
    {
      "id": "link_shortener",
      "points": 8,
      "count": 1,
      "suggestion": "Remove the link shortener"
    },
    {
      "id": "links",
      "points": 2,
      "count": 1,
      "suggestion": "Remove the link"
    }
  ],
  "warnings": []
}
GET/suppressions
کلید API

فهرست موارد توقف ارسال فضای کاری

فهرست موارد توقف ارسال فضای کاری

پارامترهای querylimitoffset
درخواست
curl https://sendhq.cc/api/v1/suppressions \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "data": [],
  "count": 0
}
DELETE/suppressions/:email
کلید API

حذف یک مورد توقف ارسال ناشی از برگشت ایمیل که واجد شرایط حذف است

حذف یک مورد توقف ارسال ناشی از برگشت ایمیل که واجد شرایط حذف است

درخواست
curl https://sendhq.cc/api/v1/suppressions/email_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "ok": true
}
GET/blocked-recipients
کلید API

فهرست برگشت‌ها، گزارش‌های اسپم و لغو اشتراک‌ها

فهرست برگشت‌ها، گزارش‌های اسپم و لغو اشتراک‌ها

پارامترهای querylimit
درخواست
curl https://sendhq.cc/api/v1/blocked-recipients \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
پاسخ 200
{
  "data": [],
  "count": 0,
  "summary": {
    "total": 0,
    "unsubscribe": 0,
    "bounce": 0,
    "complaint": 0
  }
}